Changes between Version 6 and Version 7 of TracReports


Ignore:
Timestamp:
08/08/15 13:07:50 (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v6 v7  
    1 ** Note: this page documents the version 1.0 of Trac, see [[0.12/TracReports]] if you need the previous version ** 
    2 = Trac Reports = 
     1= Trac Reports 
     2 
    33[[TracGuideToc]] 
    44 
    5 The Trac reports module provides a simple, yet powerful reporting facility 
    6 to present information about tickets in the Trac database. 
    7  
    8 Rather than have its own report definition format, TracReports relies on standard SQL 
    9 `SELECT` statements for custom report definition.  
    10  
    11   '''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.'' 
    12  
    13   ''You can already completely replace the reports module by the query module simply by disabling the former in [wiki:TracIni trac.ini]:'' 
    14   {{{ 
     5The Trac reports module provides a simple, yet powerful reporting facility to present information about tickets in the Trac database. 
     6 
     7Rather than have its own report definition format, TracReports relies on standard SQL `SELECT` statements for custom report definition.  
     8 
     9  '''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. 
     10 
     11  You can already completely replace the reports module by the query module simply by disabling the former in [wiki:TracIni trac.ini]: 
     12  {{{#!ini 
    1513  [components] 
    1614  trac.ticket.report.* = disabled 
    1715  }}} 
    18   ''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.'' 
     16  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. 
    1917 
    2018A report consists of these basic parts: 
     
    2523 * '''Footer''' — Links to alternative download formats for this report. 
    2624 
    27 == Changing Sort Order == 
     25== Changing Sort Order 
     26 
    2827Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header.  
    2928 
    3029If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order. 
    3130 
    32 == Changing Report Numbering == 
    33 There 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 ''(since 0.10)'': 
     31== Changing Report Numbering 
     32 
     33There 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: 
    3434 * id integer PRIMARY KEY 
    3535 * author text 
     
    3838 * description text 
    3939Changing 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: 
    40 {{{ 
    41 update report set id=5 where id=3; 
    42 }}} 
    43 Keep 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). 
     40{{{#!sql 
     41UPDATE report SET id = 5 WHERE id = 3; 
     42}}} 
     43Keep in mind that the integrity has to be maintained, ie ID has to be unique, and you don't want to exceed the max, since that's managed by SQLite someplace. 
    4444 
    4545You may also need to update or remove the report number stored in the report or query. 
    4646 
    47 == Navigating Tickets == 
     47== Navigating Tickets 
     48 
    4849Clicking 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. 
    4950 
    50 You 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)'' 
    51  
    52 == Alternative Download Formats == 
     51You 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). 
     52 
     53== Alternative Download Formats 
     54 
    5355Aside from the default HTML view, reports can also be exported in a number of alternative formats. 
    5456At the bottom of the report page, you will find a list of available data formats. Click the desired link to  
    5557download the alternative report format. 
    5658 
    57 === Comma-delimited - CSV (Comma Separated Values) === 
     59=== Comma-delimited - CSV (Comma Separated Values) 
     60 
    5861Export the report as plain text, each row on its own line, columns separated by a single comma (','). 
    5962'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output. 
    6063 
    61 === Tab-delimited === 
     64=== Tab-delimited 
     65 
    6266Like above, but uses tabs (\t) instead of comma. 
    6367 
    64 === RSS - XML Content Syndication === 
     68=== RSS - XML Content Syndication 
     69 
    6570All 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. 
    6671 
    67 ---- 
    68  
    69 == Creating Custom Reports == 
    70  
    71 ''Creating a custom report requires a comfortable knowledge of SQL.'' 
    72  
    73 '''Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.''' 
    74  
    75 A report is basically a single named SQL query, executed and presented by 
    76 Trac.  Reports can be viewed and created from a custom SQL expression directly 
    77 in the web interface. 
    78  
    79 Typically, a report consists of a SELECT-expression from the 'ticket' table, 
    80 using the available columns and sorting the way you want it. 
    81  
    82 == Ticket columns == 
     72== Creating Custom Reports 
     73 
     74Creating a custom report requires a comfortable knowledge of SQL. 
     75 
     76Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports. 
     77 
     78A report is basically a single named SQL query, executed and presented by Trac. Reports can be viewed and created from a custom SQL expression directly in the web interface. 
     79 
     80Typically, a report consists of a SELECT-expression from the 'ticket' table, using the available columns and sorting the way you want it. 
     81 
     82== Ticket columns 
     83 
    8384The ''ticket'' table has the following columns: 
    8485 * id 
     
    103104 
    104105Example: '''All active tickets, sorted by priority and time''' 
    105 {{{ 
    106 SELECT id AS ticket, status, severity, priority, owner,  
    107        time AS created, summary FROM ticket  
    108   WHERE status IN ('new', 'assigned', 'reopened') 
    109   ORDER BY priority, time 
    110 }}} 
    111  
    112  
    113 == Advanced Reports: Dynamic Variables == 
     106{{{#!sql 
     107SELECT id AS ticket, status, severity, priority, owner, time AS created, summary  
     108FROM ticket  
     109WHERE status IN ('new', 'assigned', 'reopened') 
     110ORDER BY priority, time 
     111}}} 
     112 
     113== Advanced Reports: Dynamic Variables 
     114 
    114115For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.  
    115116In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution. 
    116117 
    117 === Using Variables in a Query === 
     118=== Using Variables in a Query 
     119 
    118120The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable. 
    119121 
    120122Example: 
    121 {{{ 
     123{{{#!sql 
    122124SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 
    123125}}} 
    124126 
    125 To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'. 
    126  
    127 Example: 
     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 '$': 
    128128{{{ 
    129129 http://trac.edgewall.org/reports/14?PRIORITY=high 
    130130}}} 
    131131 
    132 To use multiple variables, separate them with an '&'. 
    133  
    134 Example: 
     132To use multiple variables, separate them with an '&': 
    135133{{{ 
    136134 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 
    137135}}} 
    138136 
    139  
    140 === !Special/Constant Variables === 
     137=== !Special/Constant Variables 
     138 
    141139There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.  
    142140 
    143141 * $USER — Username of logged in user. 
    144142 
    145 Example (''List all tickets assigned to me''): 
    146 {{{ 
     143Example: List all tickets assigned to me: 
     144{{{#!sql 
    147145SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 
    148146}}} 
    149147 
    150  
    151  
    152 == Advanced Reports: Custom Formatting == 
    153 Trac is also capable of more advanced reports, including custom layouts, 
    154 result grouping and user-defined CSS styles. To create such reports, we'll use 
    155 specialized SQL statements to control the output of the Trac report engine. 
    156  
    157 === Special Columns === 
    158 To format reports, TracReports looks for 'magic' column names in the query 
    159 result. These 'magic' names are processed and affect the layout and style of the  
    160 final report. 
    161  
    162 === Automatically formatted columns === 
     148== Advanced Reports: Custom Formatting 
     149 
     150Trac is also capable of more advanced reports, including custom layouts, result grouping and user-defined CSS styles. To create such reports, we will use specialized SQL statements to control the output of the Trac report engine. 
     151 
     152=== Special Columns 
     153 
     154To format reports, TracReports looks for 'magic' column names in the query result. These 'magic' names are processed and affect the layout and style of the final report. 
     155 
     156=== Automatically formatted columns 
     157 
    163158 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.  
    164159 * '''id''' — same as '''ticket''' above when '''realm''' is not set 
    165160 * '''realm''' — together with '''id''', can be used to create links to other resources than tickets (e.g. a realm of ''wiki'' and an ''id'' to a page name will create a link to that wiki page) 
     161   - for some kind of resources, it may be necessary to specify their ''parent'' resources (e.g. for ''changeset'', which ''repos'') and this can be achieved using the '''parent_realm''' and '''parent_id''' columns 
    166162 * '''created, modified, date, time''' — Format cell as a date and/or time. 
    167163 * '''description''' — Ticket description field, parsed through the wiki engine. 
    168164 
    169165'''Example:''' 
    170 {{{ 
     166{{{#!sql 
    171167SELECT id AS ticket, created, status, summary FROM ticket  
    172168}}} 
     
    176172See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 
    177173 
    178 === Custom formatting columns === 
     174=== Custom formatting columns 
     175 
    179176Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are 
    180177assumed to be ''formatting hints'', affecting the appearance of the row. 
     
    197194 
    198195'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 
    199 {{{ 
     196{{{#!sql 
    200197SELECT p.value AS __color__, 
    201198     t.milestone AS __group__, 
    202199     '../milestone/' || t.milestone AS __grouplink__, 
    203200     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 
    204        t.id AS ticket, summary 
    205   FROM ticket t,enum p 
    206   WHERE t.status IN ('new', 'assigned', 'reopened')  
    207     AND p.name=t.priority AND p.type='priority' 
    208   ORDER BY t.milestone, p.value, t.severity, t.time 
    209 }}} 
    210  
    211 '''Note:''' A table join is used to match ''ticket'' priorities with their 
    212 numeric representation from the ''enum'' table. 
     201     t.id AS ticket, summary 
     202FROM ticket t,enum p 
     203WHERE t.status IN ('new', 'assigned', 'reopened')  
     204  AND p.name = t.priority AND p.type = 'priority' 
     205ORDER BY t.milestone, p.value, t.severity, t.time 
     206}}} 
     207 
     208'''Note:''' A table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table. 
    213209 
    214210=== Changing layout of report rows === #column-syntax 
    215 By default, all columns on each row are display on a single row in the HTML 
    216 report, possibly formatted according to the descriptions above. However, it's 
    217 also possible to create multi-line report entries. 
     211 
     212By default, all columns on each row are display on a single row in the HTML report, possibly formatted according to the descriptions above. However, it is also possible to create multi-line report entries. 
    218213 
    219214 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line. 
     
    226221'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout'' 
    227222 
    228 {{{ 
     223{{{#!sql 
    229224SELECT p.value AS __color__, 
    230225       t.milestone AS __group__, 
     
    237232       description AS _description_,                    -- ## Uses a full row 
    238233       changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output 
    239   FROM ticket t,enum p 
    240   WHERE t.status IN ('new', 'assigned', 'reopened')  
    241     AND p.name=t.priority AND p.type='priority' 
    242   ORDER BY t.milestone, p.value, t.severity, t.time 
    243 }}} 
    244  
    245 === Reporting on custom fields === 
    246  
    247 If 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. 
     234FROM ticket t,enum p 
     235WHERE t.status IN ('new', 'assigned', 'reopened')  
     236  AND p.name = t.priority AND p.type = 'priority' 
     237ORDER BY t.milestone, p.value, t.severity, t.time 
     238}}} 
     239 
     240=== Reporting on custom fields 
     241 
     242If you have added custom fields to your tickets (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. 
    248243 
    249244If 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 [trac:TracIniReportCustomFieldSample TracIniReportCustomFieldSample] for some examples. 
     
    253248Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports: 
    254249 1. [#sort-order changing the sort order] 
    255  2. pagination support (limitation of the number of result rows displayed on each page) 
     250 1. pagination support (limitation of the number of result rows displayed on each page) 
    256251In order to support the first feature, the sort column is inserted in the `ORDER BY` clause in the first position or in the second position if a `__group__` column is specified (an `ORDER BY` clause is created if needed). In order to support pagination, a `LIMIT ... OFFSET ...` clause is appended. 
    257252The query might be too complex for the automatic rewrite to work correctly, resulting in an erroneous query. In this case you still have the possibility to control exactly how the rewrite is done by manually inserting the following tokens: 
     
    261256 
    262257Let's take an example, consider the following SQL query: 
    263 {{{ 
     258{{{#!sql 
    264259-- ## 4: Assigned, Active Tickets by Owner ## -- 
    265260 
     
    273268   changetime AS _changetime, description AS _description, 
    274269   reporter AS _reporter 
    275   FROM ticket t,enum p 
    276   WHERE status = 'assigned' 
    277 AND p.name=t.priority AND p.type='priority' 
    278   ORDER BY __group__, p.value, severity, time 
     270FROM ticket t,enum p 
     271WHERE status = 'assigned' 
     272  AND p.name = t.priority AND p.type = 'priority' 
     273ORDER BY __group__, p.value, severity, time 
    279274}}} 
    280275 
    281276The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`): 
    282 {{{ 
     277{{{#!sql 
    283278SELECT p.value AS __color__, 
    284279   owner AS __group__, 
     
    286281   changetime AS _changetime, description AS _description, 
    287282   reporter AS _reporter 
    288   FROM ticket t,enum p 
    289   WHERE status = 'assigned' 
    290 AND p.name=t.priority AND p.type='priority' 
    291   ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time 
    292  LIMIT 4 OFFSET 4 
     283FROM ticket t,enum p 
     284WHERE status = 'assigned' 
     285  AND p.name = t.priority AND p.type = 'priority' 
     286ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time 
     287LIMIT 4 OFFSET 4 
    293288}}} 
    294289 
    295290The equivalent SQL query with the rewrite tokens would have been: 
    296 {{{ 
     291{{{#!sql 
    297292SELECT p.value AS __color__, 
    298293   owner AS __group__, 
     
    300295   changetime AS _changetime, description AS _description, 
    301296   reporter AS _reporter 
    302   FROM ticket t,enum p 
    303   WHERE status = 'assigned' 
    304 AND p.name=t.priority AND p.type='priority' 
    305   ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time 
     297FROM ticket t,enum p 
     298WHERE status = 'assigned' 
     299  AND p.name = t.priority AND p.type = 'priority' 
     300ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time 
    306301@LIMIT_OFFSET@ 
    307302}}} 
    308303 
    309304If you want to always sort first by priority and only then by the user selected sort column, simply use the following `ORDER BY` clause: 
    310 {{{ 
    311   ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time 
     305{{{#!sql 
     306ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time 
    312307}}} 
    313308