Changes between Version 3 and Version 4 of TracTicketsCustomFields


Ignore:
Timestamp:
Apr 30, 2024 1:41:37 PM (3 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTicketsCustomFields

    v3 v4  
    11= Custom Ticket Fields
    22
    3 Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
     3Trac supports adding custom, user-defined fields to the ticket module. With custom fields you can add typed, site-specific properties to tickets.
    44
    55== Configuration
    66
    7 Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
     7Configure custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini.
    88
    99The syntax of each field definition is:
    … …  
    1616The example below should help to explain the syntax.
    1717
     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
    1854=== Available Field Types and Options
    1955
    … …  
    2157   * label: Descriptive label.
    2258   * value: Default value.
    23    * order: Sort order placement. Determines relative placement in forms with respect to other custom fields.
    24    * format: One of:
    25      * `plain` for plain text
    26      * `wiki` to interpret the content as WikiFormatting
    27      * `reference` to treat the content as a queryable value (''since 1.0'')
    28      * `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
    2966 * '''checkbox''': A boolean value check box.
    3067   * label: Descriptive label.
    31    * value: Default value: 0 or 1.
     68   * value: Default value, 0 or 1.
    3269   * order: Sort order placement.
    3370 * '''select''': Drop-down select box. Uses a list of values.
    … …  
    3976   * label: Descriptive label.
    4077   * options: List of values, separated by '''|''' (vertical pipe).
    41    * value: Default value (one of the values from options).
     78   * value: Default value, one of the values from options.
    4279   * order: Sort order placement.
    4380 * '''textarea''': Multi-line text area.
    4481   * label: Descriptive label.
    4582   * value: Default text.
    46    * cols: Width in columns
    4783   * rows: Height in lines.
    4884   * order: Sort order placement.
     85   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    4986   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     87 * '''time''': Date and time picker. (//Since 1.1.1//)
     88   * label: Descriptive label.
     89   * value: Default date.
     90   * order: Sort order placement.
     91   * format: One of:
     92     * `relative` for relative dates.
     93     * `date` for absolute dates.
     94     * `datetime` for absolute date and time values.
     95
     96If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
    5097
    5198Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
    … …  
    75122test_five = radio
    76123test_five.label = Radio buttons are fun
    77 test_five.options = uno|dos|tres|cuatro|cinco
     124test_five.options = |uno|dos|tres|cuatro|cinco
    78125test_five.value = dos
    79126
    … …  
    83130test_six.cols = 60
    84131test_six.rows = 30
     132
     133test_seven = time
     134test_seven.label = A relative date
     135test_seven.format = relative
     136test_seven.value = now
     137
     138test_eight = time
     139test_eight.label = An absolute date
     140test_eight.format = date
     141test_eight.value = yesterday
     142
     143test_nine = time
     144test_nine.label = A date and time
     145test_nine.format = datetime
     146test_nine.value = in 2 hours
    85147}}}
    86148
    87 '''Note''': To make entering an option for 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`).
    88150
    89151=== Reports Involving Custom Fields
    … …  
    94156SELECT p.value AS __color__,
    95157   id AS ticket, summary, owner, c.value AS progress
    96   FROM ticket t, enum p, ticket_custom c
    97   WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
    98 AND p.name = t.priority AND p.type = 'priority'
    99   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
    100162}}}
    101 
    102 '''Note''': This will only show tickets that have progress set in them, which 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. If that is all that is required, you're set.
     163'''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.
    103164
    104165However, 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:
    … …  
    111172   reporter AS _reporter,
    112173   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    113   FROM ticket t
    114      LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
    115      JOIN enum p ON p.name = t.priority AND p.type='priority'
    116   WHERE status IN ('new', 'assigned', 'reopened')
    117   ORDER BY p.value, milestone, severity, time
     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
    118179}}}
    119180
    120181Note in particular the `LEFT OUTER JOIN` statement here.
    121182
    122 Note that if your config file uses an '''uppercase''' name:
     183Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
    123184{{{#!ini
    124185[ticket-custom]
    125 
    126186Progress_Type = text
    127187}}}
    128 you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    129 
    130 === Updating the database
    131 
    132 As noted above, any tickets created before a custom field has been defined will not have a value for that field. Here is some SQL (tested with SQLite) that you can run directly on the Trac database to set an initial value for custom ticket fields. It inserts the default value of 'None' into a custom field called 'request_source' for all tickets that have no existing value:
    133 
    134 {{{#!sql
    135 INSERT INTO ticket_custom
    136    (ticket, name, value)
    137    SELECT
    138       id AS ticket,
    139       'request_source' AS name,
    140       'None' AS value
    141    FROM ticket
    142    WHERE id NOT IN (
    143       SELECT ticket FROM ticket_custom
    144    );
    145 }}}
    146 
    147 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:
    148 
    149 {{{#!sql
    150 INSERT INTO ticket_custom
    151    (ticket, name, value)
    152    SELECT
    153       id AS ticket,
    154       'request_source' AS name,
    155       'None' AS value
    156    FROM ticket
    157    WHERE id NOT IN (
    158       SELECT ticket FROM ticket_custom WHERE name = 'request_source'
    159    );
    160 }}}
     188you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    161189
    162190----