![(please configure the [header_logo] section in trac.ini)](/chrome/site/cardinal.gif)
Changes between Version 4 and Version 5 of TracTicketsCustomFields
- Timestamp:
- 04/19/23 14:06:21 (20 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracTicketsCustomFields
v4 v5 1 = Custom Ticket Fields = 2 Trac 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 == 5 Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`. 1 = Custom Ticket Fields 2 Trac 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 6 Configure custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini. 6 7 7 8 The syntax of each field definition is: … … 11 12 ... 12 13 }}} 14 13 15 The example below should help to explain the syntax. 14 16 15 === Available Field Types and Options === 17 === Field Names 18 A 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 20 The 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 16 54 * '''text''': A simple (one line) text field. 17 55 * label: Descriptive label. 18 56 * 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 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'') 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 * ticketlink_query: Query for linkifying ticket values. 65 Not applicable for format `plain` and `wiki`. 25 66 * '''checkbox''': A boolean value check box. 26 67 * label: Descriptive label. 27 * value: Default value (0 or 1). 28 * order: Sort order placement. 68 * value: Default value, 0 or 1. 69 * order: Sort order placement. 70 * ticketlink_query: Query for linkifying ticket values. 29 71 * '''select''': Drop-down select box. Uses a list of values. 30 72 * label: Descriptive label. … … 32 74 * value: Default value (one of the values from options). 33 75 * order: Sort order placement. 76 * ticketlink_query: Query for linkifying ticket values. 34 77 * '''radio''': Radio buttons. Essentially the same as '''select'''. 35 78 * label: Descriptive label. 36 79 * options: List of values, separated by '''|''' (vertical pipe). 37 * value: Default value (one of the values from options). 38 * order: Sort order placement. 80 * value: Default value, one of the values from options. 81 * order: Sort order placement. 82 * ticketlink_query: Query for linkifying ticket values. 39 83 * '''textarea''': Multi-line text area. 40 84 * label: Descriptive label. 41 85 * value: Default text. 42 * cols: Width in columns43 86 * rows: Height in lines. 44 87 * order: Sort order placement. 88 * max_size: Maximum allowed size in characters (//Since 1.3.2//). 45 89 * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. 90 * '''time''': Date and time picker. (//Since 1.1.1//) 91 * label: Descriptive label. 92 * value: Default date. 93 * order: Sort order placement. 94 * format: One of: 95 * `relative` for relative dates. 96 * `date` for absolute dates. 97 * `datetime` for absolute date and time values. 98 99 If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces. 46 100 47 101 Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`. 48 102 49 === Sample Config === 50 {{{ 103 For applicable fields, the `ticketlink_query` option 104 overrides [[TracIni#query-ticketlink_query-option|"[query] ticketlink_query"]], and the format is the same as 105 that option. When the `ticketlink_query` option 106 is not specified, `[query]` `ticketlink_query` is used to 107 linkify the field. 108 109 === Sample Configuration 110 111 {{{#!ini 51 112 [ticket-custom] 52 113 … … 70 131 test_five = radio 71 132 test_five.label = Radio buttons are fun 72 test_five.options = uno|dos|tres|cuatro|cinco133 test_five.options = |uno|dos|tres|cuatro|cinco 73 134 test_five.value = dos 74 135 … … 78 139 test_six.cols = 60 79 140 test_six.rows = 30 80 }}} 81 82 ''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.'' 83 84 === Reports Involving Custom Fields === 141 142 test_seven = time 143 test_seven.label = A relative date 144 test_seven.format = relative 145 test_seven.value = now 146 147 test_eight = time 148 test_eight.label = An absolute date 149 test_eight.format = date 150 test_eight.value = yesterday 151 152 test_nine = time 153 test_nine.label = A date and time 154 test_nine.format = datetime 155 test_nine.value = in 2 hours 156 }}} 157 158 '''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`). 159 160 === Reports Involving Custom Fields 85 161 86 162 Custom 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`. 87 163 88 {{{ 89 #!sql 164 {{{#!sql 90 165 SELECT p.value AS __color__, 91 166 id AS ticket, summary, owner, c.value AS progress … … 95 170 ORDER BY p.value 96 171 }}} 97 '''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. 98 99 However, 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. 100 {{{ 101 #!sql 172 '''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. 173 174 However, 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: 175 {{{#!sql 102 176 SELECT p.value AS __color__, 103 177 id AS ticket, summary, component, version, milestone, severity, … … 106 180 changetime AS _changetime, description AS _description, 107 181 reporter AS _reporter, 108 (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress182 (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress 109 183 FROM ticket t 110 184 LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress') … … 116 190 Note in particular the `LEFT OUTER JOIN` statement here. 117 191 118 Note that if your config file uses an uppercase name, e.g.,119 {{{ 192 Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters: 193 {{{#!ini 120 194 [ticket-custom] 121 122 195 Progress_Type = text 123 196 }}} 124 you would use lowercase in the SQL: `AND c.name = 'progress_type'` 125 126 === Updating the database === 127 128 As 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: 129 130 {{{ 131 #!sql 132 INSERT INTO ticket_custom 133 (ticket, name, value) 134 SELECT 135 id AS ticket, 136 'request_source' AS name, 137 'None' AS value 138 FROM ticket 139 WHERE id NOT IN ( 140 SELECT ticket FROM ticket_custom 141 ); 142 }}} 143 144 If 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: 145 146 {{{ 147 #!sql 148 INSERT INTO ticket_custom 149 (ticket, name, value) 150 SELECT 151 id AS ticket, 152 'request_source' AS name, 153 'None' AS value 154 FROM ticket 155 WHERE id NOT IN ( 156 SELECT ticket FROM ticket_custom WHERE name = 'request_source' 157 ); 158 }}} 197 you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`. 159 198 160 199 ----
