Changes between Version 5 and Version 6 of TracTicketsCustomFields


Ignore:
Timestamp:
2017-03-15T14:23:23-07:00 (8 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v5 v6  
    1 = Custom Ticket Fields =
    2 Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
     1= Custom Ticket Fields
     2Trac supports adding custom, user-defined fields to the ticket module. With custom fields you can add typed, site-specific properties to tickets.
    33
    4 == Configuration ==
     4== Configuration
    55Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
    66
     
    1313The example below should help to explain the syntax.
    1414
    15 === Available Field Types and Options ===
     15=== Available Field Types and Options
    1616 * '''text''': A simple (one line) text field.
    1717   * label: Descriptive label.
    1818   * value: Default value.
    19    * 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.
    2020   * format: One of:
    2121     * `plain` for plain text
    22      * `wiki` to interpret the content as WikiFormatting (''since 0.11.3'')
     22     * `wiki` to interpret the content as WikiFormatting
    2323     * `reference` to treat the content as a queryable value (''since 1.0'')
    2424     * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'')
    2525 * '''checkbox''': A boolean value check box.
    2626   * label: Descriptive label.
    27    * value: Default value (0 or 1).
     27   * value: Default value, 0 or 1.
    2828   * order: Sort order placement.
    2929 * '''select''': Drop-down select box. Uses a list of values.
     
    3535   * label: Descriptive label.
    3636   * options: List of values, separated by '''|''' (vertical pipe).
    37    * value: Default value (one of the values from options).
     37   * value: Default value, one of the values from options.
    3838   * order: Sort order placement.
    3939 * '''textarea''': Multi-line text area.
    4040   * label: Descriptive label.
    4141   * value: Default text.
    42    * cols: Width in columns
     42   * cols: Width in columns. //(Removed in 1.1.2)//
    4343   * rows: Height in lines.
    4444   * order: Sort order placement.
    45    * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
     45   * 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.
    4656
    4757Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
    4858
    49 === Sample Config ===
     59=== Sample Config
    5060{{{
    5161[ticket-custom]
     
    7888test_six.cols = 60
    7989test_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
    80105}}}
    81106
    82 ''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.
    83108
    84 === Reports Involving Custom Fields ===
     109=== Reports Involving Custom Fields
    85110
    86111Custom 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`.
     
    95120  ORDER BY p.value
    96121}}}
    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.
     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.
    98123
    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.
     124However, 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:
    100125{{{
    101126#!sql
     
    122147Progress_Type = text
    123148}}}
    124 you would use lowercase in the SQL:  `AND c.name = 'progress_type'`
     149you would use lowercase in the SQL: `AND c.name = 'progress_type'`
    125150
    126 === Updating the database ===
     151=== Updating the database
    127152
    128153As 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: