Changes between Version 5 and Version 6 of TracReports


Ignore:
Timestamp:
Jan 28, 2010, 4:25:36 AM (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracReports

    v5 v6  
    1 = レポート =
     1= Trac Reports =
    22[[TracGuideToc]]
    33
    4 レポートモジュールは、簡単かつ強力なレポーティング機能を提供します。
    5 この機能によって、 Trac データベースのチケット情報を取得することができます。
    6 
    7 TracReports ではレポートの形式を定義するための方法として、独自フォーマットではなく、
    8 SQL の `SELECT` 文を使用することにしました。
    9 
    10   '''Note:''' ''現在の形式のレポートモジュールは、 Trac 開発チームでデータベースのスキーマにあわせる作業が必要になるという深刻な制限事項があるため、段階的に廃止します。より柔軟性に富みユーザビリティに優れた [wiki:TracQuery クエリモジュール] が代替手段として提供されます。どこかの時点でレポートモジュールを完全に削除することが出来るように、クエリモジュールで実現できないレポートがある間は、私たちはクエリモジュールを強化していくつもりです。また、これはレポートモジュールへの重要な機能追加は行わないことを意味します。''
    11 
    12   ''以下の [wiki:TracIni trac.ini] のように無効化するだけで、レポートモジュールをクエリモジュールで完全に置き換えることができます:''
     4The Trac reports module provides a simple, yet powerful reporting facility
     5to present information about tickets in the Trac database.
     6
     7Rather than have its own report definition format, TracReports relies on standard SQL
     8`SELECT` statements for custom report definition.
     9
     10  '''Note:''' ''The report module is being phased out in its current form because it seriously limits the ability of the Trac team to make adjustments to the underlying database schema. We believe that the [wiki:TracQuery query module] is a good replacement that provides more flexibility and better usability. While there are certain reports that cannot yet be handled by the query module, we intend to further enhance it so that at some point the reports module can be completely removed. This also means that there will be no major enhancements to the report module anymore.''
     11
     12  ''You can already completely replace the reports module by the query module simply by disabling the former in [wiki:TracIni trac.ini]:''
    1313  {{{
    1414  [components]
    1515  trac.ticket.report.* = disabled
    1616  }}}
    17   ''これによって、ナビゲーションバーの "チケットを見る" でのデフォルトのハンドラがクエリモジュールになります。もし可能ならば、この設定を有効にして、レポート機能がなくなることによって生じる不都合を報告してください。''
    18 
    19 レポートは以下の基本的なパーツから構成されます:
    20  * '''ID''' -- ユニークな (連番の) 識別子
    21  * '''レポート名 (Title)''' -- レポートのタイトル
    22  * '''説明 (Description)''' -- WikiFormatting で記述された、レポートの説明。
    23  * '''レポート本体 (Report Body)''' -- 後に述べるフォーマットで規定された、レポートクエリの結果。
    24  * '''フッタ (Footer)''' -- レポート本体を異なる形式でダウンロードするためのリンク。
    25 
    26 == ソートの並び順変更 ==
    27 単純なレポート (特にグループ化されていないもの) では、カラムのヘッダをクリックすれば、そのカラムでソートすることが出来ます。
    28 
    29 カラムのヘッダがハイパーリンク (赤) になっていれば、クリックすることでそのカラムでのソートができます。並び順を逆にするには、もう一度クリックします。
    30 
    31 
    32 == ダウンロードできるフォーマット ==
    33 通常表示される HTML でのビューの加え、レポートはいろいろな形式で使用することができます。
    34 レポートページの一番下に、利用可能なデータ形式の一覧があります。望む形式のリンクをクリックすれば、
    35 その形式でのレポートをダウンロードすることができます。
    36 
    37 === カンマ区切りテキスト - CSV (Comma Separated Values) ===
    38 1 レコードを 1 行として、各カラムをカンマ (',') で区切ったプレーンテキストとしてダウンロードできます。
    39 '''Note:''' CSV 形式を保つため、各カラムのデータに改行文字やカンマがある場合、その位置で切り取られます。
    40 
    41 === タブ区切り ===
    42 CSV と似ていますが、水平タブ文字 (\t) で区切られる点が違います。
     17  ''This will make the query module the default handler for the “View Tickets” navigation item. We encourage you to try this configuration and report back what kind of features of reports you are missing, if any.''
     18
     19  '''''You will almost definitely need to restart your httpd at this point.'''''
     20
     21A report consists of these basic parts:
     22 * '''ID''' -- Unique (sequential) identifier
     23 * '''Title'''  -- Descriptive title
     24 * '''Description'''  -- A brief description of the report, in WikiFormatting text.
     25 * '''Report Body''' -- List of results from report query, formatted according to the methods described below.
     26 * '''Footer''' -- Links to alternative download formats for this report.
     27
     28== Changing Sort Order ==
     29Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header.
     30
     31If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
     32
     33== Changing Report Numbering ==
     34There may be instances where you need to change the ID of the report, perhaps to organize the reports better. At present this requires changes to the trac database. The ''report'' table has the following schema (as of 0.10):
     35 * id integer PRIMARY KEY
     36 * author text
     37 * title text
     38 * query text
     39 * description text
     40Changing the ID changes the shown order and number in the ''Available Reports'' list and the report's perma-link. This is done by running something like:
     41{{{
     42update report set id=5 where id=3;
     43}}}
     44Keep in mind that the integrity has to be maintained (i.e., ID has to be unique, and you don't want to exceed the max, since that's managed by SQLite someplace).
     45
     46== Navigating Tickets ==
     47Clicking on one of the report results will take you to that ticket. You can navigate through the results by clicking the ''Next Ticket'' or ''Previous Ticket'' links just below the main menu bar, or click the ''Back to Report'' link to return to the report page.
     48
     49You can safely edit any of the tickets and continue to navigate through the results using the Next/Previous/Back to Report links after saving your results, but when you return to the report, there will be no hint about what has changed, as would happen if you were navigating a list of tickets obtained from a query (see TracQuery#NavigatingTickets). ''(since 0.11)''
     50
     51== Alternative Download Formats ==
     52Aside from the default HTML view, reports can also be exported in a number of alternative formats.
     53At the bottom of the report page, you will find a list of available data formats. Click the desired link to
     54download the alternative report format.
     55
     56=== Comma-delimited - CSV (Comma Separated Values) ===
     57Export the report as plain text, each row on its own line, columns separated by a single comma (',').
     58'''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure.
     59
     60=== Tab-delimited ===
     61Like above, but uses tabs (\t) instead of comma.
    4362
    4463=== RSS - XML Content Syndication ===
    45 全てのレポートは、 XML/RSS 2.0 での配信が可能です。 RSS フィードを購読するにはページ下部にある、オレンジ色の 'XML' アイコンをクリックしてください。 Trac での RSS 対応についての一般的な情報は、 TracRss に記述しています。
    46 
    47 ----
    48 
    49 == カスタムレポートを作成する ==
    50 
    51 ''カスタムレポートを作成するためには、 SQL を楽に書ける程度の知識が必要です。''
    52 
    53 レポートは基本的に、 Trac が実行できる形式の、名前がついた特定 SQL です。
    54 レポートに指定された SQL は、直接 Web インタフェースから閲覧したり、
    55 作成したりできます。
    56 
    57 通常のレポートは、 'ticket' 表に対する、カラムの選択や、ソート指定を伴った
    58 SELECT 文となります。
    59 
    60 == Ticket 表のカラム ==
    61 ''ticket'' 表は、以下のカラムを持ちます:
    62  * id           -- チケットID
    63  * time         -- 登録日時
    64  * changetime   -- 最終更新日時
    65  * component    -- コンポーネント
    66  * severity     -- 重要度
    67  * priority     -- 優先度
    68  * owner        -- 担当者
    69  * reporter     -- 報告者
    70  * cc           -- 関係者
    71  * version      -- バージョン
    72  * milestone    -- マイルストーン
    73  * status       -- ステータス
    74  * resolution   -- 解決方法
    75  * summary      -- チケットの概要
    76  * description  -- チケットについての完全な説明
    77 
    78 各カラムに対応する属性の詳細な説明は、 TracTickets に記述しています。
    79 
    80 '''優先度順、登録日時順の全未解決チケット'''
    81 
    82 '''例:''' ''優先度順、登録日時順の全未解決チケット''
     64All reports support syndication using XML/RSS 2.0. To subscribe to an RSS feed, click the orange 'XML' icon at the bottom of the page. See TracRss for general information on RSS support in Trac.
     65
     66----
     67
     68== Creating Custom Reports ==
     69
     70''Creating a custom report requires a comfortable knowledge of SQL.''
     71
     72A report is basically a single named SQL query, executed and presented by
     73Trac.  Reports can be viewed and created from a custom SQL expression directly
     74in from the web interface.
     75
     76Typically, a report consists of a SELECT-expression from the 'ticket' table,
     77using the available columns and sorting the way you want it.
     78
     79== Ticket columns ==
     80The ''ticket'' table has the following columns:
     81 * id
     82 * type
     83 * time
     84 * changetime
     85 * component
     86 * severity 
     87 * priority
     88 * owner
     89 * reporter
     90 * cc
     91 * version
     92 * milestone
     93 * status
     94 * resolution
     95 * summary
     96 * description
     97 * keywords
     98
     99See TracTickets for a detailed description of the column fields.
     100
     101'''all active tickets, sorted by priority and time'''
     102
     103'''Example:''' ''All active tickets, sorted by priority and time''
    83104{{{
    84105SELECT id AS ticket, status, severity, priority, owner,
    … …  
    92113
    93114
    94 == 上級トピック: 動的変数の使用 ==
    95 レポートに汎用性を持たせる手段として、 ''動的変数'' をレポート SQL で使用する方法があります。
    96 簡単に言うと、動的変数とは、クエリを実行する前に置き換えられる ''特別な'' 文字列のことです。
    97 
    98 === クエリで動的変数を使う方法 ===
    99 動的変数を使うためのシンタックスは単純です。 '$' に続いて、大文字で変数名となる語を挿入してください。
    100 
    101 例:
    102 {{{
    103 SELECT id AS ticket,summary FROM ticket WHERE priority='$PRIORITY'
    104 }}}
    105 
    106 レポート閲覧時、 $PRIORITY に値を当てはめるためには、レポートの URL に引数として変数を与えてください。この変数名に '$' を入れてはいけません。
    107 
    108 例:
     115== Advanced Reports: Dynamic Variables ==
     116For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
     117In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution.
     118
     119=== Using Variables in a Query ===
     120The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
     121
     122Example:
     123{{{
     124SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
     125}}}
     126
     127To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'.
     128
     129Example:
    109130{{{
    110131 http://trac.edgewall.org/reports/14?PRIORITY=high
    111132}}}
    112133
    113 複数の値を使用する場合、各値を '&' で区切ります。
    114 
    115 例:
     134To use multiple variables, separate them with an '&'.
     135
     136Example:
    116137{{{
    117138 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    … …  
    119140
    120141
    121 === 特殊な定数 ===
    122 実用的なレポートのために、定義済みの動的変数が用意されています。これらは URL に値を設定しなくても、自動的に値が割り当てられます。
    123 
    124  * $USER -- ログインに使用したユーザ名。
    125 
    126 例 (''私が担当になっているチケット一覧''):
    127 {{{
    128 SELECT id AS ticket,summary FROM ticket WHERE owner='$USER'
    129 }}}
    130 
    131 
    132 ----
    133 
    134 
    135 == 上級トピック: 表示形式のカスタマイズ ==
    136 Trac には、レイアウトのカスタマイズや、グルーピング、ユーザ定義の CSS 利用などによる
    137 もっと複雑なレポートの作成も可能です。このようなレポートを作成するには、
    138 Trac のレポートエンジンが出力を制御するためのステートメントを含む、特別な SQL を使用します。
    139 
    140 == 特別なカラム ==
    141 レポートを整形するため、 TracReports はクエリの結果から '特定の' カラム名を
    142 探します。このような '特定の' 名前で、最終的なレポートのレイアウトやスタイルが
    143 処理され、変更されます。
    144 
    145 === 自動的に整形されるカラム名 ===
    146  * '''ticket''' -- チケットの ID が入っているカラムで使用します。該当する ID のカラムにハイパーリンクされます。
    147  * '''created, modified, date, time''' -- 日付や時刻に整形されます。
    148 
    149  * '''description''' -- チケットの説明が入っているカラムで使用します。 Wiki エンジンで処理されます。
    150 
    151 '''例:'''
     142=== Special/Constant Variables ===
     143There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.
     144
     145 * $USER -- Username of logged in user.
     146
     147Example (''List all tickets assigned to me''):
     148{{{
     149SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
     150}}}
     151
     152
     153----
     154
     155
     156== Advanced Reports: Custom Formatting ==
     157Trac is also capable of more advanced reports, including custom layouts,
     158result grouping and user-defined CSS styles. To create such reports, we'll use
     159specialized SQL statements to control the output of the Trac report engine.
     160
     161== Special Columns ==
     162To format reports, TracReports looks for 'magic' column names in the query
     163result. These 'magic' names are processed and affect the layout and style of the
     164final report.
     165
     166=== Automatically formatted columns ===
     167 * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.
     168 * '''created, modified, date, time''' -- Format cell as a date and/or time.
     169
     170 * '''description''' -- Ticket description field, parsed through the wiki engine.
     171
     172'''Example:'''
    152173{{{
    153174SELECT id as ticket, created, status, summary FROM ticket
    154175}}}
    155176
    156 === 整形されるカラムのカスタマイズ ===
    157 カラム名の前後に 2 つのアンダースコアがついている場合 (例: '''`__color__`''') は、
    158 ''整形用のヒント'' として扱われ、レコードの整形が行われます。
     177=== Custom formatting columns ===
     178Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
     179assumed to be ''formatting hints'', affecting the appearance of the row.
    159180 
    160  * '''`__group__`''' -- 指定されたカラムで、表示がグループ化されます。各グループは、それぞれセクションヘッダとクエリ結果の表を持ちます。
    161  * '''`__color__`''' -- 1 から 5 の数値である必要があります。値によって、あらかじめ定義された色付けが行われます。一般的な使用法は、優先度別の色付けです。
    162  * '''`__style__`''' -- CSS 形式でレコードを整形できます。
    163 
    164 '''例:''' ''マイルストーン別未解決チケット (優先度別色付け)''
     181 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table.
     182 * '''`__color__`''' -- Should be a numeric value ranging from 1 to 5 to select a pre-defined row color. Typically used to color rows by issue priority.
     183{{{
     184#!html
     185<div style="margin-left:7.5em">Defaults:
     186<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
     187<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
     188<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span>
     189<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span>
     190<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span>
     191</div>
     192}}}
     193 * '''`__style__`''' -- A custom CSS style expression to use for the current row.
     194
     195'''Example:''' ''List active tickets, grouped by milestone, colored by priority''
    165196{{{
    166197SELECT p.value AS __color__,
    … …  
    174205}}}
    175206
    176 '''Note:''' ''ticket'' 表の優先度に対応する数値は、 ''enum'' 表を結合することで
    177 取り出しています。
    178 
    179 === 行単位のレイアウト変更 ===
    180 デフォルトでは、全てのカラムで1行を使い、上記の指定がされていれば、
    181 フォーマットされた形式で HTML に表示されます。それだけでなく、
    182 これから挙げる指定によって、複数行にわたってのレイアウトを行うことができます。
    183 
    184  * '''`column_`''' -- ''改行''。 カラム名の語尾にアンダースコア ('_') を付与した場合、以降のカラムは次の行で表示されます。
    185 
    186  * '''`_column_`''' -- ''全行表示''。 カラム名の前後にアンダースコア ('_') を付与した場合、そのカラムは続く行で全てのカラム幅を使って表示されます。
    187 
    188  * '''`_column`'''  --  ''データを非表示にする''。 カラム名の語頭にアンダースコア ('_') を付与した場合、 HTML 出力では非表示になります。これは (CSV や RSS のような) 別フォーマットでのダウンロード時にだけ見たい情報であるときに使います。
    189 
    190 '''例:''' ''アクティブなチケットを、マイルストーンでグループ化し、優先度で色付け、チケットの説明を multi-line レイアウトでリスト表示する''
     207'''Note:''' A table join is used to match ''ticket'' priorities with their
     208numeric representation from the ''enum'' table.
     209
     210=== Changing layout of report rows ===
     211By default, all columns on each row are display on a single row in the HTML
     212report, possibly formatted according to the descriptions above. However, it's
     213also possible to create multi-line report entries.
     214
     215 * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line.
     216
     217 * '''`_column_`''' -- ''Full row''. By adding an underscore ('_') both at the beginning and the end of a column name, the data will be shown on a separate row.
     218
     219 * '''`_column`'''  --  ''Hide data''. Prepending an underscore ('_') to a column name instructs Trac to hide the contents from the HTML output. This is useful for information to be visible only if downloaded in other formats (like CSV or RSS/XML).
     220
     221'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
    191222
    192223{{{
    … …  
    196227          WHEN 'daniel' THEN 'font-weight: bold; background: red;'
    197228          ELSE '' END) AS __style__,
    198        t.id AS ticket, summary AS summary_,             -- ## ここで改行する
     229       t.id AS ticket, summary AS summary_,             -- ## Break line here
    199230       component,version, severity, milestone, status, owner,
    200        time AS created, changetime AS modified,         -- ## 日付形式で整形
    201        description AS _description_,                    -- ## 全行を使用して表示
    202        changetime AS _changetime, reporter AS _reporter -- ## HTML 出力では表示しない
     231       time AS created, changetime AS modified,         -- ## Dates are formatted
     232       description AS _description_,                    -- ## Uses a full row
     233       changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
    203234  FROM ticket t,enum p
    204235  WHERE t.status IN ('new', 'assigned', 'reopened')
    … …  
    207238}}}
    208239
    209 === カスタムフィールドをレポートで使用する ===
    210 
    211 チケットにカスタムフィールドを追加した場合(バージョン 0.8 では実験的な機能でした。 TracTicketsCustomFields 参照)、カスタムフィールドを含む SQL クエリを書くことができます。 ticket_custom テーブルを join をする必要がありますが、これは取り立てて簡単というわけではありません。
    212 
    213 追加のフィールドを trac.ini に宣言する ''前に'' 、チケットがデータベースに存在する場合、 ticket_custom テーブルには関連するデータを持たないことになります。これに起因する問題を回避するためには SQL の "LEFT OUTER JOIN" 節を使用してください。
    214 
    215 ----
    216 See also: TracTickets, TracQuery, TracGuide
     240=== Reporting on custom fields ===
     241
     242If you have added custom fields to your tickets (a feature since v0.8, see TracTicketsCustomFields), you can write a SQL query to cover them. You'll need to make a join on the ticket_custom table, but this isn't especially easy.
     243
     244If you have tickets in the database ''before'' you declare the extra fields in trac.ini, there will be no associated data in the ticket_custom table. To get around this, use SQL's "LEFT OUTER JOIN" clauses. See TracIniReportCustomFieldSample for some examples.
     245
     246'''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''
     247
     248----
     249See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]