Changes between Version 2 and Version 3 of TracTicketsCustomFields
- Timestamp:
- Apr 24, 2020, 9:10:26 AM (5 years 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 == 4 == Configuration 5 5 6 Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`. 6 7 … … 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.)57 * order: Sort order placement; this determines relative placement in forms with respect to other custom fields. 20 58 * format: One of: 21 59 * `plain` for plain text 22 * `wiki` to interpret the content as WikiFormatting (''since 0.11.3'')60 * `wiki` to interpret the content as WikiFormatting 23 61 * `reference` to treat the content as a queryable value (''since 1.0'') 24 62 * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'') 25 63 * '''checkbox''': A boolean value check box. 26 64 * label: Descriptive label. 27 * value: Default value (0 or 1).65 * value: Default value, 0 or 1. 28 66 * order: Sort order placement. 29 67 * '''select''': Drop-down select box. Uses a list of values. … … 35 73 * label: Descriptive label. 36 74 * options: List of values, separated by '''|''' (vertical pipe). 37 * value: Default value (one of the values from options).75 * value: Default value, one of the values from options. 38 76 * order: Sort order placement. 39 77 * '''textarea''': Multi-line text area. 40 78 * label: Descriptive label. 41 79 * value: Default text. 42 * cols: Width in columns. 80 * cols: Width in columns. //(Removed in 1.1.2)// 43 81 * rows: Height in lines. 44 82 * order: Sort order placement. 45 * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'') 83 * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. 84 * '''time''': Date and time picker. (''Since 1.1.1.'') 85 * label: Descriptive label. 86 * value: Default date. 87 * order: Sort order placement. 88 * format: One of: 89 * `relative` for relative dates. 90 * `date` for absolute dates. 91 * `datetime` for absolute date and time values. 46 92 47 === Sample Config === 48 {{{ 93 If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces. 94 95 Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`. 96 97 === Sample Configuration 98 99 {{{#!ini 49 100 [ticket-custom] 50 101 … … 76 127 test_six.cols = 60 77 128 test_six.rows = 30 129 130 test_seven = time 131 test_seven.label = A relative date 132 test_seven.format = relative 133 test_seven.value = now 134 135 test_eight = time 136 test_eight.label = An absolute date 137 test_eight.format = date 138 test_eight.value = yesterday 139 140 test_nine = time 141 test_nine.label = A date and time 142 test_nine.format = datetime 143 test_nine.value = in 2 hours 78 144 }}} 79 145 80 '' Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''146 '''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option. 81 147 82 === Reports Involving Custom Fields ===148 === Reports Involving Custom Fields 83 149 84 150 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`. 85 151 86 {{{ 87 #!sql 152 {{{#!sql 88 153 SELECT p.value AS __color__, 89 154 id AS ticket, summary, owner, c.value AS progress … … 93 158 ORDER BY p.value 94 159 }}} 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.160 '''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. 96 161 97 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. 98 {{{ 99 #!sql 162 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: 163 {{{#!sql 100 164 SELECT p.value AS __color__, 101 165 id AS ticket, summary, component, version, milestone, severity, … … 104 168 changetime AS _changetime, description AS _description, 105 169 reporter AS _reporter, 106 (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress170 (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress 107 171 FROM ticket t 108 172 LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress') … … 114 178 Note in particular the `LEFT OUTER JOIN` statement here. 115 179 116 === Updating the database === 180 Note that if your config file uses an '''uppercase''' name: 181 {{{#!ini 182 [ticket-custom] 117 183 118 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: 119 120 {{{ 121 #!sql 122 INSERT 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 ); 184 Progress_Type = text 132 185 }}} 133 134 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: 135 136 {{{ 137 #!sql 138 INSERT 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 }}} 186 you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`. 149 187 150 188 ----