Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
Jul 30, 2021, 7:48:33 AM (6 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v1 v2  
    55The Trac reports module provides a simple, yet powerful reporting facility to present information about tickets in the Trac database.
    66
    7 Rather than have its own report definition format, TracReports relies on standard SQL `SELECT` statements for custom report definition.
     7Rather than have its own report definition format, TracReports relies on standard SQL `SELECT` statements for custom report definition. 
    88
    99  '''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.
     
    1717
    1818A report consists of these basic parts:
    19  * '''ID''' — Unique (sequential) identifier
     19 * '''ID''' — Unique (sequential) identifier 
    2020 * '''Title''' — Descriptive title
    2121 * '''Description''' — A brief description of the report, in WikiFormatting text.
     
    2525== Changing Sort Order
    2626
    27 Simple reports - ungrouped reports to be specific - can be sorted by clicking the column header.
    28 
    29 If a column header is a hyperlink (red), click the column to sort by it. Clicking the same header again reverses the sort order.
     27Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header.
     28
     29If 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
     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:
     34 * id integer PRIMARY KEY
     35 * author text
     36 * title text
     37 * query text
     38 * description text
     39Changing 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{{{#!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.
     44
     45You may also need to update or remove the report number stored in the report or query.
    3046
    3147== Navigating Tickets
    3248
    33 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'' contextual navigation links, or click the ''Back to Report'' link to return to the report page.
    34 
    35 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, in contrast to the query results (see TracQuery#NavigatingTickets).
    36 
    37 == Alternate Download Formats
    38 
    39 In addition to the HTML view, reports can also be exported in a number of alternate formats.
    40 At the bottom of the report page, you will find a list of available data formats. Click the desired link to
    41 download the alternate format.
     49Clicking 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.
     50
     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
     55Aside from the default HTML view, reports can also be exported in a number of alternative formats.
     56At the bottom of the report page, you will find a list of available data formats. Click the desired link to 
     57download the alternative report format.
    4258
    4359=== Comma-delimited - CSV (Comma Separated Values)
     
    5874Creating a custom report requires a comfortable knowledge of SQL.
    5975
    60 Note that you need grant [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.
     76Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.
    6177
    6278A 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.
     
    7288 * changetime
    7389 * component
    74  * severity
    75  * priority
     90 * severity 
     91 * priority 
    7692 * owner
    7793 * reporter
     
    89105Example: '''All active tickets, sorted by priority and time'''
    90106{{{#!sql
    91 SELECT id AS ticket, status, severity, priority, owner, time AS created, summary
    92 FROM ticket
     107SELECT id AS ticket, status, severity, priority, owner, time AS created, summary 
     108FROM ticket 
    93109WHERE status IN ('new', 'assigned', 'reopened')
    94110ORDER BY priority, time
    95111}}}
    96112
     113Dynamic variables can also be used in the report title and description (since 1.1.1).
     114
    97115== Advanced Reports: Dynamic Variables
    98116
    99 For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
     117For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements. 
    100118In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution. Dynamic variables are entered through the preferences form and the values are autocompleted //(Since 1.3.2)//.
    101119
     
    113131To assign a value to `$PRIORITY` in the URL for a report, leave out the leading `$`:
    114132{{{
    115  https://trac.edgewall.org/reports/14?PRIORITY=high
     133 http://trac.edgewall.org/reports/14?PRIORITY=high
    116134}}}
    117135
    118136To use multiple variables, separate them with an `&`:
    119137{{{
    120  https://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
     138 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    121139}}}
    122140
     
    132150=== !Special/Constant Variables
    133151
    134 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
     152There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 
    135153
    136154 * $USER — Username of logged in user.
     
    147165=== Special Columns
    148166
    149 To 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.
     167To 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.
    150168
    151169=== Automatically formatted columns
    152170
    153  * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
     171 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 
    154172 * '''id''' — same as '''ticket''' above when '''realm''' is not set
    155173 * '''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)
    156    - 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
     174   - 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
    157175 * '''created, modified, date, time''' — Format cell as a date and/or time.
    158176 * '''description''' — Ticket description field, parsed through the wiki engine.
     
    160178'''Example:'''
    161179{{{#!sql
    162 SELECT id AS ticket, created, status, summary FROM ticket
     180SELECT id AS ticket, created, status, summary FROM ticket 
    163181}}}
    164182
    165183Those columns can also be defined but marked as hidden, see [#column-syntax below].
    166184
    167 See [trac:CookBook/Configuration/Reports] for examples of creating reports for realms other than ''ticket''.
     185See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
    168186
    169187=== Custom formatting columns
    170188
    171 Columns whose names begin and end with 2 underscores (e.g. '''`__color__`''') are
     189Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
    172190assumed to be ''formatting hints'', affecting the appearance of the row.
    173 
     191 
    174192 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table.
    175193 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
    176194 * '''`__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.
    177  {{{#!html
    178 <div style="margin-left:3em">Defaults:
     195{{{
     196#!html
     197<div style="margin-left:7.5em">Defaults:
    179198<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
    180199<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
     
    187206 * '''`__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.
    188207
    189 '''Example:''' List active tickets, grouped by milestone, group header linked to milestone page, colored by priority:
     208'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
    190209{{{#!sql
    191210SELECT p.value AS __color__,
     
    195214     t.id AS ticket, summary
    196215FROM ticket t,enum p
    197 WHERE t.status IN ('new', 'assigned', 'reopened')
     216WHERE t.status IN ('new', 'assigned', 'reopened') 
    198217  AND p.name = t.priority AND p.type = 'priority'
    199218ORDER BY t.milestone, p.value, t.severity, t.time
    200219}}}
    201220
    202 Note that table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
     221'''Note:''' A table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
    203222
    204223=== Changing layout of report rows === #column-syntax
     
    213232   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.
    214233
    215 '''Example:''' List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout:
     234'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
    216235
    217236{{{#!sql
    218237SELECT p.value AS __color__,
    219238       t.milestone AS __group__,
    220        (CASE owner
    221           WHEN 'daniel' THEN 'font-weight: bold; background: red;'
     239       (CASE owner 
     240          WHEN 'daniel' THEN 'font-weight: bold; background: red;' 
    222241          ELSE '' END) AS __style__,
    223242       t.id AS ticket, summary AS summary_,             -- ## Break line here
     
    227246       changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
    228247FROM ticket t,enum p
    229 WHERE t.status IN ('new', 'assigned', 'reopened')
     248WHERE t.status IN ('new', 'assigned', 'reopened') 
    230249  AND p.name = t.priority AND p.type = 'priority'
    231250ORDER BY t.milestone, p.value, t.severity, t.time
     
    234253=== Reporting on custom fields
    235254
    236 If 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.
    237 
    238 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.
     255If 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.
     256
     257If 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.
    239258
    240259=== A note about SQL rewriting #rewriting
    241260
    242261Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports:
    243  1. [#sort-order sorting]
    244  1. pagination: limiting the number of results displayed on each page
     262 1. [#sort-order changing the sort order]
     263 1. pagination support (limitation of the number of result rows displayed on each page)
    245264In 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.
    246265The 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:
     
    253272-- ## 4: Assigned, Active Tickets by Owner ## --
    254273
    255 --
     274-- 
    256275-- List assigned tickets, group by ticket owner, sorted by priority.
    257 --
     276-- 
    258277
    259278SELECT p.value AS __color__,
     
    301320}}}
    302321
    303 == Changing Report Numbering
    304 
    305 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:
    306  * id integer PRIMARY KEY
    307  * author text
    308  * title text
    309  * query text
    310  * description text
    311 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:
    312 {{{#!sql
    313 UPDATE report SET id = 5 WHERE id = 3;
    314 }}}
    315 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 for your database.
    316 
    317 You may also need to update or remove the report number stored in the report or query.
    318 
    319322----
    320 See also: TracTickets, TracQuery, [https://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
     323See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]