Changes between Initial Version and Version 1 of TracTicketsCustomFields


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