Changes between Version 3 and Version 4 of TracTicketsCustomFields


Ignore:
Timestamp:
10/25/2021 04:13:30 PM (8 months 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
     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.)
    20    * format: One of:
    21      * `plain` for plain text
    22      * `wiki` to interpret the content as WikiFormatting (''since 0.11.3'')
    23      * `reference` to treat the content as a queryable value (''since 1.0'')
    24      * `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
    2564 * '''checkbox''': A boolean value check box.
    2665   * label: Descriptive label.
    27    * value: Default value (0 or 1).
     66   * value: Default value, 0 or 1.
    2867   * order: Sort order placement.
    2968 * '''select''': Drop-down select box. Uses a list of values.
     
    3574   * label: Descriptive label.
    3675   * options: List of values, separated by '''|''' (vertical pipe).
    37    * value: Default value (one of the values from options).
     76   * value: Default value, one of the values from options.
    3877   * order: Sort order placement.
    3978 * '''textarea''': Multi-line text area.
    4079   * label: Descriptive label.
    4180   * value: Default text.
    42    * cols: Width in columns.
    4381   * rows: Height in lines.
    4482   * order: Sort order placement.
    45    * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
     83   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     84   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     85 * '''time''': Date and time picker. (//Since 1.1.1//)
     86   * label: Descriptive label.
     87   * value: Default date.
     88   * order: Sort order placement.
     89   * format: One of:
     90     * `relative` for relative dates.
     91     * `date` for absolute dates.
     92     * `datetime` for absolute date and time values.
    4693
    47 === Sample Config ===
    48 {{{
     94If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
     95
     96Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     97
     98=== Sample Configuration
     99
     100{{{#!ini
    49101[ticket-custom]
    50102
     
    68120test_five = radio
    69121test_five.label = Radio buttons are fun
    70 test_five.options = uno|dos|tres|cuatro|cinco
     122test_five.options = |uno|dos|tres|cuatro|cinco
    71123test_five.value = dos
    72124
     
    76128test_six.cols = 60
    77129test_six.rows = 30
     130
     131test_seven = time
     132test_seven.label = A relative date
     133test_seven.format = relative
     134test_seven.value = now
     135
     136test_eight = time
     137test_eight.label = An absolute date
     138test_eight.format = date
     139test_eight.value = yesterday
     140
     141test_nine = time
     142test_nine.label = A date and time
     143test_nine.format = datetime
     144test_nine.value = in 2 hours
    78145}}}
    79146
    80 ''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
     147'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
    81148
    82 === Reports Involving Custom Fields ===
     149=== Reports Involving Custom Fields
    83150
    84151Custom 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`.
    85152
    86 {{{
    87 #!sql
     153{{{#!sql
    88154SELECT p.value AS __color__,
    89155   id AS ticket, summary, owner, c.value AS progress
     
    93159  ORDER BY p.value
    94160}}}
    95 '''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.
     161'''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.
    96162
    97 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.
    98 {{{
    99 #!sql
     163However, 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:
     164{{{#!sql
    100165SELECT p.value AS __color__,
    101166   id AS ticket, summary, component, version, milestone, severity,
     
    104169   changetime AS _changetime, description AS _description,
    105170   reporter AS _reporter,
    106   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     171   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    107172  FROM ticket t
    108173     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     
    114179Note in particular the `LEFT OUTER JOIN` statement here.
    115180
    116 === Updating the database ===
    117 
    118 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:
    119 
    120 {{{
    121 #!sql
    122 INSERT INTO ticket_custom
    123    (ticket, name, value)
    124    SELECT
    125       id AS ticket,
    126       'request_source' AS name,
    127       'None' AS value
    128    FROM ticket
    129    WHERE id NOT IN (
    130       SELECT ticket FROM ticket_custom
    131    );
     181Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
     182{{{#!ini
     183[ticket-custom]
     184Progress_Type = text
    132185}}}
    133 
    134 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:
    135 
    136 {{{
    137 #!sql
    138 INSERT INTO ticket_custom
    139    (ticket, name, value)
    140    SELECT
    141       id AS ticket,
    142       'request_source' AS name,
    143       'None' AS value
    144    FROM ticket
    145    WHERE id NOT IN (
    146       SELECT ticket FROM ticket_custom WHERE name = 'request_source'
    147    );
    148 }}}
     186you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    149187
    150188----