Changes between Version 3 and Version 4 of TracTicketsCustomFields


Ignore:
Timestamp:
Apr 6, 2020, 3:35:21 AM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v3 v4  
    11= Custom Ticket Fields
    2 
    3 Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
     2Trac supports adding custom, user-defined fields to the ticket module. With custom fields you can add typed, site-specific properties to tickets.
    43
    54== Configuration
    65
    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]`.
     6Configuring custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini.
    87
    98The syntax of each field definition is:
     
    2120   * label: Descriptive label.
    2221   * value: Default value.
    23    * order: Sort order placement. 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//).
    2424   * format: One of:
    2525     * `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'')
     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
    2929 * '''checkbox''': A boolean value check box.
    3030   * label: Descriptive label.
    31    * value: Default value: 0 or 1.
     31   * value: Default value, 0 or 1.
    3232   * order: Sort order placement.
    3333 * '''select''': Drop-down select box. Uses a list of values.
     
    3939   * label: Descriptive label.
    4040   * options: List of values, separated by '''|''' (vertical pipe).
    41    * value: Default value (one of the values from options).
     41   * value: Default value, one of the values from options.
    4242   * order: Sort order placement.
    4343 * '''textarea''': Multi-line text area.
    4444   * label: Descriptive label.
    4545   * value: Default text.
    46    * cols: Width in columns
    4746   * rows: Height in lines.
    4847   * order: Sort order placement.
     48   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    4949   * 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.
     58
     59If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
    5060
    5161Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     
    7585test_five = radio
    7686test_five.label = Radio buttons are fun
    77 test_five.options = uno|dos|tres|cuatro|cinco
     87test_five.options = |uno|dos|tres|cuatro|cinco
    7888test_five.value = dos
    7989
     
    8393test_six.cols = 60
    8494test_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
    85110}}}
    86111
    87 '''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`).
    88113
    89114=== Reports Involving Custom Fields
     
    99124  ORDER BY p.value
    100125}}}
    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.
     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.
    103127
    104128However, 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:
     
    120144Note in particular the `LEFT OUTER JOIN` statement here.
    121145
    122 Note that if your config file uses an '''uppercase''' name:
     146Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
    123147{{{#!ini
    124148[ticket-custom]
    125 
    126149Progress_Type = text
    127150}}}
    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 }}}
     151you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    161152
    162153----