Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
May 13, 2012, 9:15:45 PM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v1 v2  
    1 = レポート =
     1= レポート = #TracReports
    22[[TracGuideToc]]
    33
     
    1515  trac.ticket.report.* = disabled
    1616  }}}
    17   ''これによって、ナビゲーションバーの "チケットを見る" でのデフォルトのハンドラがクエリモジュールになります。もし可能ならば、この設定を有効にして、レポート機能がなくなることによって生じる不都合を報告してください。''
     17  ''これによって、ナビゲーションバーの "チケットを見る" (英語版では "View Tickets") でのデフォルトのハンドラがクエリモジュールになります。もし可能ならば、この設定を有効にして、レポート機能がなくなることによって生じる不都合を報告してください。''
     18
    1819
    1920レポートは以下の基本的なパーツから構成されます:
    20  * '''ID''' -- ユニークな (連番の) 識別子
    21  * '''レポート名 (Title)''' -- レポートのタイトル
    22  * '''説明 (Description)''' -- WikiFormatting で記述された、レポートの説明。
    23  * '''レポート本体 (Report Body)''' -- 後に述べるフォーマットで規定された、レポートクエリの結果。
    24  * '''フッタ (Footer)''' -- レポート本体を異なる形式でダウンロードするためのリンク。
    25 
    26 == ソートの並び順変更 ==
     21 * '''ID''' ユニークな (連番の) 識別子
     22 * '''レポート名 (Title)''' レポートのタイトル
     23 * '''説明 (Description)''' WikiFormatting で記述された、レポートの説明。
     24 * '''レポート本体 (Report Body)''' 後に述べるフォーマットで規定された、レポートクエリの結果。
     25 * '''フッタ (Footer)''' レポート本体を異なる形式でダウンロードするためのリンク。
     26
     27== ソートの並び順変更 == #ChangingSortOrder
    2728単純なレポート (特にグループ化されていないもの) では、カラムのヘッダをクリックすれば、そのカラムでソートすることが出来ます。
    2829
    2930カラムのヘッダがハイパーリンク (赤) になっていれば、クリックすることでそのカラムでのソートができます。並び順を逆にするには、もう一度クリックします。
    3031
    31 
    32 == ダウンロードできるフォーマット ==
     32== レポートの番号を変更する == #ChangingReportNumbering
     33レポートの ID を変更する必要がある場合があるかもしれませんが、おそらくレポート自体を編集する方がベターです。というのも Trac のデータベースを変更する必要があるからです。 ''report'' 表は以下のようなスキーマとなっています ''(0.10 以降)'':
     34 * id integer PRIMARY KEY
     35 * author text
     36 * title text
     37 * query text
     38 * description text
     39ID を変更すると ''レポート一覧 (Available Reports)'' での表示順と番号、レポートのパーマリンクが変更されます。以下のような SQL を実行すると ID が変更されます:
     40{{{
     41update report set id=5 where id=3;
     42}}}
     43メンテナンス結果、データベースの一貫性を保つ必要があることに留意してください (例えば ID はユニークでなければなりませんし、 SQLite などデータベースの上限値を超えることはできません)。
     44
     45保存されたレポートやクエリのレポート番号も更新したり削除したりする必要があるでしょう。
     46
     47== チケットをナビゲート == #NavigatingTickets
     48レポートクエリ結果の 1 チケットをクリックするとそのチケットが表示されるでしょう。表示されたチケットのメインメニューバーのすぐ下にある ''次のチケット'' (英語版では ''Next Ticket'') または ''前のチケット'' (英語版では ''Previous Ticket'') リンクをクリックすることによって他のチケットに移動するか、''レポートに戻る'' (英語版では ''Back to Report'') リンクをクリックしてレポートページに戻ることができます。
     49
     50あなたは安全にチケットを編集することができます。またチケットの編集結果を保存した後で、 ''次のチケット/前のチケット/レポートに戻る'' (英語版では ''!Next/Previous/Back to Report'') のリンクを使用して結果を行き来することが可能です。しかし、あなたがチケットへの操作を終えてレポートに戻るときに、どのチケットが変更されたかのヒントは表示されません。この動作はカスタムクエリの動作とは異なります。 (カスタムクエリについては TracQuery#NavigatingTickets を参照して下さい) 。 ''(0.11 以降 )''
     51
     52== ダウンロードできるフォーマット == #AlternativeDownloadFormats
    3353通常表示される HTML でのビューの加え、レポートはいろいろな形式で使用することができます。
    3454レポートページの一番下に、利用可能なデータ形式の一覧があります。望む形式のリンクをクリックすれば、
    3555その形式でのレポートをダウンロードすることができます。
    3656
    37 === カンマ区切りテキスト - CSV (Comma Separated Values) ===
     57=== カンマ区切りテキスト - CSV (Comma Separated Values) === #Comma-delimited-CSVCommaSeparatedValues
    38581 レコードを 1 行として、各カラムをカンマ (',') で区切ったプレーンテキストとしてダウンロードできます。
    39 '''Note:''' CSV 形式を保つため、各カラムのデータに改行文字やカンマがある場合、その位置で切り取られます。
    40 
    41 === タブ区切り ===
     59'''Note:''' 各カラムのデータに改行文字やカンマがある場合、エスケープされて出力されます。
     60
     61=== タブ区切り === #Tab-delimited
    4262CSV と似ていますが、水平タブ文字 (\t) で区切られる点が違います。
    4363
    44 === RSS - XML Content Syndication ===
     64=== RSS - XML コンテンツ配信 === #RSS-XMLContentSyndication
    4565全てのレポートは、 XML/RSS 2.0 での配信が可能です。 RSS フィードを購読するにはページ下部にある、オレンジ色の 'XML' アイコンをクリックしてください。 Trac での RSS 対応についての一般的な情報は、 TracRss に記述しています。
    4666
    4767----
    4868
    49 == カスタムレポートを作成する ==
     69== カスタムレポートを作成する == #CreatingCustomReports
    5070
    5171''カスタムレポートを作成するためには、 SQL を楽に書ける程度の知識が必要です。''
     
    5878SELECT 文となります。
    5979
    60 == Ticket 表のカラム ==
     80== Ticket 表のカラム == #Ticketcolumns
    6181''ticket'' 表は、以下のカラムを持ちます:
    6282 * id           -- チケットID
     83 * type         -- チケット分類
    6384 * time         -- 登録日時
    6485 * changetime   -- 最終更新日時
     
    7596 * summary      -- チケットの概要
    7697 * description  -- チケットについての完全な説明
     98 * keywords     -- キーワード
    7799
    78100各カラムに対応する属性の詳細な説明は、 TracTickets に記述しています。
    79101
    80 '''優先度順、登録日時順の全未解決チケット'''
    81 
    82 '''例:''' ''優先度順、登録日時順の全未解決チケット''
     102例: '''優先度順、登録日時順の全未解決チケット'''
    83103{{{
    84104SELECT id AS ticket, status, severity, priority, owner,
    85        time as created, summary FROM ticket
     105       time AS created, summary FROM ticket
    86106  WHERE status IN ('new', 'assigned', 'reopened')
    87107  ORDER BY priority, time
    88108}}}
    89109
    90 
    91 ----
    92 
    93 
    94 == 上級トピック: 動的変数の使用 ==
     110---
     111
     112== 上級トピック: 動的変数の使用 == #AdvancedReports:DynamicVariables
    95113レポートに汎用性を持たせる手段として、 ''動的変数'' をレポート SQL で使用する方法があります。
    96114簡単に言うと、動的変数とは、クエリを実行する前に置き換えられる ''特別な'' 文字列のことです。
    97115
    98 === クエリで動的変数を使う方法 ===
     116=== クエリで動的変数を使う方法 === #UsingVariablesinaQuery
    99117動的変数を使うためのシンタックスは単純です。 '$' に続いて、大文字で変数名となる語を挿入してください。
    100118
    101119例:
    102120{{{
    103 SELECT id AS ticket,summary FROM ticket WHERE priority='$PRIORITY'
     121SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
    104122}}}
    105123
     
    119137
    120138
    121 === 特殊な定数 ===
    122 実用的なレポートのために、定義済みの動的変数が用意されています。これらは URL に値を設定しなくても、自動的に値が割り当てられます。
     139=== 特殊な定数 === #SpecialConstantVariables
     140実用的なレポートにするために、自動的に値が設定される動的変数が用意されています。(URL で指定されると上書かれます)
    123141
    124142 * $USER -- ログインに使用したユーザ名。
     
    126144例 (''私が担当になっているチケット一覧''):
    127145{{{
    128 SELECT id AS ticket,summary FROM ticket WHERE owner='$USER'
     146SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
    129147}}}
    130148
     
    133151
    134152
    135 == 上級トピック: 表示形式のカスタマイズ ==
     153== 上級トピック: 表示形式のカスタマイズ == #AdvancedReports:CustomFormatting
    136154Trac には、レイアウトのカスタマイズや、グルーピング、ユーザ定義の CSS 利用などによる
    137155もっと複雑なレポートの作成も可能です。このようなレポートを作成するには、
    138156Trac のレポートエンジンが出力を制御するためのステートメントを含む、特別な SQL を使用します。
    139157
    140 == 特別なカラム ==
     158== 特別なカラム == #SpecialColumns
    141159レポートを整形するため、 TracReports はクエリの結果から '特定の' カラム名を
    142160探します。このような '特定の' 名前で、最終的なレポートのレイアウトやスタイルが
    143161処理され、変更されます。
    144162
    145 === 自動的に整形されるカラム名 ===
    146  * '''ticket''' -- チケットの ID が入っているカラムで使用します。該当する ID のカラムにハイパーリンクされます。
    147  * '''created, modified, date, time''' -- 日付や時刻に整形されます。
    148 
    149  * '''description''' -- チケットの説明が入っているカラムで使用します。 Wiki エンジンで処理されます。
     163=== 自動的に整形されるカラム名 === #Automaticallyformattedcolumns
     164 * '''ticket''' — チケットの ID が入っているカラムで使用します。該当する ID のカラムにハイパーリンクされます。 (訳注: `summary` というカラム名もチケットにハイパーリンクされます。日本語版では `概要` でもリンクします。)
     165 * '''id''' — '''realm''' が指定されない場合は、 '''ticket''' と同じです。
     166 * '''realm''' — '''id''' と同時に使用します。チケット以外のリソースにリンクを行う場合に使用します。 (e.g. ''wiki'' のレルムに ''id'' としてページ名を組み合わせると、 Wiki ページへのリンクを生成します)
     167 * '''created, modified, date, time''' — 日付や時刻に整形されます。 (訳注: `datetime` という列名にすると日時で整形されます。日本語版では `時刻` で終わるカラムは `time` に、 `日付` で終わるカラムは `date` に、 `日時` で終わるカラムは `datetime` に、それぞれ整形されます。)
     168 * '''description''' — チケットの説明が入っているカラムで使用します。 Wiki エンジンで処理されます。 (訳注: 日本語版では `説明` でも整形されます。)
    150169
    151170'''例:'''
    152171{{{
    153 SELECT id as ticket, created, status, summary FROM ticket
    154 }}}
    155 
    156 === 整形されるカラムのカスタマイズ ===
     172SELECT id AS ticket, created, status, summary FROM ticket
     173}}}
     174
     175これらのカラムは定義しても非表示にすることができます。方法は [#column-syntax 下記] を参照してください。
     176
     177''ticket'' 以外のレルムに対するレポートの作成方法については [http://trac.edgewall.org/wiki/CookBook/Configuration/Reports CookBook/Configuration/Reports] を参照してください。
     178
     179'''訳注''': Trac-0.11.1.ja1 以降のバージョンで作成した Environment では、デフォルトのレポートに日本語での整形ルールが適用されています。このような Environment を本家版 Trac で使用したい場合は各レポートの SQL を編集し、上記の日本語のカラム別名を英語に変更してください。
     180
     181=== 整形されるカラムのカスタマイズ === #Customformattingcolumns
    157182カラム名の前後に 2 つのアンダースコアがついている場合 (例: '''`__color__`''') は、
    158183''整形用のヒント'' として扱われ、レコードの整形が行われます。
    159184 
    160  * '''`__group__`''' -- 指定されたカラムで、表示がグループ化されます。各グループは、それぞれセクションヘッダとクエリ結果の表を持ちます。
    161  * '''`__color__`''' -- 1 から 5 の数値である必要があります。値によって、あらかじめ定義された色付けが行われます。一般的な使用法は、優先度別の色付けです。
    162  * '''`__style__`''' -- CSS 形式でレコードを整形できます。
    163 
    164 '''例:''' ''マイルストーン別未解決チケット (優先度別色付け)''
     185 * '''`__group__`''' — 指定されたカラムで、表示がグループ化されます。各グループは、それぞれセクションヘッダとクエリ結果の表を持ちます。
     186 * '''`__grouplink__`''' — グループ化した場合の各グループのヘッダで生成するリンク先の URL を指定します。この URL は各グループの最初の行にだけ付与されます。
     187 * '''`__color__`''' — 1 から 5 の数値である必要があります。値によって、あらかじめ定義された色付けが行われます。一般的な使用法は、優先度別の色付けです。
     188{{{
     189#!html
     190<div style="margin-left:7.5em">デフォルトの色付け:
     191<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
     192<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
     193<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span>
     194<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span>
     195<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span>
     196</div>
     197}}}
     198 * '''`__style__`''' — CSS 形式でレコードを整形できます。
     199
     200'''例:''' ''マイルストーン別未解決チケット (優先度別色付け, グループのヘッダでマイルストーンにリンク)''
    165201{{{
    166202SELECT p.value AS __color__,
    167203     t.milestone AS __group__,
     204     '../milestone/' || t.milestone AS __grouplink__,
    168205     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
    169206       t.id AS ticket, summary
     
    177214取り出しています。
    178215
    179 === 行単位のレイアウト変更 ===
     216=== 行単位のレイアウト変更 === #column-syntax
    180217デフォルトでは、全てのカラムで1行を使い、上記の指定がされていれば、
    181218フォーマットされた形式で HTML に表示されます。それだけでなく、
    182219これから挙げる指定によって、複数行にわたってのレイアウトを行うことができます。
    183220
    184  * '''`column_`''' -- ''改行''。 カラム名の語尾にアンダースコア ('_') を付与した場合、以降のカラムは次の行で表示されます。
    185 
    186  * '''`_column_`''' -- ''全行表示''。 カラム名の前後にアンダースコア ('_') を付与した場合、そのカラムは続く行で全てのカラム幅を使って表示されます。
    187 
    188  * '''`_column`'''  --  ''データを非表示にする''。 カラム名の語頭にアンダースコア ('_') を付与した場合、 HTML 出力では非表示になります。これは (CSV や RSS のような) 別フォーマットでのダウンロード時にだけ見たい情報であるときに使います。
     221 * '''`column_`''' — ''改行''。 カラム名の語尾にアンダースコア ('_') を付与した場合、以降のカラムは次の行で表示されます。
     222
     223 * '''`_column_`''' — ''全行表示''。 カラム名の前後にアンダースコア ('_') を付与した場合、そのカラムは続く行で全てのカラム幅を使って表示されます。
     224
     225 * '''`_column`'''  —  ''データを非表示にする''。 カラム名の語頭にアンダースコア ('_') を付与した場合、 HTML 出力では非表示になります。これは (CSV や RSS のような) 別フォーマットでのダウンロード時にだけ見たい情報であるときに使います。
     226   この機能ではあらゆるカラムを非表示にできます。リソースの特定などで他のカラムが異存しているような場合に有用です。たとえば `id as _id` とすることで、 '''Id''' カラムは非表示となりますが、チケットへのリンクは正しく生成されます。
    189227
    190228'''例:''' ''アクティブなチケットを、マイルストーンでグループ化し、優先度で色付け、チケットの説明を multi-line レイアウトでリスト表示する''
     
    207245}}}
    208246
    209 === カスタムフィールドをレポートで使用する ===
    210 
    211 チケットにカスタムフィールドを追加した場合(バージョン 0.8 では実験的な機能でした。 TracTicketsCustomFields 参照)、カスタムフィールドを含む SQL クエリを書くことができます。 ticket_custom テーブルを join をする必要がありますが、これは取り立てて簡単というわけではありません。
     247=== カスタムフィールドをレポートで使用する === #Reportingoncustomfields
     248
     249チケットにカスタムフィールドを追加した場合(バージョン 0.8 以降の機能。 TracTicketsCustomFields 参照)、カスタムフィールドを含む SQL クエリを書くことができます。 ticket_custom テーブルを join をする必要がありますが、これは取り立てて簡単というわけではありません。
    212250
    213251追加のフィールドを trac.ini に宣言する ''前に'' 、チケットがデータベースに存在する場合、 ticket_custom テーブルには関連するデータを持たないことになります。これに起因する問題を回避するためには SQL の "LEFT OUTER JOIN" 節を使用してください。
    214252
     253'''Note レポートの追加、編集をするボタンを表示するためには権限を設定する必要があります。'''
     254
    215255----
    216 See also: TracTickets, TracQuery, TracGuide
     256See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]