source: wiki/pages/TracTicketsCustomFields @ 43267

Last change on this file since 43267 was 40558, checked in by obi, 2 years ago

reset wiki

File size: 6.6 KB
Line 
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
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; this 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
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. //(Removed in 1.1.2)//
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.
46 * '''time''': Date and time picker. (''Since 1.1.1.'')
47   * label: Descriptive label.
48   * value: Default date.
49   * order: Sort order placement.
50   * format: One of:
51     * `relative` for relative dates.
52     * `date` for absolute dates.
53     * `datetime` for absolute date and time values.
54
55If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
56
57Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
58
59=== Sample Config
60{{{
61[ticket-custom]
62
63test_one = text
64test_one.label = Just a text box
65
66test_two = text
67test_two.label = Another text-box
68test_two.value = Default [mailto:joe@nospam.com owner]
69test_two.format = wiki
70
71test_three = checkbox
72test_three.label = Some checkbox
73test_three.value = 1
74
75test_four = select
76test_four.label = My selectbox
77test_four.options = one|two|third option|four
78test_four.value = two
79
80test_five = radio
81test_five.label = Radio buttons are fun
82test_five.options = uno|dos|tres|cuatro|cinco
83test_five.value = dos
84
85test_six = textarea
86test_six.label = This is a large textarea
87test_six.value = Default text
88test_six.cols = 60
89test_six.rows = 30
90
91test_seven = time
92test_seven.label = A relative date
93test_seven.format = relative
94test_seven.value = now
95
96test_eight = time
97test_eight.label = An absolute date
98test_eight.format = date
99test_eight.value = yesterday
100
101test_nine = time
102test_nine.label = A date and time
103test_nine.format = datetime
104test_nine.value = in 2 hours
105}}}
106
107'''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
108
109=== Reports Involving Custom Fields
110
111Custom 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`.
112
113{{{
114#!sql
115SELECT p.value AS __color__,
116   id AS ticket, summary, owner, c.value AS progress
117  FROM ticket t, enum p, ticket_custom c
118  WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
119AND p.name = t.priority AND p.type = 'priority'
120  ORDER BY p.value
121}}}
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.
123
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:
125{{{
126#!sql
127SELECT p.value AS __color__,
128   id AS ticket, summary, component, version, milestone, severity,
129   (CASE status WHEN 'assigned' THEN owner||' *' ELSE owner END) AS owner,
130   time AS created,
131   changetime AS _changetime, description AS _description,
132   reporter AS _reporter,
133  (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
134  FROM ticket t
135     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
136     JOIN enum p ON p.name = t.priority AND p.type='priority'
137  WHERE status IN ('new', 'assigned', 'reopened')
138  ORDER BY p.value, milestone, severity, time
139}}}
140
141Note in particular the `LEFT OUTER JOIN` statement here.
142
143Note that if your config file uses an uppercase name, e.g.,
144{{{
145[ticket-custom]
146
147Progress_Type = text
148}}}
149you would use lowercase in the SQL: `AND c.name = 'progress_type'`
150
151=== Updating the database
152
153As 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:
154
155{{{
156#!sql
157INSERT INTO ticket_custom
158   (ticket, name, value)
159   SELECT 
160      id AS ticket,
161      'request_source' AS name,
162      'None' AS value
163   FROM ticket
164   WHERE id NOT IN (
165      SELECT ticket FROM ticket_custom
166   );
167}}}
168
169If 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:
170
171{{{
172#!sql
173INSERT INTO ticket_custom
174   (ticket, name, value)
175   SELECT 
176      id AS ticket,
177      'request_source' AS name,
178      'None' AS value
179   FROM ticket
180   WHERE id NOT IN (
181      SELECT ticket FROM ticket_custom WHERE name = 'request_source'
182   );
183}}}
184
185----
186See also: TracTickets, TracIni
Note: See TracBrowser for help on using the repository browser.