Edgewall Software

Changes between Version 8 and Version 9 of 1.1/TracTicketsCustomFields


Ignore:
Timestamp:
Jan 13, 2015, 7:14:29 PM (5 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • 1.1/TracTicketsCustomFields

    v8 v9  
    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
     
    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.
     
    4444   * order: Sort order placement.
    4545   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
    46  * '''time''': Date (& time) picker. (''Since 1.1.1.'')
     46 * '''time''': Date and time picker. (''Since 1.1.1.'')
    4747   * label: Descriptive label.
    4848   * value: Default date.
     
    5353     * `datetime` for absolute date and time values.
    5454
    55 If the `label` is not specified it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
     55If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
    5656
    5757Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
    5858
    59 === Sample Config ===
     59=== Sample Config
    6060{{{
    6161[ticket-custom]
     
    105105}}}
    106106
    107 ''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.
    108108
    109 === Reports Involving Custom Fields ===
     109=== Reports Involving Custom Fields
    110110
    111111Custom 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`.
     
    120120  ORDER BY p.value
    121121}}}
    122 '''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.
    123123
    124 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:
    125125{{{
    126126#!sql
     
    147147Progress_Type = text
    148148}}}
    149 you would use lowercase in the SQL:  `AND c.name = 'progress_type'`
     149you would use lowercase in the SQL: `AND c.name = 'progress_type'`
    150150
    151 === Updating the database ===
     151=== Updating the database
    152152
    153153As 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: