Changes between Version 5 and Version 6 of TracTicketsCustomFields


Ignore:
Timestamp:
Jan 12, 2016, 11:21:52 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v5 v6  
    1 = Custom Ticket Fields
    2 
     1= Custom Ticket Fields =
    32Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
    43
    5 == Configuration
    6 
     4== Configuration ==
    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
    18 === Available Field Types and Options
    19 
     15=== Available Field Types and Options ===
    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. (Determines relative placement in forms with respect to other custom fields.)
    2420   * format: One of:
    2521     * `plain` for plain text
    26      * `wiki` to interpret the content as WikiFormatting
     22     * `wiki` to interpret the content as WikiFormatting (''since 0.11.3'')
    2723     * `reference` to treat the content as a queryable value (''since 1.0'')
    2824     * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'')
    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.
     
    4440   * label: Descriptive label.
    4541   * value: Default text.
    46    * cols: Width in columns
     42   * cols: Width in columns.
    4743   * rows: Height in lines.
    4844   * order: Sort order placement.
    49    * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     45   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
    5046
    51 Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
    52 
    53 === Sample Configuration
    54 
    55 {{{#!ini
     47=== Sample Config ===
     48{{{
    5649[ticket-custom]
    5750
     
    8578}}}
    8679
    87 '''Note''': To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
     80''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
    8881
    89 === Reports Involving Custom Fields
     82=== Reports Involving Custom Fields ===
    9083
    9184Custom 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`.
    9285
    93 {{{#!sql
     86{{{
     87#!sql
    9488SELECT p.value AS __color__,
    9589   id AS ticket, summary, owner, c.value AS progress
     
    9993  ORDER BY p.value
    10094}}}
     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.
    10196
    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.
    103 
    104 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:
    105 {{{#!sql
     97However, 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
    106100SELECT p.value AS __color__,
    107101   id AS ticket, summary, component, version, milestone, severity,
     
    110104   changetime AS _changetime, description AS _description,
    111105   reporter AS _reporter,
    112    (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     106  (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    113107  FROM ticket t
    114108     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     
    120114Note in particular the `LEFT OUTER JOIN` statement here.
    121115
    122 Note that if your config file uses an '''uppercase''' name:
    123 {{{#!ini
    124 [ticket-custom]
     116=== Updating the database ===
    125117
    126 Progress_Type = text
    127 }}}
    128 you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
     118As 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:
    129119
    130 === Updating the database
    131 
    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:
    133 
    134 {{{#!sql
     120{{{
     121#!sql
    135122INSERT INTO ticket_custom
    136123   (ticket, name, value)
     
    147134If 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:
    148135
    149 {{{#!sql
     136{{{
     137#!sql
    150138INSERT INTO ticket_custom
    151139   (ticket, name, value)