Changes between Version 4 and Version 5 of TracTicketsCustomFields


Ignore:
Timestamp:
Nov 20, 2019, 10:04:31 AM (11 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
     
    1615The example below should help to explain the syntax.
    1716
     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
    1852=== Available Field Types and Options
    1953
     
    2155   * label: Descriptive label.
    2256   * value: Default value.
    23    * order: Sort order placement. Determines relative placement in forms with respect to other custom fields.
     57   * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
    2458   * format: One of:
    2559     * `plain` for plain text
     
    2963 * '''checkbox''': A boolean value check box.
    3064   * label: Descriptive label.
    31    * value: Default value: 0 or 1.
     65   * value: Default value, 0 or 1.
    3266   * order: Sort order placement.
    3367 * '''select''': Drop-down select box. Uses a list of values.
     
    3973   * label: Descriptive label.
    4074   * options: List of values, separated by '''|''' (vertical pipe).
    41    * value: Default value (one of the values from options).
     75   * value: Default value, one of the values from options.
    4276   * order: Sort order placement.
    4377 * '''textarea''': Multi-line text area.
    4478   * label: Descriptive label.
    4579   * value: Default text.
    46    * cols: Width in columns
     80   * cols: Width in columns. //(Removed in 1.1.2)//
    4781   * rows: Height in lines.
    4882   * order: Sort order placement.
    4983   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     84 * '''time''': Date and time picker. (''Since 1.1.1.'')
     85   * label: Descriptive label.
     86   * value: Default date.
     87   * order: Sort order placement.
     88   * format: One of:
     89     * `relative` for relative dates.
     90     * `date` for absolute dates.
     91     * `datetime` for absolute date and time values.
     92
     93If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
    5094
    5195Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     
    83127test_six.cols = 60
    84128test_six.rows = 30
     129
     130test_seven = time
     131test_seven.label = A relative date
     132test_seven.format = relative
     133test_seven.value = now
     134
     135test_eight = time
     136test_eight.label = An absolute date
     137test_eight.format = date
     138test_eight.value = yesterday
     139
     140test_nine = time
     141test_nine.label = A date and time
     142test_nine.format = datetime
     143test_nine.value = in 2 hours
    85144}}}
    86145
    87 '''Note''': To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
     146'''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
    88147
    89148=== Reports Involving Custom Fields
     
    99158  ORDER BY p.value
    100159}}}
    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.
     160'''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.
    103161
    104162However, 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:
     
    128186you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    129187
    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
    135 INSERT INTO ticket_custom
    136    (ticket, name, value)
    137    SELECT
    138       id AS ticket,
    139       'request_source' AS name,
    140       'None' AS value
    141    FROM ticket
    142    WHERE id NOT IN (
    143       SELECT ticket FROM ticket_custom
    144    );
    145 }}}
    146 
    147 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:
    148 
    149 {{{#!sql
    150 INSERT INTO ticket_custom
    151    (ticket, name, value)
    152    SELECT
    153       id AS ticket,
    154       'request_source' AS name,
    155       'None' AS value
    156    FROM ticket
    157    WHERE id NOT IN (
    158       SELECT ticket FROM ticket_custom WHERE name = 'request_source'
    159    );
    160 }}}
    161 
    162188----
    163189See also: TracTickets, TracIni