Changes between Version 2 and Version 3 of TracTicketsCustomFields


Ignore:
Timestamp:
2023-04-20T18:47:43Z (19 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTicketsCustomFields

    v2 v3  
    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.
    3 
    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]`.
     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.
     3
     4== Configuration
     5
     6Configure 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=== 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
     52=== Available Field Types and Options
     53
    1654 * '''text''': A simple (one line) text field.
    1755   * label: Descriptive label.
    1856   * value: Default value.
    19    * order: Sort order placement. (Determines relative placement in forms with respect to other custom fields.)
     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`.
    2066 * '''checkbox''': A boolean value check box.
    2167   * label: Descriptive label.
    22    * value: Default value (0 or 1).
    23    * order: Sort order placement.
     68   * value: Default value, 0 or 1.
     69   * order: Sort order placement.
     70   * ticketlink_query: Query for linkifying ticket values.
    2471 * '''select''': Drop-down select box. Uses a list of values.
    2572   * label: Descriptive label.
    … …  
    2774   * value: Default value (one of the values from options).
    2875   * order: Sort order placement.
     76   * ticketlink_query: Query for linkifying ticket values.
    2977 * '''radio''': Radio buttons. Essentially the same as '''select'''.
    3078   * label: Descriptive label.
    3179   * options: List of values, separated by '''|''' (vertical pipe).
    32    * value: Default value (Item #, starting at 0).
    33    * 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.
    3483 * '''textarea''': Multi-line text area.
    3584   * label: Descriptive label.
    3685   * value: Default text.
    37    * cols: Width in columns.
    3886   * rows: Height in lines.
    3987   * order: Sort order placement.
    40 
    41 === Sample Config ===
    42 {{{
     88   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     89   * 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.
     100
     101Macros 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.
     108
     109=== Sample Configuration
     110
     111{{{#!ini
    43112[ticket-custom]
    44113
    … …  
    48117test_two = text
    49118test_two.label = Another text-box
    50 test_two.value = Just a default value
     119test_two.value = Default [mailto:joe@nospam.com owner]
     120test_two.format = wiki
    51121
    52122test_three = checkbox
    … …  
    61131test_five = radio
    62132test_five.label = Radio buttons are fun
    63 test_five.options = uno|dos|tres|cuatro|cinco
    64 test_five.value = 1
     133test_five.options = |uno|dos|tres|cuatro|cinco
     134test_five.value = dos
    65135
    66136test_six = textarea
    … …  
    69139test_six.cols = 60
    70140test_six.rows = 30
    71 }}}
    72 
    73 ''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
    74 
    75 === Reports Involving Custom Fields ===
     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`).
     159
     160=== Reports Involving Custom Fields
    76161
    77162Custom 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`.
    78163
    79 {{{
    80 #!sql
     164{{{#!sql
    81165SELECT p.value AS __color__,
    82166   id AS ticket, summary, owner, c.value AS progress
    … …  
    86170  ORDER BY p.value
    87171}}}
    88 '''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.
    89 
    90 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.
    91 {{{
    92 #!sql
     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.
     173
     174However, 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:
     175{{{#!sql
    93176SELECT p.value AS __color__,
    94177   id AS ticket, summary, component, version, milestone, severity,
    … …  
    97180   changetime AS _changetime, description AS _description,
    98181   reporter AS _reporter,
    99   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     182   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    100183  FROM ticket t
    101184     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
    … …  
    107190Note in particular the `LEFT OUTER JOIN` statement here.
    108191
     192Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
     193{{{#!ini
     194[ticket-custom]
     195Progress_Type = text
     196}}}
     197you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
     198
    109199----
    110200See also: TracTickets, TracIni