Changes between Version 5 and Version 6 of TracTicketsCustomFields

Timestamp:

Feb 24, 2024, 4:07:16 PM (9 months ago)

Author:

trac

Comment:

--

TracTicketsCustomFields

@@ -3 +3 @@
 
 == Configuration
-Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
+
+Configure custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini.
 
 The syntax of each field definition is:
@@ -11 +12 @@
  ...
 }}}
+
 The example below should help to explain the syntax.
 
+=== Field Names
+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.
+
+The following field names are reserved and can not be used for custom fields:
+* cc
+* changetime
+* col
+* comment
+* component
+* desc
+* description
+* format
+* group
+* groupdesc
+* id
+* keywords
+* max
+* milestone
+* or
+* order
+* owner
+* page
+* priority
+* report
+* reporter
+* resolution
+* row
+* severity
+* status
+* summary
+* time
+* type
+* verbose
+* version
+
 === Available Field Types and Options
+
  * '''text''': A simple (one line) text field.
    * label: Descriptive label.
    * value: Default value.
-   * order: Sort order placement; this determines relative placement in forms with respect to other custom fields.
-   * format: One of: 
-     * `plain` for plain text 
-     * `wiki` to interpret the content as WikiFormatting
-     * `reference` to treat the content as a queryable value (''since 1.0'') 
-     * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'')
+   * order: Sort order placement relative to other custom fields.
+   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
+   * format: One of:
+     * `plain` for plain text
+     * `wiki` for [WikiFormatting wiki formatted] content
+     * `reference` to treat the content as a queryable value
+     * `list` to interpret the content as a list of queryable values, separated by whitespace
+   * ticketlink_query: Query for linkifying ticket values.
+     Not applicable for format `plain` and `wiki`.
  * '''checkbox''': A boolean value check box.
    * label: Descriptive label.
    * value: Default value, 0 or 1.
    * order: Sort order placement.
+   * ticketlink_query: Query for linkifying ticket values.
  * '''select''': Drop-down select box. Uses a list of values.
    * label: Descriptive label.
@@ -32 +74 @@
    * value: Default value (one of the values from options).
    * order: Sort order placement.
+   * ticketlink_query: Query for linkifying ticket values.
  * '''radio''': Radio buttons. Essentially the same as '''select'''.
    * label: Descriptive label.
@@ -37 +80 @@
    * value: Default value, one of the values from options.
    * order: Sort order placement.
+   * ticketlink_query: Query for linkifying ticket values.
  * '''textarea''': Multi-line text area.
    * label: Descriptive label.
    * value: Default text.
-   * cols: Width in columns. //(Removed in 1.1.2)//
    * rows: Height in lines.
    * order: Sort order placement.
+   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
    * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
- * '''time''': Date and time picker. (''Since 1.1.1.'')
+ * '''time''': Date and time picker. (//Since 1.1.1//)
    * label: Descriptive label.
    * value: Default date.
@@ -57 +101 @@
 Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
 
-=== Sample Config
-{{{
+For applicable fields, the `ticketlink_query` option
+overrides [[TracIni#query-ticketlink_query-option|"[query] ticketlink_query"]], and the format is the same as
+that option. When the `ticketlink_query` option
+is not specified, `[query]` `ticketlink_query` is used to
+linkify the field.
+
+=== Sample Configuration
+
+{{{#!ini
 [ticket-custom]
 
@@ -80 +131 @@
 test_five = radio
 test_five.label = Radio buttons are fun
-test_five.options = uno|dos|tres|cuatro|cinco
+test_five.options = |uno|dos|tres|cuatro|cinco
 test_five.value = dos
 
@@ -105 +156 @@
 }}}
 
-'''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
+'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
 
 === Reports Involving Custom Fields
@@ -111 +162 @@
 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`.
 
-{{{
-#!sql
+{{{#!sql
 SELECT p.value AS __color__,
    id AS ticket, summary, owner, c.value AS progress
@@ -123 +173 @@
 
 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:
-{{{
-#!sql
+{{{#!sql
 SELECT p.value AS __color__,
    id AS ticket, summary, component, version, milestone, severity,
@@ -131 +180 @@
    changetime AS _changetime, description AS _description,
    reporter AS _reporter,
-  (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
+   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
   FROM ticket t
      LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
@@ -141 +190 @@
 Note in particular the `LEFT OUTER JOIN` statement here.
 
-Note that if your config file uses an uppercase name, e.g.,
-{{{
+Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
+{{{#!ini
 [ticket-custom]
-
 Progress_Type = text
 }}}
-you would use lowercase in the SQL: `AND c.name = 'progress_type'`
-
-=== Updating the database
-
-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:
-
-{{{
-#!sql
-INSERT INTO ticket_custom
-   (ticket, name, value)
-   SELECT 
-      id AS ticket,
-      'request_source' AS name,
-      'None' AS value
-   FROM ticket 
-   WHERE id NOT IN (
-      SELECT ticket FROM ticket_custom
-   );
-}}}
-
-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:
-
-{{{
-#!sql
-INSERT INTO ticket_custom
-   (ticket, name, value)
-   SELECT 
-      id AS ticket,
-      'request_source' AS name,
-      'None' AS value
-   FROM ticket 
-   WHERE id NOT IN (
-      SELECT ticket FROM ticket_custom WHERE name = 'request_source'
-   );
-}}}
+you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
 
 ----