Changes between Version 4 and Version 5 of TracTicketsCustomFields

Timestamp:

Nov 23, 2019, 8:07:28 PM (4 years ago)

Author:

trac

Comment:

--

TracTicketsCustomFields

@@ -1 @@
-= Custom Ticket Fields =
-Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
+= Custom Ticket Fields
+Trac supports adding custom, user-defined fields to the ticket module. With custom fields you can add typed, site-specific properties to tickets.
 
-== Configuration ==
+== 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]`.
 
@@ -11 +12 @@
  ...
 }}}
+
 The example below should help to explain the syntax.
 
-=== Available Field Types and Options ===
+=== 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. (Determines relative placement in forms with respect to other custom fields.)
+   * 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 (''since 0.11.3'') 
+     * `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'')
  * '''checkbox''': A boolean value check box.
    * label: Descriptive label.
-   * value: Default value (0 or 1).
+   * value: Default value, 0 or 1.
    * order: Sort order placement.
  * '''select''': Drop-down select box. Uses a list of values.
@@ -35 +73 @@
    * label: Descriptive label.
    * options: List of values, separated by '''|''' (vertical pipe).
-   * value: Default value (one of the values from options).
+   * value: Default value, one of the values from options.
    * order: Sort order placement.
  * '''textarea''': Multi-line text area.
    * label: Descriptive label.
    * value: Default text.
-   * cols: Width in columns
+   * cols: Width in columns. //(Removed in 1.1.2)//
    * rows: Height in lines.
    * order: Sort order placement.
-   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
+   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
+ * '''time''': Date and time picker. (''Since 1.1.1.'')
+   * label: Descriptive label.
+   * value: Default date.
+   * order: Sort order placement.
+   * format: One of:
+     * `relative` for relative dates.
+     * `date` for absolute dates.
+     * `datetime` for absolute date and time values.
+
+If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
 
 Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
 
-=== Sample Config ===
-{{{
+=== Sample Configuration
+
+{{{#!ini
 [ticket-custom]
 
@@ -78 +127 @@
 test_six.cols = 60
 test_six.rows = 30
+
+test_seven = time
+test_seven.label = A relative date
+test_seven.format = relative
+test_seven.value = now
+
+test_eight = time
+test_eight.label = An absolute date
+test_eight.format = date
+test_eight.value = yesterday
+
+test_nine = time
+test_nine.label = A date and time
+test_nine.format = datetime
+test_nine.value = in 2 hours
 }}}
 
-''Note: To make entering an option for 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 the `fieldname.options` option.
 
-=== Reports Involving Custom Fields ===
+=== Reports Involving Custom Fields
 
 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
@@ -95 +158 @@
   ORDER BY p.value
 }}}
-'''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.
+'''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.
 
-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
+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
 SELECT p.value AS __color__,
    id AS ticket, summary, component, version, milestone, severity,
@@ -106 +168 @@
    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')
@@ -116 +178 @@
 Note in particular the `LEFT OUTER JOIN` statement here.
 
-Note that if your config file uses an uppercase name, e.g.,
-{{{
+Note that if your config file uses an '''uppercase''' name:
+{{{#!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 would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
 
 ----