Changes between Version 3 and Version 4 of TracReports


Ignore:
Timestamp:
Dec 31, 2005, 5:43:43 PM (18 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v3 v4  
    1 = Trac Reports =
     1= レポート =
    22[[TracGuideToc]]
    33
    4 The Trac reports module provides a simple, yet powerful reporting facility
    5 to present information about tickets in the Trac database.
    6 
    7 Rather 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 be disabling the former in [wiki:TracIni trac.ini]:''
     4レポートモジュールは、簡単かつ強力なレポーティング機能を提供します。
     5この機能によって、 Trac データベースのチケット情報を取得することができます。
     6
     7TracReports ではレポートの形式を定義するための方法として、独自フォーマットではなく、
     8SQL の `SELECT` 文を使用することにしました。
     9
     10  '''Note:''' ''現在の形式のレポートモジュールは、 Trac 開発チームでデータベースのスキーマにあわせる作業が必要になるという深刻な制限事項があるため、段階的に廃止します。より柔軟性に富みユーザビリティに優れた [wiki:TracQuery クエリモジュール] が代替手段として提供されます。どこかの時点でレポートモジュールを完全に削除することが出来るように、クエリモジュールで実現できないレポートがある間は、私たちはクエリモジュールを強化していくつもりです。また、これはレポートモジュールへの重要な機能追加は行わないことを意味します。''
     11
     12  ''すでにレポートモジュールをクエリモジュールで完全に置き換えられる場合、 [wiki:TracIni trac.ini] に以下の記述を追加して無効化してください:''
    1313  {{{
    1414  [components]
    1515  trac.ticket.report.* = disabled
    1616  }}}
    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 A report consists of these basic parts:
    20  * '''ID''' -- Unique (sequential) identifier
    21  * '''Title'''  -- Descriptive title
    22  * '''Description'''  -- A brief description of the report, in WikiFormatting text.
    23  * '''Report Body''' -- List of results from report query, formatted according to the methods described below.
    24  * '''Footer''' -- Links to alternative download formats for this report.
    25 
    26 == Changing Sort Order ==
    27 Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header.
    28 
    29 If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
    30 
    31 
    32 == Alternate Download Formats ==
    33 Aside from the default HTML view, reports can also be exported in a number of alternate formats.
    34 At the bottom of the report page, you will find a list of available data formats. Click the desired link to
    35 download the alternate report format.
    36 
    37 === Comma-delimited - CSV (Comma Separated Values) ===
    38 Export the report as plain text, each row on its own line, columns separated by a single comma (',').
    39 '''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure.
    40 
    41 === Tab-delimited ===
    42 Like above, but uses tabs (\t) instead of comma.
     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) ===
     381レコードを1行として、各カラムをカンマ (',') で区切ったプレーンテキストとしてダウンロードできます。
     39'''Note:''' CSV形式を保つため、各カラムのデータに改行文字やカンマがある場合、その位置で切り取られます。
     40
     41=== タブ区切り ===
     42CSV と似ていますが、水平タブ文字 (\t) で区切られる点が違います。
    4343
    4444=== RSS - XML Content Syndication ===
    45 All 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.
    46 
    47 ----
    48 
    49 == Creating Custom Reports ==
    50 
    51 ''Creating a custom report requires a comfortable knowledge of SQL.''
    52 
    53 A report is basically a single named SQL query, executed and presented by
    54 Trac.  Reports can be viewed and created from a custom SQL expression directly
    55 in from the web interface.
    56 
    57 Typically, a report consists of a SELECT-expression from the 'ticket' table,
    58 using the available columns and sorting the way you want it.
    59 
    60 == Ticket columns ==
    61 The ''ticket'' table has the following columns:
    62  * 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 See TracTickets for a detailed description of the column fields.
    79 
    80 '''all active tickets, sorted by priority and time'''
    81 
    82 '''Example:''' ''All active tickets, sorted by priority and time''
     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' 表に対する、カラムの選択や、ソート指定を伴った
     58SELECT 文となります。
     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'''例:''' ''優先度順、登録日時順の全未解決チケット''
    8383{{{
    8484SELECT id AS ticket, status, severity, priority, owner,
     
    9292
    9393
    94 == Advanced Reports: Dynamic Variables ==
    95 For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
    96 In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution.
    97 
    98 === Using Variables in a Query ===
    99 The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
    100 
    101 Example:
     94== 上級トピック: 動的変数の使用 ==
     95レポートに汎用性を持たせる手段として、 ''動的変数'' をレポート SQL で使用する方法があります。
     96簡単に言うと、動的変数とは、クエリを実行する前に置き換えられる ''特別な'' 文字列のことです。
     97
     98=== クエリで動的変数を使う方法 ===
     99動的変数を使うためのシンタックスは単純です。 '$' に続いて、大文字で変数名となる語を挿入してください。
     100
     101:
    102102{{{
    103103SELECT id AS ticket,summary FROM ticket WHERE priority='$PRIORITY'
    104104}}}
    105105
    106 To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the the leading '$'.
    107 
    108 Example:
     106レポート閲覧時、 $PRIORITY に値を当てはめるためには、レポートの URL に引数として変数を与えてください。この変数名に '$' を入れてはいけません。
     107
     108:
    109109{{{
    110110 http://projects.edgewall.com/trac/reports/14?PRIORITY=high
    111111}}}
    112112
    113 To use multiple variables, separate them with an '&'.
    114 
    115 Example:
     113複数の値を使用する場合、各値を'&'で区切ります。
     114
     115:
    116116{{{
    117117 http://projects.edgewall.com/trac/reports/14?PRIORITY=high&SEVERITY=critical
     
    119119
    120120
    121 === Special/Constant Variables ===
    122 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.
    123 
    124  * $USER -- Username of logged in user.
    125 
    126 Example (''List all tickets assigned to me''):
     121=== 特殊な定数 ===
     122実用的なレポートのために、定義済みの動的変数が用意されています。これらは URL に値を設定しなくても、自動的に値が割り当てられます。
     123
     124 * $USER -- ログインに使用したユーザ名。
     125
     126例 (''私が担当になっているチケット一覧''):
    127127{{{
    128128SELECT id AS ticket,summary FROM ticket WHERE owner='$USER'
     
    133133
    134134
    135 == Advanced Reports: Custom Formatting ==
    136 Trac is also capable of more advanced reports, including custom layouts,
    137 result grouping and user-defined CSS styles. To create such reports, we'll use
    138 specialized SQL statements to control the output of the Trac report engine.
    139 
    140 == Special Columns ==
    141 To format reports, TracReports looks for 'magic' column names in the query
    142 result. These 'magic' names are processed and affect the layout and style of the
    143 final report.
    144 
    145 === Automatically formatted columns ===
    146  * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.
    147  * '''created, modified, date, time''' -- Format cell as a date and/or time.
    148 
    149  * '''description''' -- Ticket description field, parsed through the wiki engine.
    150 
    151 '''Example:'''
     135== 上級トピック: 表示形式のカスタマイズ ==
     136Trac には、レイアウトのカスタマイズや、グルーピング、ユーザ定義の CSS 利用などによる
     137もっと複雑なレポートの作成も可能です。このようなレポートを作成するには、
     138Trac のレポートエンジンが出力を制御するためのステートメントを含む、特別な SQL を使用します。
     139
     140== 特別なカラム ==
     141レポートを整形するため、 TracReports はクエリの結果から '特定の' カラム名を
     142探します。このような '特定の' 名前で、最終的なレポートのレイアウトやスタイルが
     143処理され、変更されます。
     144
     145=== 自動的に整形されるカラム名 ===
     146 * '''ticket''' -- チケットの ID が入っているカラムで使用します。該当する ID のカラムにハイパーリンクされます。
     147 * '''created, modified, date, time''' -- 日付や時刻に整形されます。
     148
     149 * '''description''' -- チケットの説明が入っているカラムで使用します。 Wiki エンジンで処理されます。
     150
     151''':'''
    152152{{{
    153153SELECT id as ticket, created, status, summary FROM ticket
    154154}}}
    155155
    156 === Custom formatting columns ===
    157 Columns whose names begin and end with 2 underscores (Example: '''_''''''_color_''''''_''') are
    158 assumed to be ''formatting hints'', affecting the appearance of the row.
     156=== 整形されるカラムのカスタマイズ ===
     157カラム名の前後に 2 つのアンダースコアがついている場合 (例: '''_''''''_color_''''''_''') は、
     158''整形用のヒント'' として扱われ、レコードの整形が行われます。
    159159 
    160  * '''_''''''_group_''''''_''' -- Group results based on values in this column. Each group will have its own header and table.
    161  * '''_''''''_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.
    162  * '''_''''''_style_''''''_''' -- A custom CSS style expression to use for the current row.
    163 
    164 '''Example:''' ''List active tickets, grouped by milestone, colored by priority''
     160 * '''_''''''_group_''''''_''' -- 指定されたカラムで、表示がグループ化されます。各グループは、それぞれセクションヘッダとクエリ結果の表を持ちます。
     161 * '''_''''''_color_''''''_''' -- 1 から 5 の数値である必要があります。値によって、あらかじめ定義された色付けが行われます。一般的な使用法は、優先度別の色付けです。
     162 * '''_''''''_style_''''''_''' -- CSS 形式でレコードを整形できます。
     163
     164'''例:''' ''マイルストーン別未解決チケット (優先度別色付け)''
    165165{{{
    166166SELECT p.value AS __color__,
     
    174174}}}
    175175
    176 '''Note:''' A table join is used to match ''ticket'' priorities with their
    177 numeric representation from the ''enum'' table.
    178 
    179 === Changing layout of report rows ===
    180 By default, all columns on each row are display on a single row in the HTML
    181 report, possibly formatted according to the descriptions above. However, it's
    182 also possible to create multi-line report entries.
    183 
    184  * '''column_''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line.
    185 
    186  * '''_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.
    187 
    188  * '''_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).
    189 
    190 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     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 レイアウトでリスト表示する''
    191191
    192192{{{
     
    196196          WHEN 'daniel' THEN 'font-weight: bold; background: red;'
    197197          ELSE '' END) AS __style__,
    198        t.id AS ticket, summary AS summary_,             -- ## Break line here
     198       t.id AS ticket, summary AS summary_,             -- ## ここで改行する
    199199       component,version, severity, milestone, status, owner,
    200        time AS created, changetime AS modified,         -- ## Dates are formatted
    201        description AS _description_,                    -- ## Uses a full row
    202        changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
     200       time AS created, changetime AS modified,         -- ## 日付形式で整形
     201       description AS _description_,                    -- ## 全行を使用して表示
     202       changetime AS _changetime, reporter AS _reporter -- ## HTML 出力では表示しない
    203203  FROM ticket t,enum p
    204204  WHERE t.status IN ('new', 'assigned', 'reopened')
     
    207207}}}
    208208
    209 === Reporting on custom fields ===
    210 
    211 If you have added custom fields to your tickets (experimental feature in 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.
    212 
    213 If 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.
     209=== カスタムフィールドをレポートで使用する ===
     210
     211チケットにカスタムフィールドを追加した場合(バージョン0.8では実験的な機能でした。TracTicketsCustomFields 参照)、カスタムフィールドを含むSQLクエリを書くことができます。 ticket_custom テーブルを join をする必要がありますが、これは取り立てて簡単というわけではありません。
     212
     213追加のフィールドを trac.ini に宣言する ''前に'' 、チケットがデータベースに存在する場合、 ticket_custom テーブルには関連するデータを持たないことになります。これに起因する問題を回避するためには SQL の "LEFT OUTER JOIN" 節を使用してください。
    214214
    215215----