Changes between Version 4 and Version 5 of TracTicketsCustomFields
- Timestamp:
- May 8, 2022, 3:12:15 PM (2 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracTicketsCustomFields
v4 v5 4 4 == Configuration 5 5 6 Configur ing custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.6 Configure custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini. 7 7 8 8 The syntax of each field definition is: … … 15 15 The example below should help to explain the syntax. 16 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 17 52 === Available Field Types and Options 18 53 … … 20 55 * label: Descriptive label. 21 56 * value: Default value. 22 * order: Sort order placement; this determines relative placement in forms with respect to other custom fields. 23 * format: One of: 24 * `plain` for plain text 25 * `wiki` to interpret the content as WikiFormatting 26 * `reference` to treat the content as a queryable value (''since 1.0'') 27 * `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 28 64 * '''checkbox''': A boolean value check box. 29 65 * label: Descriptive label. … … 43 79 * label: Descriptive label. 44 80 * value: Default text. 45 * cols: Width in columns. //(Removed in 1.1.2)//46 81 * rows: Height in lines. 47 82 * order: Sort order placement. 83 * max_size: Maximum allowed size in characters (//Since 1.3.2//). 48 84 * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. 49 * '''time''': Date and time picker. ( ''Since 1.1.1.'')85 * '''time''': Date and time picker. (//Since 1.1.1//) 50 86 * label: Descriptive label. 51 87 * value: Default date. … … 84 120 test_five = radio 85 121 test_five.label = Radio buttons are fun 86 test_five.options = uno|dos|tres|cuatro|cinco122 test_five.options = |uno|dos|tres|cuatro|cinco 87 123 test_five.value = dos 88 124 … … 109 145 }}} 110 146 111 '''Note''': To make 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`). 112 148 113 149 === Reports Involving Custom Fields … … 143 179 Note in particular the `LEFT OUTER JOIN` statement here. 144 180 145 Note that if your config file uses an '''uppercase''' name:181 Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters: 146 182 {{{#!ini 147 183 [ticket-custom] 148 149 184 Progress_Type = text 150 185 }}} 151 you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`. 152 153 === Updating the database 154 155 As noted above, any tickets created before a custom field has been defined will not have a value for that field. Here is some SQL (tested with SQLite) that you can run directly on the Trac database to set an initial value for custom ticket fields. It inserts the default value of 'None' into a custom field called 'request_source' for all tickets that have no existing value: 156 157 {{{#!sql 158 INSERT INTO ticket_custom 159 (ticket, name, value) 160 SELECT 161 id AS ticket, 162 'request_source' AS name, 163 'None' AS value 164 FROM ticket 165 WHERE id NOT IN ( 166 SELECT ticket FROM ticket_custom 167 ); 168 }}} 169 170 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: 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 }}} 186 you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`. 184 187 185 188 ----