Changes between Version 1 and Version 2 of Trac Tickets Custom Fields


Ignore:
Timestamp:
02/06/14 20:46:04 (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Trac Tickets Custom Fields

    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.) 
     20   * format: One of:  
     21     * `plain` for plain text  
     22     * `wiki` to interpret the content as WikiFormatting (''since 0.11.3'')  
     23     * `reference` to treat the content as a queryable value (''since 1.0'')  
     24     * `list` to interpret the content as a list of queryable values, separated by whitespace (''since 1.0'') 
    2025 * '''checkbox''': A boolean value check box. 
    2126   * label: Descriptive label. 
     
    2530   * label: Descriptive label. 
    2631   * options: List of values, separated by '''|''' (vertical pipe). 
    27    * value: Default value (Item #, starting at 0). 
     32   * value: Default value (one of the values from options). 
    2833   * order: Sort order placement. 
    2934 * '''radio''': Radio buttons. Essentially the same as '''select'''. 
    3035   * label: Descriptive label. 
    3136   * options: List of values, separated by '''|''' (vertical pipe). 
    32    * value: Default value (Item #, starting at 0). 
     37   * value: Default value (one of the values from options). 
    3338   * order: Sort order placement. 
    3439 * '''textarea''': Multi-line text area. 
     
    3843   * rows: Height in lines. 
    3944   * order: Sort order placement. 
     45   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting. (''since 0.11.3'') 
    4046 
    4147=== Sample Config === 
     
    4854test_two = text 
    4955test_two.label = Another text-box 
    50 test_two.value = Just a default value 
     56test_two.value = Default [mailto:joe@nospam.com owner] 
     57test_two.format = wiki 
    5158 
    5259test_three = checkbox 
     
    5764test_four.label = My selectbox 
    5865test_four.options = one|two|third option|four 
    59 test_four.value = 2 
     66test_four.value = two 
    6067 
    6168test_five = radio 
    6269test_five.label = Radio buttons are fun 
    6370test_five.options = uno|dos|tres|cuatro|cinco 
    64 test_five.value = 1 
     71test_five.value = dos 
    6572 
    6673test_six = textarea 
     
    7582=== Reports Involving Custom Fields === 
    7683 
    77 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. 
     84Custom 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`. 
    7885 
    79 The following example includes a custom ticket field named `progress` in the report: 
     86{{{ 
     87#!sql 
     88SELECT p.value AS __color__, 
     89   id AS ticket, summary, owner, c.value AS progress 
     90  FROM ticket t, enum p, ticket_custom c 
     91  WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress' 
     92AND p.name = t.priority AND p.type = 'priority' 
     93  ORDER BY p.value 
     94}}} 
     95'''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. 
     96 
     97However, 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. 
    8098{{{ 
    8199#!sql 
     
    96114Note in particular the `LEFT OUTER JOIN` statement here. 
    97115 
     116=== Updating the database === 
     117 
     118As 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: 
     119 
     120{{{ 
     121#!sql 
     122INSERT INTO ticket_custom 
     123   (ticket, name, value) 
     124   SELECT  
     125      id AS ticket, 
     126      'request_source' AS name, 
     127      'None' AS value 
     128   FROM ticket  
     129   WHERE id NOT IN ( 
     130      SELECT ticket FROM ticket_custom 
     131   ); 
     132}}} 
     133 
     134If 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: 
     135 
     136{{{ 
     137#!sql 
     138INSERT INTO ticket_custom 
     139   (ticket, name, value) 
     140   SELECT  
     141      id AS ticket, 
     142      'request_source' AS name, 
     143      'None' AS value 
     144   FROM ticket  
     145   WHERE id NOT IN ( 
     146      SELECT ticket FROM ticket_custom WHERE name = 'request_source' 
     147   ); 
     148}}} 
     149 
    98150---- 
    99151See also: TracTickets, TracIni