Changes between Version 1 and Version 2 of TracTicketsCustomFields

Timestamp:

09/26/06 13:01:24 (18 years ago)

Author:

trac

Comment:

--

TracTicketsCustomFields

@@ -1 +1 @@
 = Custom Ticket Fields =
-Trac support adding custom, user-defined, fields to the ticket module. Using custom fields, you can add typed, site-specific, properties to tickets.
+Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
 
-'''Note: In Trac 0.8, this feature is still experimental.'''
-
-== Configuriation ==
-Configuring custom ticket fields is done in the TracIni config file.
-
-All field definitions should be under a section named [ticket-custom] in the ini-file.
+== 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]`.
 
 The syntax of each field definition is:
@@ -15 +11 @@
  ...
 }}}
-Looking at the example below should help explain the syntax.
+The example below should help to explain the syntax.
 
 === Available Field Types and Options ===
@@ -27 +23 @@
    * order: Sort order placement.
  * '''select''': Drop-down select box. Uses a list of values.
+   * label: Descriptive label.
    * options: List of values, separated by '''|''' (vertical pipe).
    * value: Default value (Item #, starting at 0).
@@ -38 +35 @@
    * label: Descriptive label.
    * value: Default text.
-   * width: Width in columns.
-   * height: Height in lines.
+   * cols: Width in columns.
+   * rows: Height in lines.
    * order: Sort order placement.
 
@@ -45 +42 @@
 {{{
 [ticket-custom]
+
 test_one = text
 test_one.label = Just a text box
@@ -69 +67 @@
 test_six.label = This is a large textarea
 test_six.value = Default text
-test_six.width = 60
-test_six.height = 30
+test_six.cols = 60
+test_six.rows = 30
 }}}
+
+''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
+
+=== Reports Involving Custom Fields ===
+
+The SQL required for TracReports to include custom ticket fields is relatively hard to get right. You need a `JOIN` with the `ticket_custom` field for every custom field that should be involved.
+
+The following example includes a custom ticket field named `progress` in the report:
+{{{
+#!sql
+SELECT p.value AS __color__,
+   id AS ticket, summary, component, version, milestone, severity,
+   (CASE status WHEN 'assigned' THEN owner||' *' ELSE owner END) AS owner,
+   time AS created,
+   changetime AS _changetime, description AS _description,
+   reporter AS _reporter,
+  (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')
+     JOIN enum p ON p.name = t.priority AND p.type='priority'
+  WHERE status IN ('new', 'assigned', 'reopened')
+  ORDER BY p.value, milestone, severity, time
+}}}
+
+Note in particular the `LEFT OUTER JOIN` statement here.
 
 ----