Changes between Version 1 and Version 2 of TracTicketsCustomFields
- Timestamp:
- Jan 28, 2017, 8:59:08 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracTicketsCustomFields
v1 v2 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 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 6 … … 13 13 The example below should help to explain the syntax. 14 14 15 === Available Field Types and Options ===15 === Available Field Types and Options 16 16 * '''text''': A simple (one line) text field. 17 17 * label: Descriptive label. 18 18 * value: Default value. 19 * 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. 20 20 * format: One of: 21 21 * `plain` for plain text 22 * `wiki` to interpret the content as WikiFormatting (''since 0.11.3'')22 * `wiki` to interpret the content as WikiFormatting 23 23 * `reference` to treat the content as a queryable value (''since 1.0'') 24 24 * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'') 25 25 * '''checkbox''': A boolean value check box. 26 26 * label: Descriptive label. 27 * value: Default value (0 or 1).27 * value: Default value, 0 or 1. 28 28 * order: Sort order placement. 29 29 * '''select''': Drop-down select box. Uses a list of values. … … 35 35 * label: Descriptive label. 36 36 * options: List of values, separated by '''|''' (vertical pipe). 37 * value: Default value (one of the values from options).37 * value: Default value, one of the values from options. 38 38 * order: Sort order placement. 39 39 * '''textarea''': Multi-line text area. 40 40 * label: Descriptive label. 41 41 * value: Default text. 42 * cols: Width in columns. 42 * cols: Width in columns. //(Removed in 1.1.2)// 43 43 * rows: Height in lines. 44 44 * order: Sort order placement. 45 * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'') 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. 46 54 47 === Sample Config === 55 If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces. 56 57 Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`. 58 59 === Sample Config 48 60 {{{ 49 61 [ticket-custom] … … 76 88 test_six.cols = 60 77 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 78 105 }}} 79 106 80 '' Note: To make entering an option for a `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. 81 108 82 === Reports Involving Custom Fields ===109 === Reports Involving Custom Fields 83 110 84 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`. … … 93 120 ORDER BY p.value 94 121 }}} 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.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. 96 123 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 .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: 98 125 {{{ 99 126 #!sql … … 114 141 Note in particular the `LEFT OUTER JOIN` statement here. 115 142 116 === Updating the database === 143 Note that if your config file uses an uppercase name, e.g., 144 {{{ 145 [ticket-custom] 146 147 Progress_Type = text 148 }}} 149 you would use lowercase in the SQL: `AND c.name = 'progress_type'` 150 151 === Updating the database 117 152 118 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:
