Changes between Version 4 and Version 5 of TracTicketsCustomFields
- Timestamp:
- Jan 5, 2017, 12:12:35 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracTicketsCustomFields
v4 v5 1 1 = Custom Ticket Fields 2 3 Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets. 2 Trac supports adding custom, user-defined fields to the ticket module. With custom fields you can add typed, site-specific properties to tickets. 4 3 5 4 == Configuration 6 7 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]`. 8 6 … … 13 11 ... 14 12 }}} 15 16 13 The example below should help to explain the syntax. 17 14 18 15 === Available Field Types and Options 19 20 16 * '''text''': A simple (one line) text field. 21 17 * label: Descriptive label. 22 18 * value: Default value. 23 * order: Sort order placement . Determines relative placement in forms with respect to other custom fields.19 * order: Sort order placement; this determines relative placement in forms with respect to other custom fields. 24 20 * format: One of: 25 21 * `plain` for plain text … … 29 25 * '''checkbox''': A boolean value check box. 30 26 * label: Descriptive label. 31 * value: Default value :0 or 1.27 * value: Default value, 0 or 1. 32 28 * order: Sort order placement. 33 29 * '''select''': Drop-down select box. Uses a list of values. … … 39 35 * label: Descriptive label. 40 36 * options: List of values, separated by '''|''' (vertical pipe). 41 * value: Default value (one of the values from options).37 * value: Default value, one of the values from options. 42 38 * order: Sort order placement. 43 39 * '''textarea''': Multi-line text area. 44 40 * label: Descriptive label. 45 41 * value: Default text. 46 * cols: Width in columns 42 * cols: Width in columns. //(Removed in 1.1.2)// 47 43 * rows: Height in lines. 48 44 * order: Sort order placement. 49 45 * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. 46 * '''time''': Date and time picker. (''Since 1.1.1.'') 47 * label: Descriptive label. 48 * value: Default date. 49 * order: Sort order placement. 50 * format: One of: 51 * `relative` for relative dates. 52 * `date` for absolute dates. 53 * `datetime` for absolute date and time values. 54 55 If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces. 50 56 51 57 Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`. 52 58 53 === Sample Configuration 54 55 {{{#!ini 59 === Sample Config 60 {{{ 56 61 [ticket-custom] 57 62 … … 83 88 test_six.cols = 60 84 89 test_six.rows = 30 90 91 test_seven = time 92 test_seven.label = A relative date 93 test_seven.format = relative 94 test_seven.value = now 95 96 test_eight = time 97 test_eight.label = An absolute date 98 test_eight.format = date 99 test_eight.value = yesterday 100 101 test_nine = time 102 test_nine.label = A date and time 103 test_nine.format = datetime 104 test_nine.value = in 2 hours 85 105 }}} 86 106 87 '''Note''': To make entering an option fora `select` type field optional, specify a leading `|` in the `fieldname.options` option.107 '''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option. 88 108 89 109 === Reports Involving Custom Fields … … 91 111 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`. 92 112 93 {{{#!sql 113 {{{ 114 #!sql 94 115 SELECT p.value AS __color__, 95 116 id AS ticket, summary, owner, c.value AS progress … … 99 120 ORDER BY p.value 100 121 }}} 101 102 '''Note''': 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 is all that is required, you're set. 122 '''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. 103 123 104 124 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: 105 {{{#!sql 125 {{{ 126 #!sql 106 127 SELECT p.value AS __color__, 107 128 id AS ticket, summary, component, version, milestone, severity, … … 110 131 changetime AS _changetime, description AS _description, 111 132 reporter AS _reporter, 112 133 (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress 113 134 FROM ticket t 114 135 LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress') … … 120 141 Note in particular the `LEFT OUTER JOIN` statement here. 121 142 122 Note that if your config file uses an '''uppercase''' name:123 {{{ #!ini143 Note that if your config file uses an uppercase name, e.g., 144 {{{ 124 145 [ticket-custom] 125 146 126 147 Progress_Type = text 127 148 }}} 128 you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.149 you would use lowercase in the SQL: `AND c.name = 'progress_type'` 129 150 130 151 === Updating the database 131 152 132 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: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: 133 154 134 {{{#!sql 155 {{{ 156 #!sql 135 157 INSERT INTO ticket_custom 136 158 (ticket, name, value) … … 147 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: 148 170 149 {{{#!sql 171 {{{ 172 #!sql 150 173 INSERT INTO ticket_custom 151 174 (ticket, name, value)
