Changes between Initial Version and Version 1 of TracTicketsCustomFields


Ignore:
Timestamp:
Sep 2, 2019, 11:30:15 AM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v1 v1  
     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.
     3
     4== Configuration
     5
     6Configuring custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini.
     7
     8The syntax of each field definition is:
     9{{{
     10 FIELD_NAME = TYPE
     11 (FIELD_NAME.OPTION = VALUE)
     12 ...
     13}}}
     14
     15The example below should help to explain the syntax.
     16
     17=== Available Field Types and Options
     18
     19 * '''text''': A simple (one line) text field.
     20   * label: Descriptive label.
     21   * value: Default value.
     22   * order: Sort order placement relative to other custom fields.
     23   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     24   * format: One of:
     25     * `plain` for plain text
     26     * `wiki` for [WikiFormatting wiki formatted] content
     27     * `reference` to treat the content as a queryable value
     28     * `list` to interpret the content as a list of queryable values, separated by whitespace
     29 * '''checkbox''': A boolean value check box.
     30   * label: Descriptive label.
     31   * value: Default value, 0 or 1.
     32   * order: Sort order placement.
     33 * '''select''': Drop-down select box. Uses a list of values.
     34   * label: Descriptive label.
     35   * options: List of values, separated by '''|''' (vertical pipe).
     36   * value: Default value (one of the values from options).
     37   * order: Sort order placement.
     38 * '''radio''': Radio buttons. Essentially the same as '''select'''.
     39   * label: Descriptive label.
     40   * options: List of values, separated by '''|''' (vertical pipe).
     41   * value: Default value, one of the values from options.
     42   * order: Sort order placement.
     43 * '''textarea''': Multi-line text area.
     44   * label: Descriptive label.
     45   * value: Default text.
     46   * rows: Height in lines.
     47   * order: Sort order placement.
     48   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     49   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     50 * '''time''': Date and time picker. (//Since 1.1.1//)
     51   * label: Descriptive label.
     52   * value: Default date.
     53   * order: Sort order placement.
     54   * format: One of:
     55     * `relative` for relative dates.
     56     * `date` for absolute dates.
     57     * `datetime` for absolute date and time values.
     58
     59If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
     60
     61Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     62
     63=== Sample Configuration
     64
     65{{{#!ini
     66[ticket-custom]
     67
     68test_one = text
     69test_one.label = Just a text box
     70
     71test_two = text
     72test_two.label = Another text-box
     73test_two.value = Default [mailto:joe@nospam.com owner]
     74test_two.format = wiki
     75
     76test_three = checkbox
     77test_three.label = Some checkbox
     78test_three.value = 1
     79
     80test_four = select
     81test_four.label = My selectbox
     82test_four.options = one|two|third option|four
     83test_four.value = two
     84
     85test_five = radio
     86test_five.label = Radio buttons are fun
     87test_five.options = |uno|dos|tres|cuatro|cinco
     88test_five.value = dos
     89
     90test_six = textarea
     91test_six.label = This is a large textarea
     92test_six.value = Default text
     93test_six.cols = 60
     94test_six.rows = 30
     95
     96test_seven = time
     97test_seven.label = A relative date
     98test_seven.format = relative
     99test_seven.value = now
     100
     101test_eight = time
     102test_eight.label = An absolute date
     103test_eight.format = date
     104test_eight.value = yesterday
     105
     106test_nine = time
     107test_nine.label = A date and time
     108test_nine.format = datetime
     109test_nine.value = in 2 hours
     110}}}
     111
     112'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
     113
     114=== Reports Involving Custom Fields
     115
     116Custom 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`.
     117
     118{{{#!sql
     119SELECT p.value AS __color__,
     120   id AS ticket, summary, owner, c.value AS progress
     121  FROM ticket t, enum p, ticket_custom c
     122  WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
     123AND p.name = t.priority AND p.type = 'priority'
     124  ORDER BY p.value
     125}}}
     126'''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.
     127
     128However, 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:
     129{{{#!sql
     130SELECT p.value AS __color__,
     131   id AS ticket, summary, component, version, milestone, severity,
     132   (CASE status WHEN 'assigned' THEN owner||' *' ELSE owner END) AS owner,
     133   time AS created,
     134   changetime AS _changetime, description AS _description,
     135   reporter AS _reporter,
     136   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     137  FROM ticket t
     138     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     139     JOIN enum p ON p.name = t.priority AND p.type='priority'
     140  WHERE status IN ('new', 'assigned', 'reopened')
     141  ORDER BY p.value, milestone, severity, time
     142}}}
     143
     144Note in particular the `LEFT OUTER JOIN` statement here.
     145
     146Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
     147{{{#!ini
     148[ticket-custom]
     149Progress_Type = text
     150}}}
     151you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
     152
     153----
     154See also: TracTickets, TracIni