Changes between Version 2 and Version 3 of TracTicketsCustomFields
- Timestamp:
- 2019-05-02T09:45:05-03:00 (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracTicketsCustomFields
v2 v3 1 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. 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. 3 4 4 5 == Configuration 6 5 7 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 8 … … 11 13 ... 12 14 }}} 15 13 16 The example below should help to explain the syntax. 14 17 15 18 === Available Field Types and Options 19 16 20 * '''text''': A simple (one line) text field. 17 21 * label: Descriptive label. 18 22 * value: Default value. 19 * order: Sort order placement ; this determines relative placement in forms with respect to other custom fields.23 * order: Sort order placement. Determines relative placement in forms with respect to other custom fields. 20 24 * format: One of: 21 25 * `plain` for plain text … … 25 29 * '''checkbox''': A boolean value check box. 26 30 * label: Descriptive label. 27 * value: Default value ,0 or 1.31 * value: Default value: 0 or 1. 28 32 * order: Sort order placement. 29 33 * '''select''': Drop-down select box. Uses a list of values. … … 35 39 * label: Descriptive label. 36 40 * options: List of values, separated by '''|''' (vertical pipe). 37 * value: Default value , one of the values from options.41 * value: Default value (one of the values from options). 38 42 * order: Sort order placement. 39 43 * '''textarea''': Multi-line text area. 40 44 * label: Descriptive label. 41 45 * value: Default text. 42 * cols: Width in columns . //(Removed in 1.1.2)//46 * cols: Width in columns 43 47 * rows: Height in lines. 44 48 * order: Sort order placement. 45 49 * 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.56 50 57 51 Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`. 58 52 59 === Sample Config 60 {{{ 53 === Sample Configuration 54 55 {{{#!ini 61 56 [ticket-custom] 62 57 … … 88 83 test_six.cols = 60 89 84 test_six.rows = 30 90 91 test_seven = time92 test_seven.label = A relative date93 test_seven.format = relative94 test_seven.value = now95 96 test_eight = time97 test_eight.label = An absolute date98 test_eight.format = date99 test_eight.value = yesterday100 101 test_nine = time102 test_nine.label = A date and time103 test_nine.format = datetime104 test_nine.value = in 2 hours105 85 }}} 106 86 107 '''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.87 '''Note''': To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option. 108 88 109 89 === Reports Involving Custom Fields … … 111 91 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 92 113 {{{ 114 #!sql 93 {{{#!sql 115 94 SELECT p.value AS __color__, 116 95 id AS ticket, summary, owner, c.value AS progress … … 120 99 ORDER BY p.value 121 100 }}} 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. 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. 123 103 124 104 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 105 {{{#!sql 127 106 SELECT p.value AS __color__, 128 107 id AS ticket, summary, component, version, milestone, severity, … … 131 110 changetime AS _changetime, description AS _description, 132 111 reporter AS _reporter, 133 (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress112 (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress 134 113 FROM ticket t 135 114 LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress') … … 141 120 Note in particular the `LEFT OUTER JOIN` statement here. 142 121 143 Note that if your config file uses an uppercase name, e.g.,144 {{{ 122 Note that if your config file uses an '''uppercase''' name: 123 {{{#!ini 145 124 [ticket-custom] 146 125 147 126 Progress_Type = text 148 127 }}} 149 you would use lowercase in the SQL: `AND c.name = 'progress_type'`128 you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`. 150 129 151 130 === Updating the database 152 131 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: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: 154 133 155 {{{ 156 #!sql 134 {{{#!sql 157 135 INSERT INTO ticket_custom 158 136 (ticket, name, value) … … 169 147 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 148 171 {{{ 172 #!sql 149 {{{#!sql 173 150 INSERT INTO ticket_custom 174 151 (ticket, name, value)
