Changes between Version 9 and Version 10 of TracTicketsCustomFields


Ignore:
Timestamp:
Apr 24, 2018, 9:56:48 AM (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTicketsCustomFields

    v9 v10  
    1 = Custom Ticket Fields =
    2 Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
     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.
    33
    4 == Configuration ==
     4== Configuration
     5
    56Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
    67
    … …  
    1112 ...
    1213}}}
     14
    1315The example below should help to explain the syntax.
    1416
    15 === Available Field Types and Options ===
     17=== 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. (Determines relative placement in forms with respect to other custom fields.)
     22   * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
    2023   * format: One of:
    2124     * `plain` for plain text
    22      * `wiki` to interpret the content as WikiFormatting (''since 0.11.3'')
     25     * `wiki` to interpret the content as WikiFormatting
    2326     * `reference` to treat the content as a queryable value (''since 1.0'')
    2427     * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'')
    2528 * '''checkbox''': A boolean value check box.
    2629   * label: Descriptive label.
    27    * value: Default value (0 or 1).
     30   * value: Default value, 0 or 1.
    2831   * order: Sort order placement.
    2932 * '''select''': Drop-down select box. Uses a list of values.
    … …  
    3538   * label: Descriptive label.
    3639   * options: List of values, separated by '''|''' (vertical pipe).
    37    * value: Default value (one of the values from options).
     40   * value: Default value, one of the values from options.
    3841   * order: Sort order placement.
    3942 * '''textarea''': Multi-line text area.
    4043   * label: Descriptive label.
    4144   * value: Default text.
    42    * cols: Width in columns
     45   * cols: Width in columns. //(Removed in 1.1.2)//
    4346   * rows: Height in lines.
    4447   * order: Sort order placement.
    45    * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
     48   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     49 * '''time''': Date and time picker. (''Since 1.1.1.'')
     50   * label: Descriptive label.
     51   * value: Default date.
     52   * order: Sort order placement.
     53   * format: One of:
     54     * `relative` for relative dates.
     55     * `date` for absolute dates.
     56     * `datetime` for absolute date and time values.
     57
     58If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
    4659
    4760Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
    4861
    49 === Sample Config ===
    50 {{{
     62=== Sample Configuration
     63
     64{{{#!ini
    5165[ticket-custom]
    5266
    … …  
    7892test_six.cols = 60
    7993test_six.rows = 30
     94
     95test_seven = time
     96test_seven.label = A relative date
     97test_seven.format = relative
     98test_seven.value = now
     99
     100test_eight = time
     101test_eight.label = An absolute date
     102test_eight.format = date
     103test_eight.value = yesterday
     104
     105test_nine = time
     106test_nine.label = A date and time
     107test_nine.format = datetime
     108test_nine.value = in 2 hours
    80109}}}
    81110
    82 ''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
     111'''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
    83112
    84 === Reports Involving Custom Fields ===
     113=== Reports Involving Custom Fields
    85114
    86115Custom 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`.
    87116
    88 {{{
    89 #!sql
     117{{{#!sql
    90118SELECT p.value AS __color__,
    91119   id AS ticket, summary, owner, c.value AS progress
    … …  
    95123  ORDER BY p.value
    96124}}}
    97 '''Note''' that 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's all you want, you're set.
     125'''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.
    98126
    99 However, 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.
    100 {{{
    101 #!sql
     127However, 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:
     128{{{#!sql
    102129SELECT p.value AS __color__,
    103130   id AS ticket, summary, component, version, milestone, severity,
    … …  
    106133   changetime AS _changetime, description AS _description,
    107134   reporter AS _reporter,
    108   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     135   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    109136  FROM ticket t
    110137     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
    … …  
    116143Note in particular the `LEFT OUTER JOIN` statement here.
    117144
    118 Note that if your config file uses an uppercase name, e.g.,
    119 {{{
     145Note that if your config file uses an '''uppercase''' name:
     146{{{#!ini
    120147[ticket-custom]
    121148
    122149Progress_Type = text
    123150}}}
    124 you would use lowercase in the SQL:  `AND c.name = 'progress_type'`
    125 
    126 === Updating the database ===
    127 
    128 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:
    129 
    130 {{{
    131 #!sql
    132 INSERT INTO ticket_custom
    133    (ticket, name, value)
    134    SELECT
    135       id AS ticket,
    136       'request_source' AS name,
    137       'None' AS value
    138    FROM ticket
    139    WHERE id NOT IN (
    140       SELECT ticket FROM ticket_custom
    141    );
    142 }}}
    143 
    144 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:
    145 
    146 {{{
    147 #!sql
    148 INSERT INTO ticket_custom
    149    (ticket, name, value)
    150    SELECT
    151       id AS ticket,
    152       'request_source' AS name,
    153       'None' AS value
    154    FROM ticket
    155    WHERE id NOT IN (
    156       SELECT ticket FROM ticket_custom WHERE name = 'request_source'
    157    );
    158 }}}
     151you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    159152
    160153----