Changes between Version 2 and Version 3 of TracTicketsCustomFields


Ignore:
Timestamp:
Aug 1, 2024, 10:29:26 AM (4 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTicketsCustomFields

    v2 v3  
    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]`.
     6Configure custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini.
    87
    98The syntax of each field definition is:
    … …  
    1615The example below should help to explain the syntax.
    1716
     17=== Field Names
     18A 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.
     19
     20The following field names are reserved and can not be used for custom fields:
     21* cc
     22* changetime
     23* col
     24* comment
     25* component
     26* desc
     27* description
     28* format
     29* group
     30* groupdesc
     31* id
     32* keywords
     33* max
     34* milestone
     35* or
     36* order
     37* owner
     38* page
     39* priority
     40* report
     41* reporter
     42* resolution
     43* row
     44* severity
     45* status
     46* summary
     47* time
     48* type
     49* verbose
     50* version
     51
    1852=== Available Field Types and Options
    1953
    … …  
    2155   * label: Descriptive label.
    2256   * 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'')
     57   * order: Sort order placement relative to other custom fields.
     58   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     59   * format: One of:
     60     * `plain` for plain text
     61     * `wiki` for [WikiFormatting wiki formatted] content
     62     * `reference` to treat the content as a queryable value
     63     * `list` to interpret the content as a list of queryable values, separated by whitespace
     64   * ticketlink_query: Query for linkifying ticket values.
     65     Not applicable for format `plain` and `wiki`.
    2966 * '''checkbox''': A boolean value check box.
    3067   * label: Descriptive label.
    31    * value: Default value: 0 or 1.
    32    * order: Sort order placement.
     68   * value: Default value, 0 or 1.
     69   * order: Sort order placement.
     70   * ticketlink_query: Query for linkifying ticket values.
    3371 * '''select''': Drop-down select box. Uses a list of values.
    3472   * label: Descriptive label.
    … …  
    3674   * value: Default value (one of the values from options).
    3775   * order: Sort order placement.
     76   * ticketlink_query: Query for linkifying ticket values.
    3877 * '''radio''': Radio buttons. Essentially the same as '''select'''.
    3978   * label: Descriptive label.
    4079   * options: List of values, separated by '''|''' (vertical pipe).
    41    * value: Default value (one of the values from options).
    42    * order: Sort order placement.
     80   * value: Default value, one of the values from options.
     81   * order: Sort order placement.
     82   * ticketlink_query: Query for linkifying ticket values.
    4383 * '''textarea''': Multi-line text area.
    4484   * label: Descriptive label.
    4585   * value: Default text.
    46    * cols: Width in columns
    4786   * rows: Height in lines.
    4887   * order: Sort order placement.
     88   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    4989   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     90 * '''time''': Date and time picker. (//Since 1.1.1//)
     91   * label: Descriptive label.
     92   * value: Default date.
     93   * order: Sort order placement.
     94   * format: One of:
     95     * `relative` for relative dates.
     96     * `date` for absolute dates.
     97     * `datetime` for absolute date and time values.
     98
     99If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
    50100
    51101Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     102
     103For applicable fields, the `ticketlink_query` option
     104overrides [[TracIni#query-ticketlink_query-option|"[query] ticketlink_query"]], and the format is the same as
     105that option. When the `ticketlink_query` option
     106is not specified, `[query]` `ticketlink_query` is used to
     107linkify the field.
    52108
    53109=== Sample Configuration
    … …  
    75131test_five = radio
    76132test_five.label = Radio buttons are fun
    77 test_five.options = uno|dos|tres|cuatro|cinco
     133test_five.options = |uno|dos|tres|cuatro|cinco
    78134test_five.value = dos
    79135
    … …  
    83139test_six.cols = 60
    84140test_six.rows = 30
    85 }}}
    86 
    87 '''Note''': To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
     141
     142test_seven = time
     143test_seven.label = A relative date
     144test_seven.format = relative
     145test_seven.value = now
     146
     147test_eight = time
     148test_eight.label = An absolute date
     149test_eight.format = date
     150test_eight.value = yesterday
     151
     152test_nine = time
     153test_nine.label = A date and time
     154test_nine.format = datetime
     155test_nine.value = in 2 hours
     156}}}
     157
     158'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
    88159
    89160=== Reports Involving Custom Fields
    … …  
    99170  ORDER BY p.value
    100171}}}
    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.
     172'''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.
    103173
    104174However, 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:
    … …  
    120190Note in particular the `LEFT OUTER JOIN` statement here.
    121191
    122 Note that if your config file uses an '''uppercase''' name:
     192Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
    123193{{{#!ini
    124194[ticket-custom]
    125 
    126195Progress_Type = text
    127196}}}
    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 }}}
     197you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    161198
    162199----