Changes between Version 2 and Version 3 of TracReports


Ignore:
Timestamp:
Jan 13, 2020, 11:31:41 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracReports

    v2 v3  
    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 ==
    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 == Changing Report Numbering ==
    32 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)'':
    33  * id integer PRIMARY KEY
    34  * author text
    35  * title text
    36  * query text
    37  * description text
    38 Changing 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).
    43 
    44 You may also need to update or remove the report number stored in the report or query.
    45 
    46 == Navigating Tickets ==
    47 Clicking 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 
    49 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)''
    50 
    51 == Alternative Download Formats ==
    52 Aside from the default HTML view, reports can also be exported in a number of alternative formats.
     25== Changing Sort Order
     26
     27Simple reports - ungrouped reports to be specific - can be sorted by clicking the column header.
     28
     29If a column header is a hyperlink (red), click the column to sort by it. Clicking the same header again reverses the sort order.
     30
     31== Navigating Tickets
     32
     33Clicking 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'' contextual navigation links, or click the ''Back to Report'' link to return to the report page.
     34
     35You 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, in contrast to the query results (see TracQuery#NavigatingTickets).
     36
     37== Alternate Download Formats
     38
     39In addition to the HTML view, reports can also be exported in a number of alternate formats.
    5340At the bottom of the report page, you will find a list of available data formats. Click the desired link to
    54 download the alternative report format.
    55 
    56 === Comma-delimited - CSV (Comma Separated Values) ===
     41download the alternate format.
     42
     43=== Comma-delimited - CSV (Comma Separated Values)
     44
    5745Export the report as plain text, each row on its own line, columns separated by a single comma (',').
    5846'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
    5947
    60 === Tab-delimited ===
     48=== Tab-delimited
     49
    6150Like above, but uses tabs (\t) instead of comma.
    6251
    63 === RSS - XML Content Syndication ===
     52=== RSS - XML Content Syndication
     53
    6454All 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.
    6555
    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 ==
     56== Creating Custom Reports
     57
     58Creating a custom report requires a comfortable knowledge of SQL.
     59
     60Note that you need grant [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.
     61
     62A 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.
     63
     64Typically, a report consists of a SELECT-expression from the 'ticket' table, using the available columns and sorting the way you want it.
     65
     66== Ticket columns
     67
    8268The ''ticket'' table has the following columns:
    8369 * id
    … …  
    10288
    10389Example: '''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 ==
     90{{{#!sql
     91SELECT id AS ticket, status, severity, priority, owner, time AS created, summary
     92FROM ticket
     93WHERE status IN ('new', 'assigned', 'reopened')
     94ORDER BY priority, time
     95}}}
     96
     97== Advanced Reports: Dynamic Variables
     98
    11399For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
    114 In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution.
    115 
    116 === Using Variables in a Query ===
     100In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution. Dynamic variables can also be used in the report title and description //(since 1.1.1)//.
     101
     102=== Using Variables in a Query
     103
    117104The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
    118105
    119106Example:
    120 {{{
     107{{{#!sql
    121108SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
    122109}}}
    123110
    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:
     111To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$':
    127112{{{
    128113 http://trac.edgewall.org/reports/14?PRIORITY=high
    129114}}}
    130115
    131 To use multiple variables, separate them with an '&'.
    132 
    133 Example:
     116To use multiple variables, separate them with an '&':
    134117{{{
    135118 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    136119}}}
    137120
    138 Dynamic variables can also be used in the report title and description (since 1.1.1).
    139 
    140 === !Special/Constant Variables ===
     121=== !Special/Constant Variables
     122
    141123There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
    142124
    143125 * $USER — Username of logged in user.
    144126
    145 Example (''List all tickets assigned to me''):
    146 {{{
     127Example: List all tickets assigned to me:
     128{{{#!sql
    147129SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
    148130}}}
    149131
    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 ===
     132== Advanced Reports: Custom Formatting
     133
     134Trac 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.
     135
     136=== Special Columns
     137
     138To format reports, TracReports look for 'magic' column names in the query result. These 'magic' names are processed and affect the layout and style of the final report.
     139
     140=== Automatically formatted columns
     141
    163142 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
    164143 * '''id''' — same as '''ticket''' above when '''realm''' is not set
    165144 * '''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)
     145   - for some resources, it may be necessary to specify their ''parent'' resources (e.g. for ''changeset'', the ''repos'') and this can be achieved using the '''parent_realm''' and '''parent_id''' columns
    166146 * '''created, modified, date, time''' — Format cell as a date and/or time.
    167147 * '''description''' — Ticket description field, parsed through the wiki engine.
    168148
    169149'''Example:'''
    170 {{{
     150{{{#!sql
    171151SELECT id AS ticket, created, status, summary FROM ticket
    172152}}}
    … …  
    174154Those columns can also be defined but marked as hidden, see [#column-syntax below].
    175155
    176 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
    177 
    178 === Custom formatting columns ===
    179 Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
     156See [trac:CookBook/Configuration/Reports] for examples of creating reports for realms other than ''ticket''.
     157
     158=== Custom formatting columns
     159
     160Columns whose names begin and end with 2 underscores (e.g. '''`__color__`''') are
    180161assumed to be ''formatting hints'', affecting the appearance of the row.
    181162 
    … …  
    183164 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
    184165 * '''`__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.
    185 {{{
    186 #!html
    187 <div style="margin-left:7.5em">Defaults:
     166 {{{#!html
     167<div style="margin-left:3em">Defaults:
    188168<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
    189169<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
    … …  
    196176 * '''`__class__`''' — Zero or more space-separated CSS class names to be set on the `<tr>` element of the current row. These classes are added to the class name derived from `__color__` and the odd / even indicator.
    197177
    198 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
    199 {{{
     178'''Example:''' List active tickets, grouped by milestone, group header linked to milestone page, colored by priority:
     179{{{#!sql
    200180SELECT p.value AS __color__,
    201181     t.milestone AS __group__,
    202182     '../milestone/' || t.milestone AS __grouplink__,
    203183     (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.
     184     t.id AS ticket, summary
     185FROM ticket t,enum p
     186WHERE t.status IN ('new', 'assigned', 'reopened')
     187  AND p.name = t.priority AND p.type = 'priority'
     188ORDER BY t.milestone, p.value, t.severity, t.time
     189}}}
     190
     191Note that table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
    213192
    214193=== 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.
     194
     195By 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.
    218196
    219197 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line.
    … …  
    224202   This can be used to hide any kind of column, even important ones required for identifying the resource, e.g. `id as _id` will hide the '''Id''' column but the link to the ticket will be present.
    225203
    226 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
    227 
    228 {{{
     204'''Example:''' List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout:
     205
     206{{{#!sql
    229207SELECT p.value AS __color__,
    230208       t.milestone AS __group__,
    … …  
    237215       description AS _description_,                    -- ## Uses a full row
    238216       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.
    248 
    249 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 [trac:TracIniReportCustomFieldSample TracIniReportCustomFieldSample] for some examples.
     217FROM ticket t,enum p
     218WHERE t.status IN ('new', 'assigned', 'reopened')
     219  AND p.name = t.priority AND p.type = 'priority'
     220ORDER BY t.milestone, p.value, t.severity, t.time
     221}}}
     222
     223=== Reporting on custom fields
     224
     225If you have added [TracTicketsCustomFields custom fields] to your tickets, you can write a SQL query to include them in a report. You'll need to make a join on the `ticket_custom` table.
     226
     227If 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.
    250228
    251229=== A note about SQL rewriting #rewriting
    252230
    253231Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports:
    254  1. [#sort-order changing the sort order]
    255  2. pagination support (limitation of the number of result rows displayed on each page)
     232 1. [#sort-order sorting]
     233 1. pagination: limiting the number of results displayed on each page
    256234In 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.
    257235The 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:
    … …  
    261239
    262240Let's take an example, consider the following SQL query:
    263 {{{
     241{{{#!sql
    264242-- ## 4: Assigned, Active Tickets by Owner ## --
    265243
    … …  
    273251   changetime AS _changetime, description AS _description,
    274252   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
     253FROM ticket t,enum p
     254WHERE status = 'assigned'
     255  AND p.name = t.priority AND p.type = 'priority'
     256ORDER BY __group__, p.value, severity, time
    279257}}}
    280258
    281259The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`):
    282 {{{
     260{{{#!sql
    283261SELECT p.value AS __color__,
    284262   owner AS __group__,
    … …  
    286264   changetime AS _changetime, description AS _description,
    287265   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
     266FROM ticket t,enum p
     267WHERE status = 'assigned'
     268  AND p.name = t.priority AND p.type = 'priority'
     269ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time
     270LIMIT 4 OFFSET 4
    293271}}}
    294272
    295273The equivalent SQL query with the rewrite tokens would have been:
    296 {{{
     274{{{#!sql
    297275SELECT p.value AS __color__,
    298276   owner AS __group__,
    … …  
    300278   changetime AS _changetime, description AS _description,
    301279   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
     280FROM ticket t,enum p
     281WHERE status = 'assigned'
     282  AND p.name = t.priority AND p.type = 'priority'
     283ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time
    306284@LIMIT_OFFSET@
    307285}}}
    308286
    309287If 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
    312 }}}
     288{{{#!sql
     289ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time
     290}}}
     291
     292== Changing Report Numbering
     293
     294There 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:
     295 * id integer PRIMARY KEY
     296 * author text
     297 * title text
     298 * query text
     299 * description text
     300Changing 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:
     301{{{#!sql
     302UPDATE report SET id = 5 WHERE id = 3;
     303}}}
     304Keep 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 for your database.
     305
     306You may also need to update or remove the report number stored in the report or query.
    313307
    314308----
    315 See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
     309See also: TracTickets, TracQuery, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]