Changes between Version 2 and Version 3 of TracTicketsCustomFields


Ignore:
Timestamp:
01/06/25 10:28:02 (10 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTicketsCustomFields

    v2 v3  
    1 = カスタムチケット属性 = #CustomTicketFields
    2 Trac ではチケットにユーザ定義の属性を追加できます。カスタムチケット属性を使用すると、型付けされた、プロジェクト特有のプロパティをチケットに持たせることができます。
    3 
    4 == 設定方法 == #Configuration
    5 カスタムチケット属性を設定するためには、 [wiki:TracIni trac.ini] ファイルを変更します。カスタムフィールドは、 trac.ini ファイルの `[ticket-custom]` セクションに書く必要があります。
    6 
    7 各属性の定義は以下のように記述します:
     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.
     3
     4== Configuration
     5
     6Configure custom ticket fields in the [TracIni#ticket-custom-section "[ticket-custom]"] section of trac.ini.
     7
     8The syntax of each field definition is:
    89{{{
    9  属性名 = タイプ
    10  (属性名.オプション = 値)
     10 FIELD_NAME = TYPE
     11 (FIELD_NAME.OPTION = VALUE)
    1112 ...
    1213}}}
    13 構文の詳細は以下の例を見てください。
    14 
    15 === 属性のタイプとオプション === #AvailableFieldTypesandOptions
    16   * '''text''': シンプルな(1行の)テキスト
    17    * label: 説明となるラベル
    18    * value: デフォルト値
    19    * order: ソート時の並び順 (全てのカスタムフィールドで共通するソートの並び順)
    20    * format:
    21      * 通常のテキストを指す `plain`
    22      * WikiFormatting として整形を行う `wiki` (''0.11.3 以降'')
    23      * 参照可能な値として整形を行う `reference` (''1.0 以降'')
    24      * スペースで区切られた参照可能なリストとして整形を行う `list` のいずれかを指定する(''1.0 以降'')
    25  * '''checkbox''': ブーリアン値をもつチェックボックス
    26    * label: 説明となるラベル
    27    * value: デフォルト値 (0 または 1)
    28    * order: ソート時の並び順
    29  * '''select''': ドロップダウンするリストボックス
    30    * label: 説明となるラベル
    31    * options: リストに表示する値を '''|''' (vertical pipe) 区切りで記述
    32    * value: デフォルト値 (options の値から一つを指定)
    33    * order: ソート時の並び順
    34  * '''radio''': ラジオボタン。 HTML の '''select''' 要素と同じ
    35    * label: 説明となるラベル
    36    * options: リストに表示する値を '''|''' (vertical pipe) 区切りで記述
    37    * value: デフォルト値 (options の値から一つを指定)
    38    * order: ソート時の並び順
    39  * '''textarea''': 複数行のテキストエリア
    40    * label: 説明となるラベル
    41    * value: デフォルトで設定されるテキスト
    42    * cols: 入力領域のカラム幅
    43    * rows: 入力領域の行数
    44    * order: ソート時の並び順
    45    * format: 通常のテキストを指す `plain` もしくは WikiFormatting として整形を行う `wiki` のいずれかを指定する (''0.11.3 以降'')
    46 
    47 === サンプル === #SampleConfig
    48 {{{
     14
     15The example below should help to explain the syntax.
     16
     17=== Field Names
     18A field name can only contain lowercase letters a-z, uppercase letters A-Z or digits 0-9, and must not start with a leading digit.
     19
     20The following field names are reserved and can not be used for custom fields:
     21* cc
     22* changetime
     23* col
     24* comment
     25* component
     26* desc
     27* description
     28* format
     29* group
     30* groupdesc
     31* id
     32* keywords
     33* max
     34* milestone
     35* or
     36* order
     37* owner
     38* page
     39* priority
     40* report
     41* reporter
     42* resolution
     43* row
     44* severity
     45* status
     46* summary
     47* time
     48* type
     49* verbose
     50* version
     51
     52=== Available Field Types and Options
     53
     54 * '''text''': A simple (one line) text field.
     55   * label: Descriptive label.
     56   * value: Default value.
     57   * order: Sort order placement relative to other custom fields.
     58   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     59   * format: One of:
     60     * `plain` for plain text
     61     * `wiki` for [WikiFormatting wiki formatted] content
     62     * `reference` to treat the content as a queryable value
     63     * `list` to interpret the content as a list of queryable values, separated by whitespace
     64   * ticketlink_query: Query for linkifying ticket values.
     65     Not applicable for format `plain` and `wiki`.
     66 * '''checkbox''': A boolean value check box.
     67   * label: Descriptive label.
     68   * value: Default value, 0 or 1.
     69   * order: Sort order placement.
     70   * ticketlink_query: Query for linkifying ticket values.
     71 * '''select''': Drop-down select box. Uses a list of values.
     72   * label: Descriptive label.
     73   * options: List of values, separated by '''|''' (vertical pipe).
     74   * value: Default value (one of the values from options).
     75   * order: Sort order placement.
     76   * ticketlink_query: Query for linkifying ticket values.
     77 * '''radio''': Radio buttons. Essentially the same as '''select'''.
     78   * label: Descriptive label.
     79   * options: List of values, separated by '''|''' (vertical pipe).
     80   * value: Default value, one of the values from options.
     81   * order: Sort order placement.
     82   * ticketlink_query: Query for linkifying ticket values.
     83 * '''textarea''': Multi-line text area.
     84   * label: Descriptive label.
     85   * value: Default text.
     86   * rows: Height in lines.
     87   * order: Sort order placement.
     88   * max_size: Maximum allowed size in characters (//Since 1.3.2//).
     89   * format: Either `plain` for plain text or `wiki` to interpret the content as WikiFormatting.
     90 * '''time''': Date and time picker. (//Since 1.1.1//)
     91   * label: Descriptive label.
     92   * value: Default date.
     93   * order: Sort order placement.
     94   * format: One of:
     95     * `relative` for relative dates.
     96     * `date` for absolute dates.
     97     * `datetime` for absolute date and time values.
     98
     99If the `label` is not specified, it will be created by capitalizing the custom field name and replacing underscores with whitespaces.
     100
     101Macros will be expanded when rendering `textarea` fields with format `wiki`, but not when rendering `text` fields with format `wiki`.
     102
     103For applicable fields, the `ticketlink_query` option
     104overrides [[TracIni#query-ticketlink_query-option|"[query] ticketlink_query"]], and the format is the same as
     105that option. When the `ticketlink_query` option
     106is not specified, `[query]` `ticketlink_query` is used to
     107linkify the field.
     108
     109=== Sample Configuration
     110
     111{{{#!ini
    49112[ticket-custom]
    50113
    … …  
    68131test_five = radio
    69132test_five.label = Radio buttons are fun
    70 test_five.options = uno|dos|tres|cuatro|cinco
     133test_five.options = |uno|dos|tres|cuatro|cinco
    71134test_five.value = dos
    72135
    … …  
    76139test_six.cols = 60
    77140test_six.rows = 30
    78 }}}
    79 
    80 ''Note: `select` タイプのフィールドを非必須 (optional) にしたい場合、 `フィールド名.options` オプションの先頭に `バーティカルパイプ (|)` を設定してください。''
    81 
    82 === カスタム属性を含むレポート === #ReportsInvolvingCustomFields
    83 
    84 カスタムチケット属性は `ticket` テーブルに保存されるのではなく、 `ticket_custom` テーブルに保存されます。したがって、レポートのカスタム属性を表示するためには `ticket` と `ticket_custom` の 2 テーブルを join する必要があります。 `progress` と設定されたカスタムチケット属性の使用例を示します。
    85 
    86 {{{
    87 #!sql
     141
     142test_seven = time
     143test_seven.label = A relative date
     144test_seven.format = relative
     145test_seven.value = now
     146
     147test_eight = time
     148test_eight.label = An absolute date
     149test_eight.format = date
     150test_eight.value = yesterday
     151
     152test_nine = time
     153test_nine.label = A date and time
     154test_nine.format = datetime
     155test_nine.value = in 2 hours
     156}}}
     157
     158'''Note''': To make a `select` type field optional, specify a leading `|` in `fieldname.options` (e.g. `test_five`).
     159
     160=== Reports Involving Custom Fields
     161
     162Custom 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`.
     163
     164{{{#!sql
    88165SELECT p.value AS __color__,
    89166   id AS ticket, summary, owner, c.value AS progress
    … …  
    93170  ORDER BY p.value
    94171}}}
    95 '''Note''' この例は progress が設定されたチケットだけを表示します。'''すべてのチケットを表示するのではありません。'''既にいくつかのチケットを作成した''後で''カスタムチケット属性を定義した場合、既に作成されたチケットにはカスタムチケット属性が定義されません。そのため上記のクエリではチケットが表示されないでしょう。既に作成されたチケットにカスタム属性を設定し直せば、カスタムチケット属性は定義されます。そして、上記のクエリによって表示されるでしょう。
    96 
    97 しかし、すべてのチケットエントリを ( progress が定義されていないエントリーも一緒に ) 表示したいのであれば、クエリにおいてあらゆるカスタムフィールドに `JOIN` を使用する必要があります。
    98 {{{
    99 #!sql
     172'''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.
     173
     174However, 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:
     175{{{#!sql
    100176SELECT p.value AS __color__,
    101177   id AS ticket, summary, component, version, milestone, severity,
    … …  
    104180   changetime AS _changetime, description AS _description,
    105181   reporter AS _reporter,
    106   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
     182   (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    107183  FROM ticket t
    108184     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
    … …  
    112188}}}
    113189
    114 この `LEFT OUTER JOIN` ステートメントに特に注意してください。
    115 
    116 === データベースを更新する === #Updatingthedatabase
    117 
    118 上記に記述したとおり、カスタムフィールド設定以前に作成されたチケットには、該当するフィールドの値が定義されていない状態になります。以下のような SQL を Trac のデータベースで直接実行することで、カスタムフィールドの初期値を設定することができます (SQLite 向けの SQL ですので、 DBMS に応じて調整してください)。カスタムフィールド 'request_source' が存在しない、全てのチケットにデフォルト値 'None' が挿入されます:
    119 
    120 {{{
    121 #!sql
    122 INSERT 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 
    134 複数のカスタムフィールドを追加している場合、 {{{ticket}}} 表への副問合わせで対象となるカスタムフィールドの名前を指定しなければなりません (訳注: 通常は上記の例ではなく、こちらを使うといいでしょう):
    135 
    136 {{{
    137 #!sql
    138 INSERT 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 }}}
     190Note in particular the `LEFT OUTER JOIN` statement here.
     191
     192Note that option names in trac.ini are case-insensitive, so even if your option name includes uppercase characters:
     193{{{#!ini
     194[ticket-custom]
     195Progress_Type = text
     196}}}
     197you must use '''lowercase''' in the SQL: `AND c.name = 'progress_type'`.
    149198
    150199----