Changes between Initial Version and Version 1 of TracTicketsCustomFields


Ignore:
Timestamp:
06/04/12 12:01:35 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketsCustomFields

    v1 v1  
     1= カスタムチケット属性 = #CustomTicketFields 
     2Trac ではチケットにユーザ定義の属性を追加できます。カスタムチケット属性を使用すると、型付けされた、プロジェクト特有のプロパティをチケットに持たせることができます。 
     3 
     4== 設定方法 == #Configuration 
     5カスタムチケット属性を設定するためには、 [wiki:TracIni trac.ini] ファイルを変更します。カスタムフィールドは、 trac.ini ファイルの `[ticket-custom]` セクションに書く必要があります。 
     6 
     7各属性の定義は以下のように記述します: 
     8{{{ 
     9 属性名 = タイプ 
     10 (属性名.オプション = 値) 
     11 ... 
     12}}} 
     13構文の詳細は以下の例を見てください。 
     14 
     15=== 属性のタイプとオプション === #AvailableFieldTypesandOptions 
     16 * '''text''': シンプルな(1行の)テキスト。 
     17   * label: 説明となるラベル 
     18   * value: デフォルト値 
     19   * order: ソート時の並び順 (全てのカスタムフィールドで共通するソートの並び順) 
     20   * format: 通常のテキストを指す `plain` もしくは WikiFormatting として整形を行う `wiki` のいずれかを指定する。 (''0.11.3 以降'') 
     21 * '''checkbox''': ブーリアン値をもつチェックボックス。 
     22   * label: 説明となるラベル。 
     23   * value: デフォルト値 (0 または 1). 
     24   * order: ソート時の並び順 
     25 * '''select''': ドロップダウンするリストボックス。 
     26   * label: 説明となるラベル。 
     27   * options: リストに表示する値を '''|''' (vertical pipe) 区切りで記述。 
     28   * value: デフォルト値 (options の値から一つを指定) 
     29   * order: ソート時の並び順 
     30 * '''radio''': ラジオボタン。 HTML の '''select''' 要素と同じ。 
     31   * label: 説明となるラベル。 
     32   * options: リストに表示する値を '''|''' (vertical pipe) 区切りで記述。 
     33   * value: デフォルト値 (options の値から一つを指定) 
     34   * order: ソート時の並び順 
     35 * '''textarea''': 複数行のテキストエリア。 
     36   * label: 説明となるラベル。 
     37   * value: デフォルトで設定されるテキスト。 
     38   * cols: 入力領域のカラム幅。 
     39   * rows: 入力領域の行数。 
     40   * order: ソート時の並び順 
     41   * format: 通常のテキストを指す `plain` もしくは WikiFormatting として整形を行う `wiki` のいずれかを指定する。 (''0.11.3 以降'') 
     42 
     43=== サンプル === #SampleConfig 
     44{{{ 
     45[ticket-custom] 
     46 
     47test_one = text 
     48test_one.label = Just a text box 
     49 
     50test_two = text 
     51test_two.label = Another text-box 
     52test_two.value = Default [mailto:joe@nospam.com owner] 
     53test_two.format = wiki 
     54 
     55test_three = checkbox 
     56test_three.label = Some checkbox 
     57test_three.value = 1 
     58 
     59test_four = select 
     60test_four.label = My selectbox 
     61test_four.options = one|two|third option|four 
     62test_four.value = two 
     63 
     64test_five = radio 
     65test_five.label = Radio buttons are fun 
     66test_five.options = uno|dos|tres|cuatro|cinco 
     67test_five.value = dos 
     68 
     69test_six = textarea 
     70test_six.label = This is a large textarea 
     71test_six.value = Default text 
     72test_six.cols = 60 
     73test_six.rows = 30 
     74}}} 
     75 
     76''Note: `select` タイプのフィールドを非必須 (optional) にしたい場合、 `フィールド名.options` オプションの先頭に `バーティカルパイプ (|)` を設定してください。'' 
     77 
     78=== カスタム属性を含むレポート === #ReportsInvolvingCustomFields 
     79 
     80カスタムチケット属性は `ticket` テーブルに保存されるのではなく、 `ticket_custom` テーブルに保存されます。したがって、レポートのカスタム属性を表示するためには `ticket` と `ticket_custom` の 2 テーブルを join する必要があります。 `progress` と設定されたカスタムチケット属性の使用例を示します。 
     81 
     82{{{ 
     83#!sql 
     84SELECT 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' 
     88AND p.name = t.priority AND p.type = 'priority' 
     89  ORDER BY p.value 
     90}}} 
     91'''Note''' この例は progress が設定されたチケットだけを表示します。'''すべてのチケットを表示するのではありません。'''既にいくつかのチケットを作成した''後で''カスタムチケット属性を定義した場合、既に作成されたチケットにはカスタムチケット属性が定義されません。そのため上記のクエリではチケットが表示されないでしょう。既に作成されたチケットにカスタム属性を設定し直せば、カスタムチケット属性は定義されます。そして、上記のクエリによって表示されるでしょう。 
     92 
     93しかし、すべてのチケットエントリを ( progress が定義されていないエントリーも一緒に ) 表示したいのであれば、クエリにおいてあらゆるカスタムフィールドに `JOIN` を使用する必要があります。 
     94{{{ 
     95#!sql 
     96SELECT p.value AS __color__, 
     97   id AS ticket, summary, component, version, milestone, severity, 
     98   (CASE status WHEN 'assigned' THEN owner||' *' ELSE owner END) AS owner, 
     99   time AS created, 
     100   changetime AS _changetime, description AS _description, 
     101   reporter AS _reporter, 
     102  (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress 
     103  FROM ticket t 
     104     LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress') 
     105     JOIN enum p ON p.name = t.priority AND p.type='priority' 
     106  WHERE status IN ('new', 'assigned', 'reopened') 
     107  ORDER BY p.value, milestone, severity, time 
     108}}} 
     109 
     110この `LEFT OUTER JOIN` ステートメントに特に注意してください。 
     111 
     112=== データベースを更新する === #Updatingthedatabase 
     113 
     114上記に記述したとおり、カスタムフィールド設定以前に作成されたチケットには、該当するフィールドの値が定義されていない状態になります。以下のような SQL を Trac のデータベースで直接実行することで、カスタムフィールドの初期値を設定することができます (SQLite 向けの SQL ですので、 DBMS に応じて調整してください)。カスタムフィールド 'request_source' が存在しない、全てのチケットにデフォルト値 'None' が挿入されます: 
     115 
     116{{{ 
     117#!sql 
     118INSERT 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複数のカスタムフィールドを追加している場合、 {{{ticket}}} 表への副問合わせで対象となるカスタムフィールドの名前を指定しなければなりません (訳注: 通常は上記の例ではなく、こちらを使うといいでしょう): 
     131 
     132{{{ 
     133#!sql 
     134INSERT 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 
     146---- 
     147See also: TracTickets, TracIni