Edgewall Software

Changes between Initial Version and Version 1 of 1.2/TracTicketsCustomFields


Ignore:
Timestamp:
Oct 15, 2019, 6:32:59 AM (12 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • 1.2/TracTicketsCustomFields

    v1 v1  
     1= Custom Ticket Fields
     2Trac supports adding custom, user-defined fields to the ticket module. With custom fields you can add typed, site-specific properties to tickets.
     3
     4== Configuration
     5
     6Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
     7
     8The syntax of each field definition is:
     9{{{
     10 FIELD_NAME = TYPE
     11 (FIELD_NAME.OPTION = VALUE)
     12 ...
     13}}}
     14
     15The example below should help to explain the syntax.
     16
     17=== Field Names
     18A field name can only contain lowercase letters a-z, uppercase letters A-Z or digits 0-9, and must not start with a leading digit.
     19
     20The following field names are reserved and can not be used for custom fields:
     21* cc
     22* changetime
     23* col
     24* comment
     25* component
     26* desc
     27* description
     28* format
     29* group
     30* groupdesc
     31* id
     32* keywords
     33* max
     34* milestone
     35* or
     36* order
     37* owner
     38* page
     39* priority
     40* report
     41* reporter
     42* resolution
     43* row
     44* severity
     45* status
     46* summary
     47* time
     48* type
     49* verbose
     50* version
     51
     52=== Available Field Types and Options
     53
     54 * '''text''': A simple (one line) text field.
     55   * label: Descriptive label.
     56   * value: Default value.
     57   * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
     58   * format: One of:
     59     * `plain` for plain text
     60     * `wiki` to interpret the content as WikiFormatting
     61     * `reference` to treat the content as a queryable value (''since 1.0'')
     62     * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'')
     63 * '''checkbox''': A boolean value check box.
     64   * label: Descriptive label.
     65   * value: Default value, 0 or 1.
     66   * order: Sort order placement.
     67 * '''select''': Drop-down select box. Uses a list of values.
     68   * label: Descriptive label.
     69   * options: List of values, separated by '''|''' (vertical pipe).
     70   * value: Default value (one of the values from options).
     71   * order: Sort order placement.
     72 * '''radio''': Radio buttons. Essentially the same as '''select'''.
     73   * label: Descriptive label.
     74   * options: List of values, separated by '''|''' (vertical pipe).
     75   * value: Default value, one of the values from options.
     76   * order: Sort order placement.
     77 * '''textarea''': Multi-line text area.
     78   * label: Descriptive label.
     79   * value: Default text.
     80   * cols: Width in columns. //(Removed in 1.1.2)//
     81   * rows: Height in lines.
     82   * order: Sort order placement.
     83   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     84 * '''time''': Date and time picker. (''Since 1.1.1.'')
     85   * label: Descriptive label.
     86   * value: Default date.
     87   * order: Sort order placement.
     88   * format: One of:
     89     * `relative` for relative dates.
     90     * `date` for absolute dates.
     91     * `datetime` for absolute date and time values.
     92
     93If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
     94
     95Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     96
     97=== Sample Configuration
     98
     99{{{#!ini
     100[ticket-custom]
     101
     102test_one = text
     103test_one.label = Just a text box
     104
     105test_two = text
     106test_two.label = Another text-box
     107test_two.value = Default [mailto:joe@nospam.com owner]
     108test_two.format = wiki
     109
     110test_three = checkbox
     111test_three.label = Some checkbox
     112test_three.value = 1
     113
     114test_four = select
     115test_four.label = My selectbox
     116test_four.options = one|two|third option|four
     117test_four.value = two
     118
     119test_five = radio
     120test_five.label = Radio buttons are fun
     121test_five.options = uno|dos|tres|cuatro|cinco
     122test_five.value = dos
     123
     124test_six = textarea
     125test_six.label = This is a large textarea
     126test_six.value = Default text
     127test_six.cols = 60
     128test_six.rows = 30
     129
     130test_seven = time
     131test_seven.label = A relative date
     132test_seven.format = relative
     133test_seven.value = now
     134
     135test_eight = time
     136test_eight.label = An absolute date
     137test_eight.format = date
     138test_eight.value = yesterday
     139
     140test_nine = time
     141test_nine.label = A date and time
     142test_nine.format = datetime
     143test_nine.value = in 2 hours
     144}}}
     145
     146'''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
     147
     148=== Reports Involving Custom Fields
     149
     150Custom ticket fields are stored in the `ticket_custom` table, not in the `ticket` table. So to display the values from custom fields in a report, you will need a join on the 2 tables. Let's use an example with a custom ticket field called `progress`.
     151
     152{{{#!sql
     153SELECT p.value AS __color__,
     154   id AS ticket, summary, owner, c.value AS progress
     155  FROM ticket t, enum p, ticket_custom c
     156  WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
     157AND p.name = t.priority AND p.type = 'priority'
     158  ORDER BY p.value
     159}}}
     160'''Note''': This will only show tickets that have progress set in them. This is '''not the same as showing all tickets'''. If you created this custom ticket field ''after'' you have already created some tickets, they will not have that field defined, and thus they will never show up on this ticket query. If you go back and modify those tickets, the field will be defined, and they will appear in the query.
     161
     162However, if you want to show all ticket entries (with progress defined and without), you need to use a `JOIN` for every custom field that is in the query:
     163{{{#!sql
     164SELECT p.value AS __color__,
     165   id AS ticket, summary, component, version, milestone, severity,
     166   (CASE status WHEN 'assigned' THEN owner||' *' ELSE owner END) AS owner,
     167   time AS created,
     168   changetime AS _changetime, description AS _description,
     169   reporter AS _reporter,
     170   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     171  FROM ticket t
     172     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     173     JOIN enum p ON p.name = t.priority AND p.type='priority'
     174  WHERE status IN ('new', 'assigned', 'reopened')
     175  ORDER BY p.value, milestone, severity, time
     176}}}
     177
     178Note in particular the `LEFT OUTER JOIN` statement here.
     179
     180Note that if your config file uses an '''uppercase''' name:
     181{{{#!ini
     182[ticket-custom]
     183
     184Progress_Type = text
     185}}}
     186you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
     187
     188----
     189See also: TracTickets, TracIni