Changes between Initial Version and Version 1 of TracTicketsCustomFields


Ignore:
Timestamp:
07/20/10 20:12:24 (14 years ago)
Author:
trac (IP: 127.0.0.1)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v1 v1  
     1= Custom Ticket Fields =
     2Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
     3
     4== Configuration ==
     5Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
     6
     7The syntax of each field definition is:
     8{{{
     9 FIELD_NAME = TYPE
     10 (FIELD_NAME.OPTION = VALUE)
     11 ...
     12}}}
     13The example below should help to explain the syntax.
     14
     15=== Available Field Types and Options ===
     16 * '''text''': A simple (one line) text field.
     17   * label: Descriptive label.
     18   * value: Default value.
     19   * order: Sort order placement. (Determines relative placement in forms with respect to other custom fields.)
     20 * '''checkbox''': A boolean value check box.
     21   * label: Descriptive label.
     22   * value: Default value (0 or 1).
     23   * order: Sort order placement.
     24 * '''select''': Drop-down select box. Uses a list of values.
     25   * label: Descriptive label.
     26   * options: List of values, separated by '''|''' (vertical pipe).
     27   * value: Default value (one of the values from options).
     28   * order: Sort order placement.
     29 * '''radio''': Radio buttons. Essentially the same as '''select'''.
     30   * label: Descriptive label.
     31   * options: List of values, separated by '''|''' (vertical pipe).
     32   * value: Default value (one of the values from options).
     33   * order: Sort order placement.
     34 * '''textarea''': Multi-line text area.
     35   * label: Descriptive label.
     36   * value: Default text.
     37   * cols: Width in columns.
     38   * rows: Height in lines.
     39   * order: Sort order placement.
     40
     41=== Sample Config ===
     42{{{
     43[ticket-custom]
     44
     45test_one = text
     46test_one.label = Just a text box
     47
     48test_two = text
     49test_two.label = Another text-box
     50test_two.value = Just a default value
     51
     52test_three = checkbox
     53test_three.label = Some checkbox
     54test_three.value = 1
     55
     56test_four = select
     57test_four.label = My selectbox
     58test_four.options = one|two|third option|four
     59test_four.value = two
     60
     61test_five = radio
     62test_five.label = Radio buttons are fun
     63test_five.options = uno|dos|tres|cuatro|cinco
     64test_five.value = dos
     65
     66test_six = textarea
     67test_six.label = This is a large textarea
     68test_six.value = Default text
     69test_six.cols = 60
     70test_six.rows = 30
     71}}}
     72
     73''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
     74
     75=== Reports Involving Custom Fields ===
     76
     77Custom 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`.
     78
     79{{{
     80#!sql
     81SELECT p.value AS __color__,
     82   id AS ticket, summary, owner, c.value AS progress
     83  FROM ticket t, enum p, ticket_custom c
     84  WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
     85AND p.name = t.priority AND p.type = 'priority'
     86  ORDER BY p.value
     87}}}
     88'''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.
     89
     90However, 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.
     91{{{
     92#!sql
     93SELECT p.value AS __color__,
     94   id AS ticket, summary, component, version, milestone, severity,
     95   (CASE status WHEN 'assigned' THEN owner||' *' ELSE owner END) AS owner,
     96   time AS created,
     97   changetime AS _changetime, description AS _description,
     98   reporter AS _reporter,
     99  (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     100  FROM ticket t
     101     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
     102     JOIN enum p ON p.name = t.priority AND p.type='priority'
     103  WHERE status IN ('new', 'assigned', 'reopened')
     104  ORDER BY p.value, milestone, severity, time
     105}}}
     106
     107Note in particular the `LEFT OUTER JOIN` statement here.
     108
     109=== Updating the database ===
     110
     111As 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:
     112
     113{{{
     114#!sql
     115INSERT INTO ticket_custom
     116   (ticket, name, value)
     117   SELECT
     118      id AS ticket,
     119      'request_source' AS name,
     120      'None' AS value
     121   FROM ticket
     122   WHERE id NOT IN (
     123      SELECT ticket FROM ticket_custom
     124   );
     125}}}
     126
     127If 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:
     128
     129{{{
     130#!sql
     131INSERT INTO ticket_custom
     132   (ticket, name, value)
     133   SELECT
     134      id AS ticket,
     135      'request_source' AS name,
     136      'None' AS value
     137   FROM ticket
     138   WHERE id NOT IN (
     139      SELECT ticket FROM ticket_custom WHERE name = 'request_source'
     140   );
     141}}}
     142
     143----
     144See also: TracTickets, TracIni