Changes between Version 2 and Version 3 of TracTicketsCustomFields


Ignore:
Timestamp:
May 2, 2019, 9:45:05 AM (14 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v2 v3  
    11= Custom Ticket Fields
    2 Trac supports adding custom, user-defined fields to the ticket module. With custom fields you can add typed, site-specific properties to tickets.
     2
     3Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
    34
    45== Configuration
     6
    57Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
    68
     
    1113 ...
    1214}}}
     15
    1316The example below should help to explain the syntax.
    1417
    1518=== Available Field Types and Options
     19
    1620 * '''text''': A simple (one line) text field.
    1721   * label: Descriptive label.
    1822   * value: Default value.
    19    * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
     23   * order: Sort order placement. Determines relative placement in forms with respect to other custom fields.
    2024   * format: One of:
    2125     * `plain` for plain text
     
    2529 * '''checkbox''': A boolean value check box.
    2630   * label: Descriptive label.
    27    * value: Default value, 0 or 1.
     31   * value: Default value: 0 or 1.
    2832   * order: Sort order placement.
    2933 * '''select''': Drop-down select box. Uses a list of values.
     
    3539   * label: Descriptive label.
    3640   * options: List of values, separated by '''|''' (vertical pipe).
    37    * value: Default value, one of the values from options.
     41   * value: Default value (one of the values from options).
    3842   * order: Sort order placement.
    3943 * '''textarea''': Multi-line text area.
    4044   * label: Descriptive label.
    4145   * value: Default text.
    42    * cols: Width in columns. //(Removed in 1.1.2)//
     46   * cols: Width in columns
    4347   * rows: Height in lines.
    4448   * order: Sort order placement.
    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.'')
    47    * label: Descriptive label.
    48    * value: Default date.
    49    * order: Sort order placement.
    50    * format: One of:
    51      * `relative` for relative dates.
    52      * `date` for absolute dates.
    53      * `datetime` for absolute date and time values.
    54 
    55 If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
    5650
    5751Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
    5852
    59 === Sample Config
    60 {{{
     53=== Sample Configuration
     54
     55{{{#!ini
    6156[ticket-custom]
    6257
     
    8883test_six.cols = 60
    8984test_six.rows = 30
    90 
    91 test_seven = time
    92 test_seven.label = A relative date
    93 test_seven.format = relative
    94 test_seven.value = now
    95 
    96 test_eight = time
    97 test_eight.label = An absolute date
    98 test_eight.format = date
    99 test_eight.value = yesterday
    100 
    101 test_nine = time
    102 test_nine.label = A date and time
    103 test_nine.format = datetime
    104 test_nine.value = in 2 hours
    10585}}}
    10686
    107 '''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
     87'''Note''': To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
    10888
    10989=== Reports Involving Custom Fields
     
    11191Custom 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`.
    11292
    113 {{{
    114 #!sql
     93{{{#!sql
    11594SELECT p.value AS __color__,
    11695   id AS ticket, summary, owner, c.value AS progress
     
    12099  ORDER BY p.value
    121100}}}
    122 '''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.
     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.
    123103
    124104However, 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
     105{{{#!sql
    127106SELECT p.value AS __color__,
    128107   id AS ticket, summary, component, version, milestone, severity,
     
    131110   changetime AS _changetime, description AS _description,
    132111   reporter AS _reporter,
    133   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     112   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    134113  FROM ticket t
    135114     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     
    141120Note in particular the `LEFT OUTER JOIN` statement here.
    142121
    143 Note that if your config file uses an uppercase name, e.g.,
    144 {{{
     122Note that if your config file uses an '''uppercase''' name:
     123{{{#!ini
    145124[ticket-custom]
    146125
    147126Progress_Type = text
    148127}}}
    149 you would use lowercase in the SQL: `AND c.name = 'progress_type'`
     128you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    150129
    151130=== Updating the database
    152131
    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:
     132As 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:
    154133
    155 {{{
    156 #!sql
     134{{{#!sql
    157135INSERT INTO ticket_custom
    158136   (ticket, name, value)
     
    169147If 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:
    170148
    171 {{{
    172 #!sql
     149{{{#!sql
    173150INSERT INTO ticket_custom
    174151   (ticket, name, value)