Changes between Version 3 and Version 4 of TracTicketsCustomFields


Ignore:
Timestamp:
Dec 4, 2020, 2:27:59 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTicketsCustomFields

    v3 v4  
    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 ==
    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]`.
     4== Configuration
     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
    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.)
    20    * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
     22   * order: Sort order placement relative to other custom fields.
     23   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     24   * format: One of:
     25     * `plain` for plain text
     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
    2129 * '''checkbox''': A boolean value check box.
    2230   * label: Descriptive label.
    23    * value: Default value (0 or 1).
     31   * value: Default value, 0 or 1.
    2432   * order: Sort order placement.
    2533 * '''select''': Drop-down select box. Uses a list of values.
    … …  
    3139   * label: Descriptive label.
    3240   * options: List of values, separated by '''|''' (vertical pipe).
    33    * value: Default value (one of the values from options).
     41   * value: Default value, one of the values from options.
    3442   * order: Sort order placement.
    3543 * '''textarea''': Multi-line text area.
    3644   * label: Descriptive label.
    3745   * value: Default text.
    38    * cols: Width in columns.
    3946   * rows: Height in lines.
    4047   * order: Sort order placement.
    41    * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
     48   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     49   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     50 * '''time''': Date and time picker. (//Since 1.1.1//)
     51   * label: Descriptive label.
     52   * value: Default date.
     53   * order: Sort order placement.
     54   * format: One of:
     55     * `relative` for relative dates.
     56     * `date` for absolute dates.
     57     * `datetime` for absolute date and time values.
    4258
    43 === Sample Config ===
    44 {{{
     59If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
     60
     61Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     62
     63=== Sample Configuration
     64
     65{{{#!ini
    4566[ticket-custom]
    4667
    … …  
    6485test_five = radio
    6586test_five.label = Radio buttons are fun
    66 test_five.options = uno|dos|tres|cuatro|cinco
     87test_five.options = |uno|dos|tres|cuatro|cinco
    6788test_five.value = dos
    6889
    … …  
    7293test_six.cols = 60
    7394test_six.rows = 30
     95
     96test_seven = time
     97test_seven.label = A relative date
     98test_seven.format = relative
     99test_seven.value = now
     100
     101test_eight = time
     102test_eight.label = An absolute date
     103test_eight.format = date
     104test_eight.value = yesterday
     105
     106test_nine = time
     107test_nine.label = A date and time
     108test_nine.format = datetime
     109test_nine.value = in 2 hours
    74110}}}
    75111
    76 ''Note: To make entering an option for 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`).
    77113
    78 === Reports Involving Custom Fields ===
     114=== Reports Involving Custom Fields
    79115
    80116Custom 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`.
    81117
    82 {{{
    83 #!sql
     118{{{#!sql
    84119SELECT p.value AS __color__,
    85120   id AS ticket, summary, owner, c.value AS progress
    … …  
    89124  ORDER BY p.value
    90125}}}
    91 '''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.
     126'''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.
    92127
    93 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.
    94 {{{
    95 #!sql
     128However, 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:
     129{{{#!sql
    96130SELECT p.value AS __color__,
    97131   id AS ticket, summary, component, version, milestone, severity,
    … …  
    100134   changetime AS _changetime, description AS _description,
    101135   reporter AS _reporter,
    102   (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
    103137  FROM ticket t
    104138     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
    … …  
    110144Note in particular the `LEFT OUTER JOIN` statement here.
    111145
    112 === Updating the database ===
    113 
    114 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:
    115 
    116 {{{
    117 #!sql
    118 INSERT INTO ticket_custom
    119    (ticket, name, value)
    120    SELECT
    121       id AS ticket,
    122       'request_source' AS name,
    123       'None' AS value
    124    FROM ticket
    125    WHERE id NOT IN (
    126       SELECT ticket FROM ticket_custom
    127    );
     146Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
     147{{{#!ini
     148[ticket-custom]
     149Progress_Type = text
    128150}}}
    129 
    130 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:
    131 
    132 {{{
    133 #!sql
    134 INSERT INTO ticket_custom
    135    (ticket, name, value)
    136    SELECT
    137       id AS ticket,
    138       'request_source' AS name,
    139       'None' AS value
    140    FROM ticket
    141    WHERE id NOT IN (
    142       SELECT ticket FROM ticket_custom WHERE name = 'request_source'
    143    );
    144 }}}
     151you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    145152
    146153----