Changes between Version 1 and Version 2 of TracTicketsCustomFields


Ignore:
Timestamp:
10/09/08 11:57:45 (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v1 v2  
    1717   * label: Descriptive label.
    1818   * value: Default value.
    19    * order: Sort order placement. (Determines relative placement in forms.)
     19   * order: Sort order placement. (Determines relative placement in forms with respect to other custom fields.)
    2020 * '''checkbox''': A boolean value check box.
    2121   * label: Descriptive label.
     
    2323   * order: Sort order placement.
    2424 * '''select''': Drop-down select box. Uses a list of values.
     25   * label: Descriptive label.
    2526   * options: List of values, separated by '''|''' (vertical pipe).
    26    * value: Default value (Item #, starting at 0).
     27   * value: Default value (one of the values from options).
    2728   * order: Sort order placement.
    2829 * '''radio''': Radio buttons. Essentially the same as '''select'''.
    2930   * label: Descriptive label.
    3031   * options: List of values, separated by '''|''' (vertical pipe).
    31    * value: Default value (Item #, starting at 0).
     32   * value: Default value (one of the values from options).
    3233   * order: Sort order placement.
    3334 * '''textarea''': Multi-line text area.
     
    5657test_four.label = My selectbox
    5758test_four.options = one|two|third option|four
    58 test_four.value = 2
     59test_four.value = two
    5960
    6061test_five = radio
    6162test_five.label = Radio buttons are fun
    6263test_five.options = uno|dos|tres|cuatro|cinco
    63 test_five.value = 1
     64test_five.value = dos
    6465
    6566test_six = textarea
     
    7071}}}
    7172
    72 ''Note: To make an entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
     73''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
    7374
    7475=== Reports Involving Custom Fields ===
    7576
    76 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.
     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`.
    7778
    78 The following example includes a custom ticket field named `progress` in the report:
     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.
    7991{{{
    8092#!sql
     
    95107Note in particular the `LEFT OUTER JOIN` statement here.
    96108
     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
    97143----
    98144See also: TracTickets, TracIni