Changes between Version 2 and Version 3 of TracTicketsCustomFields
- Timestamp:
- Jun 2, 2023 10:32:55 AM (18 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracTicketsCustomFields
v2 v3 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.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 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]`. 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: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'') 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 21 64 * '''checkbox''': A boolean value check box. 22 65 * label: Descriptive label. 23 * value: Default value (0 or 1).66 * value: Default value, 0 or 1. 24 67 * order: Sort order placement. 25 68 * '''select''': Drop-down select box. Uses a list of values. … … 31 74 * label: Descriptive label. 32 75 * options: List of values, separated by '''|''' (vertical pipe). 33 * value: Default value (one of the values from options).76 * value: Default value, one of the values from options. 34 77 * order: Sort order placement. 35 78 * '''textarea''': Multi-line text area. 36 79 * label: Descriptive label. 37 80 * value: Default text. 38 * cols: Width in columns.39 81 * rows: Height in lines. 40 82 * order: Sort order placement. 41 * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'') 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. 42 93 43 === Sample Config === 44 {{{ 94 If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces. 95 96 Macros 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 45 101 [ticket-custom] 46 102 … … 64 120 test_five = radio 65 121 test_five.label = Radio buttons are fun 66 test_five.options = uno|dos|tres|cuatro|cinco122 test_five.options = |uno|dos|tres|cuatro|cinco 67 123 test_five.value = dos 68 124 … … 72 128 test_six.cols = 60 73 129 test_six.rows = 30 130 131 test_seven = time 132 test_seven.label = A relative date 133 test_seven.format = relative 134 test_seven.value = now 135 136 test_eight = time 137 test_eight.label = An absolute date 138 test_eight.format = date 139 test_eight.value = yesterday 140 141 test_nine = time 142 test_nine.label = A date and time 143 test_nine.format = datetime 144 test_nine.value = in 2 hours 74 145 }}} 75 146 76 '' Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''147 '''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`). 77 148 78 === Reports Involving Custom Fields ===149 === Reports Involving Custom Fields 79 150 80 151 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`. 81 152 82 {{{ 83 #!sql 153 {{{#!sql 84 154 SELECT p.value AS __color__, 85 155 id AS ticket, summary, owner, c.value AS progress … … 89 159 ORDER BY p.value 90 160 }}} 91 '''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.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. 92 162 93 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. 94 {{{ 95 #!sql 163 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: 164 {{{#!sql 96 165 SELECT p.value AS __color__, 97 166 id AS ticket, summary, component, version, milestone, severity, … … 100 169 changetime AS _changetime, description AS _description, 101 170 reporter AS _reporter, 102 (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress171 (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress 103 172 FROM ticket t 104 173 LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress') … … 110 179 Note in particular the `LEFT OUTER JOIN` statement here. 111 180 112 === Updating the database === 113 114 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: 115 116 {{{ 117 #!sql 118 INSERT INTO ticket_custom 119 (ticket, name, value) 120 SELECT 121 id AS ticket, 122 'request_source' AS name, 123 'None' AS value 124 FROM ticket 125 WHERE id NOT IN ( 126 SELECT ticket FROM ticket_custom 127 ); 181 Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters: 182 {{{#!ini 183 [ticket-custom] 184 Progress_Type = text 128 185 }}} 129 130 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: 131 132 {{{ 133 #!sql 134 INSERT INTO ticket_custom 135 (ticket, name, value) 136 SELECT 137 id AS ticket, 138 'request_source' AS name, 139 'None' AS value 140 FROM ticket 141 WHERE id NOT IN ( 142 SELECT ticket FROM ticket_custom WHERE name = 'request_source' 143 ); 144 }}} 186 you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`. 145 187 146 188 ----
