Edgewall Software

Changes between Initial Version and Version 1 of 1.5/TracTicketsCustomFields


Ignore:
Timestamp:
May 12, 2020, 7:25:55 PM (21 months ago)
Author:
Ryan J Ollos
Comment:

Copied from TracTicketsCustomFields@40.

Legend:

Unmodified
Added
Removed
Modified
  • 1.5/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
     6Configure 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=== 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
     52=== Available Field Types and Options
     53
     54 * '''text''': A simple (one line) text field.
     55   * label: Descriptive label.
     56   * value: Default value.
     57   * order: Sort order placement relative to other custom fields.
     58   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     59   * format: One of:
     60     * `plain` for plain text
     61     * `wiki` for [WikiFormatting wiki formatted] content
     62     * `reference` to treat the content as a queryable value
     63     * `list` to interpret the content as a list of queryable values, separated by whitespace
     64 * '''checkbox''': A boolean value check box.
     65   * label: Descriptive label.
     66   * value: Default value, 0 or 1.
     67   * order: Sort order placement.
     68 * '''select''': Drop-down select box. Uses a list of values.
     69   * label: Descriptive label.
     70   * options: List of values, separated by '''|''' (vertical pipe).
     71   * value: Default value (one of the values from options).
     72   * order: Sort order placement.
     73 * '''radio''': Radio buttons. Essentially the same as '''select'''.
     74   * label: Descriptive label.
     75   * options: List of values, separated by '''|''' (vertical pipe).
     76   * value: Default value, one of the values from options.
     77   * order: Sort order placement.
     78 * '''textarea''': Multi-line text area.
     79   * label: Descriptive label.
     80   * value: Default text.
     81   * rows: Height in lines.
     82   * order: Sort order placement.
     83   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     84   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     85 * '''time''': Date and time picker. (//Since 1.1.1//)
     86   * label: Descriptive label.
     87   * value: Default date.
     88   * order: Sort order placement.
     89   * format: One of:
     90     * `relative` for relative dates.
     91     * `date` for absolute dates.
     92     * `datetime` for absolute date and time values.
     93
     94If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
     95
     96Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     97
     98=== Sample Configuration
     99
     100{{{#!ini
     101[ticket-custom]
     102
     103test_one = text
     104test_one.label = Just a text box
     105
     106test_two = text
     107test_two.label = Another text-box
     108test_two.value = Default [mailto:joe@nospam.com owner]
     109test_two.format = wiki
     110
     111test_three = checkbox
     112test_three.label = Some checkbox
     113test_three.value = 1
     114
     115test_four = select
     116test_four.label = My selectbox
     117test_four.options = one|two|third option|four
     118test_four.value = two
     119
     120test_five = radio
     121test_five.label = Radio buttons are fun
     122test_five.options = |uno|dos|tres|cuatro|cinco
     123test_five.value = dos
     124
     125test_six = textarea
     126test_six.label = This is a large textarea
     127test_six.value = Default text
     128test_six.cols = 60
     129test_six.rows = 30
     130
     131test_seven = time
     132test_seven.label = A relative date
     133test_seven.format = relative
     134test_seven.value = now
     135
     136test_eight = time
     137test_eight.label = An absolute date
     138test_eight.format = date
     139test_eight.value = yesterday
     140
     141test_nine = time
     142test_nine.label = A date and time
     143test_nine.format = datetime
     144test_nine.value = in 2 hours
     145}}}
     146
     147'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
     148
     149=== Reports Involving Custom Fields
     150
     151Custom 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`.
     152
     153{{{#!sql
     154SELECT p.value AS __color__,
     155   id AS ticket, summary, owner, c.value AS progress
     156  FROM ticket t, enum p, ticket_custom c
     157  WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
     158AND p.name = t.priority AND p.type = 'priority'
     159  ORDER BY p.value
     160}}}
     161'''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.
     162
     163However, 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:
     164{{{#!sql
     165SELECT p.value AS __color__,
     166   id AS ticket, summary, component, version, milestone, severity,
     167   (CASE status WHEN 'assigned' THEN owner||' *' ELSE owner END) AS owner,
     168   time AS created,
     169   changetime AS _changetime, description AS _description,
     170   reporter AS _reporter,
     171   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     172  FROM ticket t
     173     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     174     JOIN enum p ON p.name = t.priority AND p.type='priority'
     175  WHERE status IN ('new', 'assigned', 'reopened')
     176  ORDER BY p.value, milestone, severity, time
     177}}}
     178
     179Note in particular the `LEFT OUTER JOIN` statement here.
     180
     181Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
     182{{{#!ini
     183[ticket-custom]
     184Progress_Type = text
     185}}}
     186you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
     187
     188----
     189See also: TracTickets, TracIni