Changes between Version 1 and Version 2 of TracTicketsCustomFields


Ignore:
Timestamp:
Jun 21, 2020, 8:42:19 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v1 v2  
    1 = Custom Ticket Fields =
    2 Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.
     1= Custom Ticket Fields
     2Trac supports adding custom, user-defined fields to the ticket module. With custom fields you can add typed, site-specific properties to tickets.
    33
    4 == Configuration ==
     4== Configuration
    55Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.
    66
     
    1313The example below should help to explain the syntax.
    1414
    15 === Available Field Types and Options ===
     15=== Available Field Types and Options
    1616 * '''text''': A simple (one line) text field.
    1717   * label: Descriptive label.
    1818   * value: Default value.
    19    * order: Sort order placement. (Determines relative placement in forms.)
     19   * order: Sort order placement; this 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
     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.
    22    * value: Default value (0 or 1).
     27   * value: Default value, 0 or 1.
    2328   * order: Sort order placement.
    2429 * '''select''': Drop-down select box. Uses a list of values.
    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.
    3540   * label: Descriptive label.
    3641   * value: Default text.
    37    * cols: Width in columns.
     42   * cols: Width in columns. //(Removed in 1.1.2)//
    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.
     46 * '''time''': Date and time picker. (''Since 1.1.1.'')
     47   * label: Descriptive label.
     48   * value: Default date.
     49   * order: Sort order placement.
     50   * format: One of:
     51     * `relative` for relative dates.
     52     * `date` for absolute dates.
     53     * `datetime` for absolute date and time values.
    4054
    41 === Sample Config ===
     55If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
     56
     57Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     58
     59=== Sample Config
    4260{{{
    4361[ticket-custom]
     
    4866test_two = text
    4967test_two.label = Another text-box
    50 test_two.value = Just a default value
     68test_two.value = Default [mailto:joe@nospam.com owner]
     69test_two.format = wiki
    5170
    5271test_three = checkbox
     
    5776test_four.label = My selectbox
    5877test_four.options = one|two|third option|four
    59 test_four.value = 2
     78test_four.value = two
    6079
    6180test_five = radio
    6281test_five.label = Radio buttons are fun
    6382test_five.options = uno|dos|tres|cuatro|cinco
    64 test_five.value = 1
     83test_five.value = dos
    6584
    6685test_six = textarea
     
    6988test_six.cols = 60
    7089test_six.rows = 30
     90
     91test_seven = time
     92test_seven.label = A relative date
     93test_seven.format = relative
     94test_seven.value = now
     95
     96test_eight = time
     97test_eight.label = An absolute date
     98test_eight.format = date
     99test_eight.value = yesterday
     100
     101test_nine = time
     102test_nine.label = A date and time
     103test_nine.format = datetime
     104test_nine.value = in 2 hours
    71105}}}
    72106
    73 ''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''
     107'''Note''': To make a `select` type field optional, specify a leading `|` in the `fieldname.options` option.
    74108
    75 === Reports Involving Custom Fields ===
     109=== Reports Involving Custom Fields
    76110
    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.
     111Custom 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`.
    78112
    79 The following example includes a custom ticket field named `progress` in the report:
     113{{{
     114#!sql
     115SELECT p.value AS __color__,
     116   id AS ticket, summary, owner, c.value AS progress
     117  FROM ticket t, enum p, ticket_custom c
     118  WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
     119AND p.name = t.priority AND p.type = 'priority'
     120  ORDER BY p.value
     121}}}
     122'''Note''': This will only show tickets that have progress set in them. This 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.
     123
     124However, 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:
    80125{{{
    81126#!sql
     
    96141Note in particular the `LEFT OUTER JOIN` statement here.
    97142
     143Note that if your config file uses an uppercase name, e.g.,
     144{{{
     145[ticket-custom]
     146
     147Progress_Type = text
     148}}}
     149you would use lowercase in the SQL: `AND c.name = 'progress_type'`
     150
     151=== Updating the database
     152
     153As 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:
     154
     155{{{
     156#!sql
     157INSERT INTO ticket_custom
     158   (ticket, name, value)
     159   SELECT
     160      id AS ticket,
     161      'request_source' AS name,
     162      'None' AS value
     163   FROM ticket
     164   WHERE id NOT IN (
     165      SELECT ticket FROM ticket_custom
     166   );
     167}}}
     168
     169If 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:
     170
     171{{{
     172#!sql
     173INSERT INTO ticket_custom
     174   (ticket, name, value)
     175   SELECT
     176      id AS ticket,
     177      'request_source' AS name,
     178      'None' AS value
     179   FROM ticket
     180   WHERE id NOT IN (
     181      SELECT ticket FROM ticket_custom WHERE name = 'request_source'
     182   );
     183}}}
     184
    98185----
    99186See also: TracTickets, TracIni