![[ DeepNet IP Database ]](/images/ipdb-logo.png){kind=logo}
Changes between Version 3 and Version 4 of TracTicketsCustomFields
- Timestamp:
- 03/24/24 16:57:49 (9 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracTicketsCustomFields
v3 v4 3 3 4 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]`. 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 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 15 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; 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'') 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 68 * value: Default value, 0 or 1. 28 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. … … 37 80 * value: Default value, one of the values from options. 38 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 columns. //(Removed in 1.1.2)//43 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. 46 * '''time''': Date and time picker. ( ''Since 1.1.1.'')90 * '''time''': Date and time picker. (//Since 1.1.1//) 47 91 * label: Descriptive label. 48 92 * value: Default date. … … 57 101 Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`. 58 102 59 === Sample Config 60 {{{ 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 61 112 [ticket-custom] 62 113 … … 80 131 test_five = radio 81 132 test_five.label = Radio buttons are fun 82 test_five.options = uno|dos|tres|cuatro|cinco133 test_five.options = |uno|dos|tres|cuatro|cinco 83 134 test_five.value = dos 84 135 … … 105 156 }}} 106 157 107 '''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.158 '''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`). 108 159 109 160 === Reports Involving Custom Fields … … 111 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`. 112 163 113 {{{ 114 #!sql 164 {{{#!sql 115 165 SELECT p.value AS __color__, 116 166 id AS ticket, summary, owner, c.value AS progress … … 123 173 124 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: 125 {{{ 126 #!sql 175 {{{#!sql 127 176 SELECT p.value AS __color__, 128 177 id AS ticket, summary, component, version, milestone, severity, … … 131 180 changetime AS _changetime, description AS _description, 132 181 reporter AS _reporter, 133 (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 134 183 FROM ticket t 135 184 LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress') … … 141 190 Note in particular the `LEFT OUTER JOIN` statement here. 142 191 143 Note that if your config file uses an uppercase name, e.g.,144 {{{ 192 Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters: 193 {{{#!ini 145 194 [ticket-custom] 146 147 195 Progress_Type = text 148 196 }}} 149 you would use lowercase in the SQL: `AND c.name = 'progress_type'` 150 151 === Updating the database 152 153 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: 154 155 {{{ 156 #!sql 157 INSERT 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 169 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: 170 171 {{{ 172 #!sql 173 INSERT 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 }}} 197 you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`. 184 198 185 199 ----
