Changes between Version 4 and Version 5 of TracTicketsCustomFields


Ignore:
Timestamp:
Nov 23, 2016, 6:53:44 AM (12 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v4 v5  
    1 = Custom Ticket Fields =
     1= Custom Ticket Fields
     2
    23Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
    34
    4 == Configuration ==
     5== Configuration
     6
    57Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
    68
     
    1113 ...
    1214}}}
     15
    1316The example below should help to explain the syntax.
    1417
    15 === Available Field Types and Options ===
     18=== Available Field Types and Options
     19
    1620 * '''text''': A simple (one line) text field.
    1721   * label: Descriptive label.
    1822   * value: Default value.
    19    * order: Sort order placement. (Determines relative placement in forms with respect to other custom fields.)
     23   * order: Sort order placement. Determines relative placement in forms with respect to other custom fields.
    2024   * format: One of:
    2125     * `plain` for plain text
     
    2529 * '''checkbox''': A boolean value check box.
    2630   * label: Descriptive label.
    27    * value: Default value (0 or 1).
     31   * value: Default value: 0 or 1.
    2832   * order: Sort order placement.
    2933 * '''select''': Drop-down select box. Uses a list of values.
     
    4751Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
    4852
    49 === Sample Config ===
    50 {{{
     53=== Sample Configuration
     54
     55{{{#!ini
    5156[ticket-custom]
    5257
     
    8085}}}
    8186
    82 ''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
     87'''Note''': To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
    8388
    84 === Reports Involving Custom Fields ===
     89=== Reports Involving Custom Fields
    8590
    8691Custom 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`.
    8792
    88 {{{
    89 #!sql
     93{{{#!sql
    9094SELECT p.value AS __color__,
    9195   id AS ticket, summary, owner, c.value AS progress
     
    9599  ORDER BY p.value
    96100}}}
    97 '''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.
    98101
    99 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.
    100 {{{
    101 #!sql
     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
     104However, 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
    102106SELECT p.value AS __color__,
    103107   id AS ticket, summary, component, version, milestone, severity,
     
    106110   changetime AS _changetime, description AS _description,
    107111   reporter AS _reporter,
    108   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     112   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    109113  FROM ticket t
    110114     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     
    116120Note in particular the `LEFT OUTER JOIN` statement here.
    117121
    118 Note that if your config file uses an uppercase name, e.g.,
    119 {{{
     122Note that if your config file uses an '''uppercase''' name:
     123{{{#!ini
    120124[ticket-custom]
    121125
    122126Progress_Type = text
    123127}}}
    124 you would use lowercase in the SQL:  `AND c.name = 'progress_type'`
     128you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    125129
    126 === Updating the database ===
     130=== Updating the database
    127131
    128 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:
     132As 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:
    129133
    130 {{{
    131 #!sql
     134{{{#!sql
    132135INSERT INTO ticket_custom
    133136   (ticket, name, value)
     
    144147If 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:
    145148
    146 {{{
    147 #!sql
     149{{{#!sql
    148150INSERT INTO ticket_custom
    149151   (ticket, name, value)