Changes between Version 2 and Version 3 of TracTicketsCustomFields


Ignore:
Timestamp:
Jun 9, 2024, 11:14:44 AM (6 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v2 v3  
    11= Custom Ticket Fields
     2
    23Trac supports adding custom, user-defined fields to the ticket module. With custom fields you can add typed, site-specific properties to tickets.
    34
    45== Configuration
    5 Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
     6
     7Configure custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini.
    68
    79The syntax of each field definition is:
     
    1113 ...
    1214}}}
     15
    1316The example below should help to explain the syntax.
    1417
     18=== Field Names
     19
     20A 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.
     21
     22The following field names are reserved and can not be used for custom fields:
     23* cc
     24* changetime
     25* col
     26* comment
     27* component
     28* desc
     29* description
     30* format
     31* group
     32* groupdesc
     33* id
     34* keywords
     35* max
     36* milestone
     37* or
     38* order
     39* owner
     40* page
     41* priority
     42* report
     43* reporter
     44* resolution
     45* row
     46* severity
     47* status
     48* summary
     49* time
     50* type
     51* verbose
     52* version
     53
    1554=== Available Field Types and Options
     55
    1656 * '''text''': A simple (one line) text field.
    1757   * label: Descriptive label.
    1858   * value: Default value.
    19    * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
    20    * format: One of:
    21      * `plain` for plain text
    22      * `wiki` to interpret the content as WikiFormatting
    23      * `reference` to treat the content as a queryable value (''since 1.0'')
    24      * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'')
     59   * order: Sort order placement relative to other custom fields.
     60   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     61   * format: One of:
     62     * `plain` for plain text
     63     * `wiki` for [WikiFormatting wiki formatted] content
     64     * `reference` to treat the content as a queryable value
     65     * `list` to interpret the content as a list of queryable values, separated by whitespace
    2566 * '''checkbox''': A boolean value check box.
    2667   * label: Descriptive label.
     
    4081   * label: Descriptive label.
    4182   * value: Default text.
    42    * cols: Width in columns. //(Removed in 1.1.2)//
    4383   * rows: Height in lines.
    4484   * order: Sort order placement.
     85   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    4586   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
    46  * '''time''': Date and time picker. (''Since 1.1.1.'')
     87 * '''time''': Date and time picker. (//Since 1.1.1//)
    4788   * label: Descriptive label.
    4889   * value: Default date.
     
    5798Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
    5899
    59 === Sample Config
    60 {{{
     100=== Sample Configuration
     101
     102{{{#!ini
    61103[ticket-custom]
    62104
     
    80122test_five = radio
    81123test_five.label = Radio buttons are fun
    82 test_five.options = uno|dos|tres|cuatro|cinco
     124test_five.options = |uno|dos|tres|cuatro|cinco
    83125test_five.value = dos
    84126
     
    105147}}}
    106148
    107 '''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
     149'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
    108150
    109151=== Reports Involving Custom Fields
     
    111153Custom 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`.
    112154
    113 {{{
    114 #!sql
     155{{{#!sql
    115156SELECT p.value AS __color__,
    116157   id AS ticket, summary, owner, c.value AS progress
    117   FROM ticket t, enum p, ticket_custom c
    118   WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
    119 AND p.name = t.priority AND p.type = 'priority'
    120   ORDER BY p.value
     158FROM ticket t, enum p, ticket_custom c
     159WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
     160  AND p.name = t.priority AND p.type = 'priority'
     161ORDER BY p.value
    121162}}}
    122163'''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.
    123164
    124165However, 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:
    125 {{{
    126 #!sql
     166{{{#!sql
    127167SELECT p.value AS __color__,
    128168   id AS ticket, summary, component, version, milestone, severity,
     
    131171   changetime AS _changetime, description AS _description,
    132172   reporter AS _reporter,
    133   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    134   FROM ticket t
    135      LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
    136      JOIN enum p ON p.name = t.priority AND p.type='priority'
    137   WHERE status IN ('new', 'assigned', 'reopened')
    138   ORDER BY p.value, milestone, severity, time
     173   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     174FROM ticket t
     175   LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     176   JOIN enum p ON p.name = t.priority AND p.type = 'priority'
     177WHERE status IN ('new', 'assigned', 'reopened')
     178ORDER BY p.value, milestone, severity, time
    139179}}}
    140180
    141181Note in particular the `LEFT OUTER JOIN` statement here.
    142182
    143 Note that if your config file uses an uppercase name, e.g.,
    144 {{{
     183Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
     184{{{#!ini
    145185[ticket-custom]
    146 
    147186Progress_Type = text
    148187}}}
    149 you would use lowercase in the SQL: `AND c.name = 'progress_type'`
    150 
    151 === Updating the database
    152 
    153 As noted above, any tickets created before a custom field has been defined will not have a value for that field. Here's a bit of SQL (tested with SQLite) that you can run directly on the Trac database to set an initial value for custom ticket fields. Inserts the default value of 'None' into a custom field called 'request_source' for all tickets that have no existing value:
    154 
    155 {{{
    156 #!sql
    157 INSERT INTO ticket_custom
    158    (ticket, name, value)
    159    SELECT
    160       id AS ticket,
    161       'request_source' AS name,
    162       'None' AS value
    163    FROM ticket
    164    WHERE id NOT IN (
    165       SELECT ticket FROM ticket_custom
    166    );
    167 }}}
    168 
    169 If you added multiple custom fields at different points in time, you should be more specific in the subquery on table {{{ticket}}} by adding the exact custom field name to the query:
    170 
    171 {{{
    172 #!sql
    173 INSERT INTO ticket_custom
    174    (ticket, name, value)
    175    SELECT
    176       id AS ticket,
    177       'request_source' AS name,
    178       'None' AS value
    179    FROM ticket
    180    WHERE id NOT IN (
    181       SELECT ticket FROM ticket_custom WHERE name = 'request_source'
    182    );
    183 }}}
     188you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    184189
    185190----