Changes between Version 3 and Version 4 of TracTicketsCustomFields

Timestamp:

Jan 30, 2019, 11:46:52 PM (5 years 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]`.
 
@@ -12 +11 @@
  ...
 }}}
-
 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.
@@ -95 +57 @@
 Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
 
-=== Sample Configuration
-
-{{{#!ini
+=== Sample Config
+{{{
 [ticket-custom]
 
@@ -150 +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`.
 
-{{{#!sql
+{{{
+#!sql
 SELECT p.value AS __color__,
    id AS ticket, summary, owner, c.value AS progress
@@ -161 +123 @@
 
 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,
@@ -168 +131 @@
    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')
@@ -178 +141 @@
 Note in particular the `LEFT OUTER JOIN` statement here.
 
-Note that if your config file uses an '''uppercase''' name:
-{{{#!ini
+Note that if your config file uses an uppercase name, e.g.,
+{{{
 [ticket-custom]
 
 Progress_Type = text
 }}}
-you would use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
+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'
+   );
+}}}
 
 ----