TracReports: バージョン 1 における更新

更新者:

trac (IPアドレス: 127.0.0.1)

更新日時:

2006/11/22 18:14:01 (18 年前)

コメント:

--

TracReports

@@ +1 @@
+= レポート =
+[[TracGuideToc]]
+
+レポートモジュールは、簡単かつ強力なレポーティング機能を提供します。
+この機能によって、 Trac データベースのチケット情報を取得することができます。
+
+TracReports ではレポートの形式を定義するための方法として、独自フォーマットではなく、 
+SQL の `SELECT` 文を使用することにしました。
+
+  '''Note:''' ''現在の形式のレポートモジュールは、 Trac 開発チームでデータベースのスキーマにあわせる作業が必要になるという深刻な制限事項があるため、段階的に廃止します。より柔軟性に富みユーザビリティに優れた [wiki:TracQuery クエリモジュール] が代替手段として提供されます。どこかの時点でレポートモジュールを完全に削除することが出来るように、クエリモジュールで実現できないレポートがある間は、私たちはクエリモジュールを強化していくつもりです。また、これはレポートモジュールへの重要な機能追加は行わないことを意味します。''
+
+  ''以下の [wiki:TracIni trac.ini] のように無効化するだけで、レポートモジュールをクエリモジュールで完全に置き換えることができます:''
+  {{{
+  [components]
+  trac.ticket.report.* = disabled
+  }}}
+  ''これによって、ナビゲーションバーの "チケットを見る" でのデフォルトのハンドラがクエリモジュールになります。もし可能ならば、この設定を有効にして、レポート機能がなくなることによって生じる不都合を報告してください。''
+
+レポートは以下の基本的なパーツから構成されます:
+ * '''ID''' -- ユニークな (連番の) 識別子
+ * '''レポート名 (Title)''' -- レポートのタイトル
+ * '''説明 (Description)''' -- WikiFormatting で記述された、レポートの説明。
+ * '''レポート本体 (Report Body)''' -- 後に述べるフォーマットで規定された、レポートクエリの結果。
+ * '''フッタ (Footer)''' -- レポート本体を異なる形式でダウンロードするためのリンク。
+
+== ソートの並び順変更 ==
+単純なレポート (特にグループ化されていないもの) では、カラムのヘッダをクリックすれば、そのカラムでソートすることが出来ます。
+
+カラムのヘッダがハイパーリンク (赤) になっていれば、クリックすることでそのカラムでのソートができます。並び順を逆にするには、もう一度クリックします。
+
+
+== ダウンロードできるフォーマット ==
+通常表示される HTML でのビューの加え、レポートはいろいろな形式で使用することができます。
+レポートページの一番下に、利用可能なデータ形式の一覧があります。望む形式のリンクをクリックすれば、
+その形式でのレポートをダウンロードすることができます。
+
+=== カンマ区切りテキスト - CSV (Comma Separated Values) ===
+1 レコードを 1 行として、各カラムをカンマ (',') で区切ったプレーンテキストとしてダウンロードできます。
+'''Note:''' CSV 形式を保つため、各カラムのデータに改行文字やカンマがある場合、その位置で切り取られます。
+
+=== タブ区切り ===
+CSV と似ていますが、水平タブ文字 (\t) で区切られる点が違います。
+
+=== RSS - XML Content Syndication ===
+全てのレポートは、 XML/RSS 2.0 での配信が可能です。 RSS フィードを購読するにはページ下部にある、オレンジ色の 'XML' アイコンをクリックしてください。 Trac での RSS 対応についての一般的な情報は、 TracRss に記述しています。
+
+----
+
+== カスタムレポートを作成する ==
+
+''カスタムレポートを作成するためには、 SQL を楽に書ける程度の知識が必要です。''
+
+レポートは基本的に、 Trac が実行できる形式の、名前がついた特定 SQL です。
+レポートに指定された SQL は、直接 Web インタフェースから閲覧したり、
+作成したりできます。
+
+通常のレポートは、 'ticket' 表に対する、カラムの選択や、ソート指定を伴った 
+SELECT 文となります。
+
+== Ticket 表のカラム ==
+''ticket'' 表は、以下のカラムを持ちます:
+ * id           -- チケットID
+ * time         -- 登録日時
+ * changetime   -- 最終更新日時
+ * component    -- コンポーネント
+ * severity     -- 重要度
+ * priority     -- 優先度
+ * owner        -- 担当者
+ * reporter     -- 報告者
+ * cc           -- 関係者
+ * version      -- バージョン
+ * milestone    -- マイルストーン
+ * status       -- ステータス
+ * resolution   -- 解決方法
+ * summary      -- チケットの概要
+ * description  -- チケットについての完全な説明
+
+各カラムに対応する属性の詳細な説明は、 TracTickets に記述しています。
+
+'''優先度順、登録日時順の全未解決チケット'''
+
+'''例:''' ''優先度順、登録日時順の全未解決チケット''
+{{{
+SELECT id AS ticket, status, severity, priority, owner, 
+       time as created, summary FROM ticket 
+  WHERE status IN ('new', 'assigned', 'reopened')
+  ORDER BY priority, time
+}}}
+
+
+----
+
+
+== 上級トピック: 動的変数の使用 ==
+レポートに汎用性を持たせる手段として、 ''動的変数'' をレポート SQL で使用する方法があります。
+簡単に言うと、動的変数とは、クエリを実行する前に置き換えられる ''特別な'' 文字列のことです。
+
+=== クエリで動的変数を使う方法 ===
+動的変数を使うためのシンタックスは単純です。 '$' に続いて、大文字で変数名となる語を挿入してください。
+
+例:
+{{{
+SELECT id AS ticket,summary FROM ticket WHERE priority='$PRIORITY'
+}}}
+
+レポート閲覧時、 $PRIORITY に値を当てはめるためには、レポートの URL に引数として変数を与えてください。この変数名に '$' を入れてはいけません。
+
+例:
+{{{
+ http://trac.edgewall.org/reports/14?PRIORITY=high
+}}}
+
+複数の値を使用する場合、各値を '&' で区切ります。
+
+例:
+{{{
+ http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
+}}}
+
+
+=== 特殊な定数 ===
+実用的なレポートのために、定義済みの動的変数が用意されています。これらは URL に値を設定しなくても、自動的に値が割り当てられます。
+
+ * $USER -- ログインに使用したユーザ名。
+
+例 (''私が担当になっているチケット一覧''):
+{{{
+SELECT id AS ticket,summary FROM ticket WHERE owner='$USER'
+}}}
+
+
+----
+
+
+== 上級トピック: 表示形式のカスタマイズ ==
+Trac には、レイアウトのカスタマイズや、グルーピング、ユーザ定義の CSS 利用などによる
+もっと複雑なレポートの作成も可能です。このようなレポートを作成するには、 
+Trac のレポートエンジンが出力を制御するためのステートメントを含む、特別な SQL を使用します。
+
+== 特別なカラム ==
+レポートを整形するため、 TracReports はクエリの結果から '特定の' カラム名を
+探します。このような '特定の' 名前で、最終的なレポートのレイアウトやスタイルが
+処理され、変更されます。
+
+=== 自動的に整形されるカラム名 ===
+ * '''ticket''' -- チケットの ID が入っているカラムで使用します。該当する ID のカラムにハイパーリンクされます。
+ * '''created, modified, date, time''' -- 日付や時刻に整形されます。
+
+ * '''description''' -- チケットの説明が入っているカラムで使用します。 Wiki エンジンで処理されます。
+
+'''例:'''
+{{{
+SELECT id as ticket, created, status, summary FROM ticket 
+}}}
+
+=== 整形されるカラムのカスタマイズ ===
+カラム名の前後に 2 つのアンダースコアがついている場合 (例: '''`__color__`''') は、 
+''整形用のヒント'' として扱われ、レコードの整形が行われます。
+ 
+ * '''`__group__`''' -- 指定されたカラムで、表示がグループ化されます。各グループは、それぞれセクションヘッダとクエリ結果の表を持ちます。
+ * '''`__color__`''' -- 1 から 5 の数値である必要があります。値によって、あらかじめ定義された色付けが行われます。一般的な使用法は、優先度別の色付けです。
+ * '''`__style__`''' -- CSS 形式でレコードを整形できます。
+
+'''例:''' ''マイルストーン別未解決チケット (優先度別色付け)''
+{{{
+SELECT p.value AS __color__,
+     t.milestone AS __group__,
+     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
+       t.id AS ticket, summary
+  FROM ticket t,enum p
+  WHERE t.status IN ('new', 'assigned', 'reopened') 
+    AND p.name=t.priority AND p.type='priority'
+  ORDER BY t.milestone, p.value, t.severity, t.time
+}}}
+
+'''Note:''' ''ticket'' 表の優先度に対応する数値は、 ''enum'' 表を結合することで
+取り出しています。
+
+=== 行単位のレイアウト変更 ===
+デフォルトでは、全てのカラムで1行を使い、上記の指定がされていれば、
+フォーマットされた形式で HTML に表示されます。それだけでなく、
+これから挙げる指定によって、複数行にわたってのレイアウトを行うことができます。
+
+ * '''`column_`''' -- ''改行''。 カラム名の語尾にアンダースコア ('_') を付与した場合、以降のカラムは次の行で表示されます。
+
+ * '''`_column_`''' -- ''全行表示''。 カラム名の前後にアンダースコア ('_') を付与した場合、そのカラムは続く行で全てのカラム幅を使って表示されます。
+
+ * '''`_column`'''  --  ''データを非表示にする''。 カラム名の語頭にアンダースコア ('_') を付与した場合、 HTML 出力では非表示になります。これは (CSV や RSS のような) 別フォーマットでのダウンロード時にだけ見たい情報であるときに使います。
+
+'''例:''' ''アクティブなチケットを、マイルストーンでグループ化し、優先度で色付け、チケットの説明を multi-line レイアウトでリスト表示する''
+
+{{{
+SELECT p.value AS __color__,
+       t.milestone AS __group__,
+       (CASE owner 
+          WHEN 'daniel' THEN 'font-weight: bold; background: red;' 
+          ELSE '' END) AS __style__,
+       t.id AS ticket, summary AS summary_,             -- ## ここで改行する
+       component,version, severity, milestone, status, owner,
+       time AS created, changetime AS modified,         -- ## 日付形式で整形
+       description AS _description_,                    -- ## 全行を使用して表示
+       changetime AS _changetime, reporter AS _reporter -- ## HTML 出力では表示しない
+  FROM ticket t,enum p
+  WHERE t.status IN ('new', 'assigned', 'reopened') 
+    AND p.name=t.priority AND p.type='priority'
+  ORDER BY t.milestone, p.value, t.severity, t.time
+}}}
+
+=== カスタムフィールドをレポートで使用する ===
+
+チケットにカスタムフィールドを追加した場合(バージョン 0.8 では実験的な機能でした。 TracTicketsCustomFields 参照)、カスタムフィールドを含む SQL クエリを書くことができます。 ticket_custom テーブルを join をする必要がありますが、これは取り立てて簡単というわけではありません。
+
+追加のフィールドを trac.ini に宣言する ''前に'' 、チケットがデータベースに存在する場合、 ticket_custom テーブルには関連するデータを持たないことになります。これに起因する問題を回避するためには SQL の "LEFT OUTER JOIN" 節を使用してください。
+
+----
+See also: TracTickets, TracQuery, TracGuide