Changes between Version 3 and Version 4 of TracTicketsCustomFields
- Timestamp:
- Sep 20, 2017, 9:08:46 AM (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracTicketsCustomFields
v3 v4 3 3 4 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 17 === Available Field Types and Options 18 16 19 * '''text''': A simple (one line) text field. 17 20 * label: Descriptive label. … … 57 60 Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`. 58 61 59 === Sample Config 60 {{{ 62 === Sample Configuration 63 64 {{{#!ini 61 65 [ticket-custom] 62 66 … … 111 115 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 116 113 {{{ 114 #!sql 117 {{{#!sql 115 118 SELECT p.value AS __color__, 116 119 id AS ticket, summary, owner, c.value AS progress … … 123 126 124 127 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 128 {{{#!sql 127 129 SELECT p.value AS __color__, 128 130 id AS ticket, summary, component, version, milestone, severity, … … 131 133 changetime AS _changetime, description AS _description, 132 134 reporter AS _reporter, 133 (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress135 (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress 134 136 FROM ticket t 135 137 LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress') … … 141 143 Note in particular the `LEFT OUTER JOIN` statement here. 142 144 143 Note that if your config file uses an uppercase name, e.g.,144 {{{ 145 Note that if your config file uses an '''uppercase''' name: 146 {{{#!ini 145 147 [ticket-custom] 146 148 147 149 Progress_Type = text 148 150 }}} 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 }}} 151 you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`. 184 152 185 153 ----
