Changes between Version 4 and Version 5 of TracTicketsCustomFields


Ignore:
Timestamp:
2019-07-17T11:42:42-03:00 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTicketsCustomFields

    v4 v5  
    33
    44== 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
     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
    1552=== Available Field Types and Options
     53
    1654 * '''text''': A simple (one line) text field.
    1755   * label: Descriptive label.
    … …  
    5795Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
    5896
    59 === Sample Config
    60 {{{
     97=== Sample Configuration
     98
     99{{{#!ini
    61100[ticket-custom]
    62101
    … …  
    111150Custom 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`.
    112151
    113 {{{
    114 #!sql
     152{{{#!sql
    115153SELECT p.value AS __color__,
    116154   id AS ticket, summary, owner, c.value AS progress
    … …  
    123161
    124162However, 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:
    125 {{{
    126 #!sql
     163{{{#!sql
    127164SELECT p.value AS __color__,
    128165   id AS ticket, summary, component, version, milestone, severity,
    … …  
    131168   changetime AS _changetime, description AS _description,
    132169   reporter AS _reporter,
    133   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     170   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    134171  FROM ticket t
    135172     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
    … …  
    141178Note in particular the `LEFT OUTER JOIN` statement here.
    142179
    143 Note that if your config file uses an uppercase name, e.g.,
    144 {{{
     180Note that if your config file uses an '''uppercase''' name:
     181{{{#!ini
    145182[ticket-custom]
    146183
    147184Progress_Type = text
    148185}}}
    149 you would use lowercase in the SQL: `AND c.name = 'progress_type'`
    150 
    151 === Updating the database
    152 
    153 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:
    154 
    155 {{{
    156 #!sql
    157 INSERT INTO ticket_custom
    158    (ticket, name, value)
    159    SELECT
    160       id AS ticket,
    161       'request_source' AS name,
    162       'None' AS value
    163    FROM ticket
    164    WHERE id NOT IN (
    165       SELECT ticket FROM ticket_custom
    166    );
    167 }}}
    168 
    169 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:
    170 
    171 {{{
    172 #!sql
    173 INSERT INTO ticket_custom
    174    (ticket, name, value)
    175    SELECT
    176       id AS ticket,
    177       'request_source' AS name,
    178       'None' AS value
    179    FROM ticket
    180    WHERE id NOT IN (
    181       SELECT ticket FROM ticket_custom WHERE name = 'request_source'
    182    );
    183 }}}
     186you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    184187
    185188----