Changes between Version 4 and Version 5 of TracTicketsCustomFields


Ignore:
Timestamp:
Dec 27, 2016, 1:09:11 AM (12 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v4 v5  
    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
    6 
    75Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
    86
     
    1311 ...
    1412}}}
    15 
    1613The example below should help to explain the syntax.
    1714
    1815=== Available Field Types and Options
    19 
    2016 * '''text''': A simple (one line) text field.
    2117   * label: Descriptive label.
    2218   * value: Default value.
    23    * order: Sort order placement. Determines relative placement in forms with respect to other custom fields.
     19   * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
    2420   * format: One of:
    2521     * `plain` for plain text
     
    2925 * '''checkbox''': A boolean value check box.
    3026   * label: Descriptive label.
    31    * value: Default value: 0 or 1.
     27   * value: Default value, 0 or 1.
    3228   * order: Sort order placement.
    3329 * '''select''': Drop-down select box. Uses a list of values.
     
    3935   * label: Descriptive label.
    4036   * options: List of values, separated by '''|''' (vertical pipe).
    41    * value: Default value (one of the values from options).
     37   * value: Default value, one of the values from options.
    4238   * order: Sort order placement.
    4339 * '''textarea''': Multi-line text area.
    4440   * label: Descriptive label.
    4541   * value: Default text.
    46    * cols: Width in columns
     42   * cols: Width in columns. //(Removed in 1.1.2)//
    4743   * rows: Height in lines.
    4844   * order: Sort order placement.
    4945   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     46 * '''time''': Date and time picker. (''Since 1.1.1.'')
     47   * label: Descriptive label.
     48   * value: Default date.
     49   * order: Sort order placement.
     50   * format: One of:
     51     * `relative` for relative dates.
     52     * `date` for absolute dates.
     53     * `datetime` for absolute date and time values.
     54
     55If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
    5056
    5157Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
    5258
    53 === Sample Configuration
    54 
    55 {{{#!ini
     59=== Sample Config
     60{{{
    5661[ticket-custom]
    5762
     
    8388test_six.cols = 60
    8489test_six.rows = 30
     90
     91test_seven = time
     92test_seven.label = A relative date
     93test_seven.format = relative
     94test_seven.value = now
     95
     96test_eight = time
     97test_eight.label = An absolute date
     98test_eight.format = date
     99test_eight.value = yesterday
     100
     101test_nine = time
     102test_nine.label = A date and time
     103test_nine.format = datetime
     104test_nine.value = in 2 hours
    85105}}}
    86106
    87 '''Note''': To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
     107'''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
    88108
    89109=== Reports Involving Custom Fields
     
    91111Custom 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`.
    92112
    93 {{{#!sql
     113{{{
     114#!sql
    94115SELECT p.value AS __color__,
    95116   id AS ticket, summary, owner, c.value AS progress
     
    99120  ORDER BY p.value
    100121}}}
    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.
     122'''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.
    103123
    104124However, 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:
    105 {{{#!sql
     125{{{
     126#!sql
    106127SELECT p.value AS __color__,
    107128   id AS ticket, summary, component, version, milestone, severity,
     
    110131   changetime AS _changetime, description AS _description,
    111132   reporter AS _reporter,
    112    (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     133  (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    113134  FROM ticket t
    114135     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     
    120141Note in particular the `LEFT OUTER JOIN` statement here.
    121142
    122 Note that if your config file uses an '''uppercase''' name:
    123 {{{#!ini
     143Note that if your config file uses an uppercase name, e.g.,
     144{{{
    124145[ticket-custom]
    125146
    126147Progress_Type = text
    127148}}}
    128 you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
     149you would use lowercase in the SQL: `AND c.name = 'progress_type'`
    129150
    130151=== Updating the database
    131152
    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:
     153As 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:
    133154
    134 {{{#!sql
     155{{{
     156#!sql
    135157INSERT INTO ticket_custom
    136158   (ticket, name, value)
     
    147169If 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:
    148170
    149 {{{#!sql
     171{{{
     172#!sql
    150173INSERT INTO ticket_custom
    151174   (ticket, name, value)