Changes between Version 2 and Version 3 of TracTicketsCustomFields


Ignore:
Timestamp:
2017-08-28T06:33:43Z (3 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.
     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 ==
     4== Configuration
     5
    56Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
    67
     
    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.)
     22   * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
     23   * format: One of:
     24     * `plain` for plain text
     25     * `wiki` to interpret the content as WikiFormatting
     26     * `reference` to treat the content as a queryable value (''since 1.0'')
     27     * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'')
    2028 * '''checkbox''': A boolean value check box.
    2129   * label: Descriptive label.
    22    * value: Default value (0 or 1).
     30   * value: Default value, 0 or 1.
    2331   * order: Sort order placement.
    2432 * '''select''': Drop-down select box. Uses a list of values.
     
    3038   * label: Descriptive label.
    3139   * options: List of values, separated by '''|''' (vertical pipe).
    32    * value: Default value (one of the values from options).
     40   * value: Default value, one of the values from options.
    3341   * order: Sort order placement.
    3442 * '''textarea''': Multi-line text area.
    3543   * label: Descriptive label.
    3644   * value: Default text.
    37    * cols: Width in columns.
     45   * cols: Width in columns. //(Removed in 1.1.2)//
    3846   * rows: Height in lines.
    3947   * order: Sort order placement.
     48   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     49 * '''time''': Date and time picker. (''Since 1.1.1.'')
     50   * label: Descriptive label.
     51   * value: Default date.
     52   * order: Sort order placement.
     53   * format: One of:
     54     * `relative` for relative dates.
     55     * `date` for absolute dates.
     56     * `datetime` for absolute date and time values.
    4057
    41 === Sample Config ===
    42 {{{
     58If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
     59
     60Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     61
     62=== Sample Configuration
     63
     64{{{#!ini
    4365[ticket-custom]
    4466
     
    4870test_two = text
    4971test_two.label = Another text-box
    50 test_two.value = Just a default value
     72test_two.value = Default [mailto:joe@nospam.com owner]
     73test_two.format = wiki
    5174
    5275test_three = checkbox
     
    6992test_six.cols = 60
    7093test_six.rows = 30
     94
     95test_seven = time
     96test_seven.label = A relative date
     97test_seven.format = relative
     98test_seven.value = now
     99
     100test_eight = time
     101test_eight.label = An absolute date
     102test_eight.format = date
     103test_eight.value = yesterday
     104
     105test_nine = time
     106test_nine.label = A date and time
     107test_nine.format = datetime
     108test_nine.value = in 2 hours
    71109}}}
    72110
    73 ''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
     111'''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
    74112
    75 === Reports Involving Custom Fields ===
     113=== Reports Involving Custom Fields
    76114
    77115Custom 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`.
    78116
    79 {{{
    80 #!sql
     117{{{#!sql
    81118SELECT p.value AS __color__,
    82119   id AS ticket, summary, owner, c.value AS progress
     
    86123  ORDER BY p.value
    87124}}}
    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.
     125'''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.
    89126
    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
     127However, 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:
     128{{{#!sql
    93129SELECT p.value AS __color__,
    94130   id AS ticket, summary, component, version, milestone, severity,
     
    97133   changetime AS _changetime, description AS _description,
    98134   reporter AS _reporter,
    99   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     135   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    100136  FROM ticket t
    101137     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     
    107143Note in particular the `LEFT OUTER JOIN` statement here.
    108144
    109 === Updating the database ===
     145Note that if your config file uses an '''uppercase''' name:
     146{{{#!ini
     147[ticket-custom]
    110148
    111 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:
    112 
    113 {{{
    114 #!sql
    115 INSERT INTO ticket_custom
    116    (ticket, name, value)
    117    SELECT
    118       id AS ticket,
    119       'request_source' AS name,
    120       'None' AS value
    121    FROM ticket
    122    WHERE id NOT IN (
    123       SELECT ticket FROM ticket_custom
    124    );
     149Progress_Type = text
    125150}}}
    126 
    127 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:
    128 
    129 {{{
    130 #!sql
    131 INSERT INTO ticket_custom
    132    (ticket, name, value)
    133    SELECT
    134       id AS ticket,
    135       'request_source' AS name,
    136       'None' AS value
    137    FROM ticket
    138    WHERE id NOT IN (
    139       SELECT ticket FROM ticket_custom WHERE name = 'request_source'
    140    );
    141 }}}
     151you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    142152
    143153----