source: wiki/pages/TracTicketsCustomFields @ 29080

Last change on this file since 29080 was 26484, checked in by obi, 10 years ago

add wiki pages

File size: 5.7 KB
Line 
1= Custom Ticket Fields =
2Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
3
4== Configuration ==
5Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
6
7The syntax of each field definition is:
8{{{
9 FIELD_NAME = TYPE
10 (FIELD_NAME.OPTION = VALUE)
11 ...
12}}}
13The example below should help to explain the syntax.
14
15=== Available Field Types and Options ===
16 * '''text''': A simple (one line) text field.
17   * label: Descriptive label.
18   * value: Default value.
19   * order: Sort order placement. (Determines relative placement in forms with respect to other custom fields.)
20   * format: One of:
21     * `plain` for plain text
22     * `wiki` to interpret the content as WikiFormatting (''since 0.11.3'')
23     * `reference` to treat the content as a queryable value (''since 1.0'')
24     * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'')
25 * '''checkbox''': A boolean value check box.
26   * label: Descriptive label.
27   * value: Default value (0 or 1).
28   * order: Sort order placement.
29 * '''select''': Drop-down select box. Uses a list of values.
30   * label: Descriptive label.
31   * options: List of values, separated by '''|''' (vertical pipe).
32   * value: Default value (one of the values from options).
33   * order: Sort order placement.
34 * '''radio''': Radio buttons. Essentially the same as '''select'''.
35   * label: Descriptive label.
36   * options: List of values, separated by '''|''' (vertical pipe).
37   * value: Default value (one of the values from options).
38   * order: Sort order placement.
39 * '''textarea''': Multi-line text area.
40   * label: Descriptive label.
41   * value: Default text.
42   * cols: Width in columns.
43   * rows: Height in lines.
44   * order: Sort order placement.
45   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
46
47=== Sample Config ===
48{{{
49[ticket-custom]
50
51test_one = text
52test_one.label = Just a text box
53
54test_two = text
55test_two.label = Another text-box
56test_two.value = Default [mailto:joe@nospam.com owner]
57test_two.format = wiki
58
59test_three = checkbox
60test_three.label = Some checkbox
61test_three.value = 1
62
63test_four = select
64test_four.label = My selectbox
65test_four.options = one|two|third option|four
66test_four.value = two
67
68test_five = radio
69test_five.label = Radio buttons are fun
70test_five.options = uno|dos|tres|cuatro|cinco
71test_five.value = dos
72
73test_six = textarea
74test_six.label = This is a large textarea
75test_six.value = Default text
76test_six.cols = 60
77test_six.rows = 30
78}}}
79
80''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
81
82=== Reports Involving Custom Fields ===
83
84Custom 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`.
85
86{{{
87#!sql
88SELECT p.value AS __color__,
89   id AS ticket, summary, owner, c.value AS progress
90  FROM ticket t, enum p, ticket_custom c
91  WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
92AND p.name = t.priority AND p.type = 'priority'
93  ORDER BY p.value
94}}}
95'''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.
96
97However, 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.
98{{{
99#!sql
100SELECT p.value AS __color__,
101   id AS ticket, summary, component, version, milestone, severity,
102   (CASE status WHEN 'assigned' THEN owner||' *' ELSE owner END) AS owner,
103   time AS created,
104   changetime AS _changetime, description AS _description,
105   reporter AS _reporter,
106  (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
107  FROM ticket t
108     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
109     JOIN enum p ON p.name = t.priority AND p.type='priority'
110  WHERE status IN ('new', 'assigned', 'reopened')
111  ORDER BY p.value, milestone, severity, time
112}}}
113
114Note in particular the `LEFT OUTER JOIN` statement here.
115
116=== Updating the database ===
117
118As 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:
119
120{{{
121#!sql
122INSERT INTO ticket_custom
123   (ticket, name, value)
124   SELECT
125      id AS ticket,
126      'request_source' AS name,
127      'None' AS value
128   FROM ticket
129   WHERE id NOT IN (
130      SELECT ticket FROM ticket_custom
131   );
132}}}
133
134If you added multiple custom fields at different points in time, you should be more specific in the subquery on table {{{ticket}}} by adding the exact custom field name to the query:
135
136{{{
137#!sql
138INSERT INTO ticket_custom
139   (ticket, name, value)
140   SELECT
141      id AS ticket,
142      'request_source' AS name,
143      'None' AS value
144   FROM ticket
145   WHERE id NOT IN (
146      SELECT ticket FROM ticket_custom WHERE name = 'request_source'
147   );
148}}}
149
150----
151See also: TracTickets, TracIni
Note: See TracBrowser for help on using the repository browser.