Changes between Version 3 and Version 4 of TracReports


Ignore:
Timestamp:
Feb 1, 2017 12:38:00 AM (10 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v3 v4  
    1 = Trac Reports =
     1= Trac Reports
     2
    23[[TracGuideToc]]
    34
    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 by disabling the former in [wiki:TracIni trac.ini]:''
    13   {{{
     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
    1413  [components]
    1514  trac.ticket.report.* = disabled
    1615  }}}
    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.''
     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.
    1817
    1918A report consists of these basic parts:
     
    2423 * '''Footer''' — Links to alternative download formats for this report.
    2524
    26 == Changing Sort Order ==
     25== Changing Sort Order
     26
    2727Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header.
    2828
    2929If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
    3030
    31 == Changing Report Numbering ==
     31== Changing Report Numbering
     32
    3233There 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:
    3334 * id integer PRIMARY KEY
     
    3738 * description text
    3839Changing 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:
    39 {{{
    40 update report set id=5 where id=3;
    41 }}}
    42 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.
    4344
    4445You may also need to update or remove the report number stored in the report or query.
    4546
    46 == Navigating Tickets ==
     47== Navigating Tickets
     48
    4749Clicking 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.
    4850
    4951You 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).
    5052
    51 == Alternative Download Formats ==
     53== Alternative Download Formats
     54
    5255Aside from the default HTML view, reports can also be exported in a number of alternative formats.
    5356At the bottom of the report page, you will find a list of available data formats. Click the desired link to
    5457download the alternative report format.
    5558
    56 === Comma-delimited - CSV (Comma Separated Values) ===
     59=== Comma-delimited - CSV (Comma Separated Values)
     60
    5761Export the report as plain text, each row on its own line, columns separated by a single comma (',').
    5862'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
    5963
    60 === Tab-delimited ===
     64=== Tab-delimited
     65
    6166Like above, but uses tabs (\t) instead of comma.
    6267
    63 === RSS - XML Content Syndication ===
     68=== RSS - XML Content Syndication
     69
    6470All 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.
    6571
    66 ----
    67 
    68 == Creating Custom Reports ==
    69 
    70 ''Creating a custom report requires a comfortable knowledge of SQL.''
    71 
    72 '''Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.'''
    73 
    74 A report is basically a single named SQL query, executed and presented by
    75 Trac.  Reports can be viewed and created from a custom SQL expression directly
    76 in the web interface.
    77 
    78 Typically, a report consists of a SELECT-expression from the 'ticket' table,
    79 using the available columns and sorting the way you want it.
    80 
    81 == 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
    8284The ''ticket'' table has the following columns:
    8385 * id
     
    102104
    103105Example: '''All active tickets, sorted by priority and time'''
    104 {{{
    105 SELECT id AS ticket, status, severity, priority, owner,
    106        time AS created, summary FROM ticket
    107   WHERE status IN ('new', 'assigned', 'reopened')
    108   ORDER BY priority, time
    109 }}}
    110 
    111 
    112 == 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
     113Dynamic variables can also be used in the report title and description (since 1.1.1).
     114
     115== Advanced Reports: Dynamic Variables
     116
    113117For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
    114118In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution.
    115119
    116 === Using Variables in a Query ===
     120=== Using Variables in a Query
     121
    117122The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
    118123
    119124Example:
    120 {{{
     125{{{#!sql
    121126SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
    122127}}}
    123128
    124 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 '$'.
    125 
    126 Example:
     129To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$':
    127130{{{
    128131 http://trac.edgewall.org/reports/14?PRIORITY=high
    129132}}}
    130133
    131 To use multiple variables, separate them with an '&'.
    132 
    133 Example:
     134To use multiple variables, separate them with an '&':
    134135{{{
    135136 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    136137}}}
    137138
    138 
    139 === !Special/Constant Variables ===
     139=== !Special/Constant Variables
     140
    140141There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
    141142
    142143 * $USER — Username of logged in user.
    143144
    144 Example (''List all tickets assigned to me''):
    145 {{{
     145Example: List all tickets assigned to me:
     146{{{#!sql
    146147SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
    147148}}}
    148149
    149 
    150 
    151 == Advanced Reports: Custom Formatting ==
    152 Trac is also capable of more advanced reports, including custom layouts,
    153 result grouping and user-defined CSS styles. To create such reports, we'll use
    154 specialized SQL statements to control the output of the Trac report engine.
    155 
    156 === Special Columns ===
    157 To format reports, TracReports looks for 'magic' column names in the query
    158 result. These 'magic' names are processed and affect the layout and style of the
    159 final report.
    160 
    161 === Automatically formatted columns ===
     150== Advanced Reports: Custom Formatting
     151
     152Trac 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.
     153
     154=== Special Columns
     155
     156To 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.
     157
     158=== Automatically formatted columns
     159
    162160 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
    163161 * '''id''' — same as '''ticket''' above when '''realm''' is not set
     
    168166
    169167'''Example:'''
    170 {{{
     168{{{#!sql
    171169SELECT id AS ticket, created, status, summary FROM ticket
    172170}}}
     
    176174See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
    177175
    178 === Custom formatting columns ===
     176=== Custom formatting columns
     177
    179178Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
    180179assumed to be ''formatting hints'', affecting the appearance of the row.
     
    197196
    198197'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
    199 {{{
     198{{{#!sql
    200199SELECT p.value AS __color__,
    201200     t.milestone AS __group__,
    202201     '../milestone/' || t.milestone AS __grouplink__,
    203202     (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.
     203     t.id AS ticket, summary
     204FROM ticket t,enum p
     205WHERE t.status IN ('new', 'assigned', 'reopened')
     206  AND p.name = t.priority AND p.type = 'priority'
     207ORDER BY t.milestone, p.value, t.severity, t.time
     208}}}
     209
     210'''Note:''' A table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
    213211
    214212=== 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.
     213
     214By 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.
    218215
    219216 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line.
     
    226223'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
    227224
    228 {{{
     225{{{#!sql
    229226SELECT p.value AS __color__,
    230227       t.milestone AS __group__,
     
    237234       description AS _description_,                    -- ## Uses a full row
    238235       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 ===
     236FROM ticket t,enum p
     237WHERE t.status IN ('new', 'assigned', 'reopened')
     238  AND p.name = t.priority AND p.type = 'priority'
     239ORDER BY t.milestone, p.value, t.severity, t.time
     240}}}
     241
     242=== Reporting on custom fields
    246243
    247244If 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.
     
    253250Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports:
    254251 1. [#sort-order changing the sort order]
    255  2. pagination support (limitation of the number of result rows displayed on each page)
     252 1. pagination support (limitation of the number of result rows displayed on each page)
    256253In 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.
    257254The 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:
     
    261258
    262259Let's take an example, consider the following SQL query:
    263 {{{
     260{{{#!sql
    264261-- ## 4: Assigned, Active Tickets by Owner ## --
    265262
     
    273270   changetime AS _changetime, description AS _description,
    274271   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
     272FROM ticket t,enum p
     273WHERE status = 'assigned'
     274  AND p.name = t.priority AND p.type = 'priority'
     275ORDER BY __group__, p.value, severity, time
    279276}}}
    280277
    281278The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`):
    282 {{{
     279{{{#!sql
    283280SELECT p.value AS __color__,
    284281   owner AS __group__,
     
    286283   changetime AS _changetime, description AS _description,
    287284   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
     285FROM ticket t,enum p
     286WHERE status = 'assigned'
     287  AND p.name = t.priority AND p.type = 'priority'
     288ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time
     289LIMIT 4 OFFSET 4
    293290}}}
    294291
    295292The equivalent SQL query with the rewrite tokens would have been:
    296 {{{
     293{{{#!sql
    297294SELECT p.value AS __color__,
    298295   owner AS __group__,
     
    300297   changetime AS _changetime, description AS _description,
    301298   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
     299FROM ticket t,enum p
     300WHERE status = 'assigned'
     301  AND p.name = t.priority AND p.type = 'priority'
     302ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time
    306303@LIMIT_OFFSET@
    307304}}}
    308305
    309306If 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
     307{{{#!sql
     308ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time
    312309}}}
    313310