Changes between Version 9 and Version 10 of TracTicketsCustomFields


Ignore:
Timestamp:
May 10, 2020, 8:18:21 PM (7 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v9 v10  
    33
    44== 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]`.
     5
     6Configuring custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini.
    67
    78The syntax of each field definition is:
     
    1112 ...
    1213}}}
     14
    1315The example below should help to explain the syntax.
    1416
    1517=== Available Field Types and Options
     18
    1619 * '''text''': A simple (one line) text field.
    1720   * label: Descriptive label.
    1821   * value: Default value.
    19    * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
     22   * order: Sort order placement relative to other custom fields.
     23   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    2024   * format: One of:
    2125     * `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'')
     26     * `wiki` for [WikiFormatting wiki formatted] content
     27     * `reference` to treat the content as a queryable value
     28     * `list` to interpret the content as a list of queryable values, separated by whitespace
    2529 * '''checkbox''': A boolean value check box.
    2630   * label: Descriptive label.
     
    4044   * label: Descriptive label.
    4145   * value: Default text.
    42    * cols: Width in columns. //(Removed in 1.1.2)//
    4346   * rows: Height in lines.
    4447   * order: Sort order placement.
     48   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    4549   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
    46  * '''time''': Date and time picker. (''Since 1.1.1.'')
     50 * '''time''': Date and time picker. (//Since 1.1.1//)
    4751   * label: Descriptive label.
    4852   * value: Default date.
     
    5761Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
    5862
    59 === Sample Config
    60 {{{
     63=== Sample Configuration
     64
     65{{{#!ini
    6166[ticket-custom]
    6267
     
    8085test_five = radio
    8186test_five.label = Radio buttons are fun
    82 test_five.options = uno|dos|tres|cuatro|cinco
     87test_five.options = |uno|dos|tres|cuatro|cinco
    8388test_five.value = dos
    8489
     
    105110}}}
    106111
    107 '''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
     112'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
    108113
    109114=== Reports Involving Custom Fields
     
    111116Custom 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`.
    112117
    113 {{{
    114 #!sql
     118{{{#!sql
    115119SELECT p.value AS __color__,
    116120   id AS ticket, summary, owner, c.value AS progress
     
    123127
    124128However, 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
     129{{{#!sql
    127130SELECT p.value AS __color__,
    128131   id AS ticket, summary, component, version, milestone, severity,
     
    131134   changetime AS _changetime, description AS _description,
    132135   reporter AS _reporter,
    133   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     136   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    134137  FROM ticket t
    135138     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     
    141144Note in particular the `LEFT OUTER JOIN` statement here.
    142145
    143 Note that if your config file uses an uppercase name, e.g.,
    144 {{{
     146Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
     147{{{#!ini
    145148[ticket-custom]
    146 
    147149Progress_Type = text
    148150}}}
    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 }}}
     151you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    184152
    185153----