Changes between Version 1 and Version 2 of TracTicketsCustomFields


Ignore:
Timestamp:
12/11/09 23:10:00 (15 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 with respect to other custom fields.)
    20    * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
     19   * order: Sort order placement. (Determines relative placement in forms.)
    2120 * '''checkbox''': A boolean value check box.
    2221   * label: Descriptive label.
    … …  
    2625   * label: Descriptive label.
    2726   * options: List of values, separated by '''|''' (vertical pipe).
    28    * value: Default value (one of the values from options).
     27   * value: Default value (Item #, starting at 0).
    2928   * order: Sort order placement.
    3029 * '''radio''': Radio buttons. Essentially the same as '''select'''.
    3130   * label: Descriptive label.
    3231   * options: List of values, separated by '''|''' (vertical pipe).
    33    * value: Default value (one of the values from options).
     32   * value: Default value (Item #, starting at 0).
    3433   * order: Sort order placement.
    3534 * '''textarea''': Multi-line text area.
    … …  
    3938   * rows: Height in lines.
    4039   * order: Sort order placement.
    41    * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'')
    4240
    4341=== Sample Config ===
    … …  
    5048test_two = text
    5149test_two.label = Another text-box
    52 test_two.value = Default [mailto:joe@nospam.com owner]
    53 test_two.format = wiki
     50test_two.value = Just a default value
    5451
    5552test_three = checkbox
    … …  
    6057test_four.label = My selectbox
    6158test_four.options = one|two|third option|four
    62 test_four.value = two
     59test_four.value = 2
    6360
    6461test_five = radio
    6562test_five.label = Radio buttons are fun
    6663test_five.options = uno|dos|tres|cuatro|cinco
    67 test_five.value = dos
     64test_five.value = 1
    6865
    6966test_six = textarea
    … …  
    7875=== Reports Involving Custom Fields ===
    7976
    80 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`.
     77The 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.
    8178
    82 {{{
    83 #!sql
    84 SELECT p.value AS __color__,
    85    id AS ticket, summary, owner, c.value AS progress
    86   FROM ticket t, enum p, ticket_custom c
    87   WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
    88 AND p.name = t.priority AND p.type = 'priority'
    89   ORDER BY p.value
    90 }}}
    91 '''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.
    92 
    93 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.
     79The following example includes a custom ticket field named `progress` in the report:
    9480{{{
    9581#!sql
    … …  
    11096Note in particular the `LEFT OUTER JOIN` statement here.
    11197
    112 === Updating the database ===
    113 
    114 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:
    115 
    116 {{{
    117 #!sql
    118 INSERT INTO ticket_custom
    119    (ticket, name, value)
    120    SELECT
    121       id AS ticket,
    122       'request_source' AS name,
    123       'None' AS value
    124    FROM ticket
    125    WHERE id NOT IN (
    126       SELECT ticket FROM ticket_custom
    127    );
    128 }}}
    129 
    130 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:
    131 
    132 {{{
    133 #!sql
    134 INSERT INTO ticket_custom
    135    (ticket, name, value)
    136    SELECT
    137       id AS ticket,
    138       'request_source' AS name,
    139       'None' AS value
    140    FROM ticket
    141    WHERE id NOT IN (
    142       SELECT ticket FROM ticket_custom WHERE name = 'request_source'
    143    );
    144 }}}
    145 
    14698----
    14799See also: TracTickets, TracIni