Changes between Initial Version and Version 1 of TracReports


Ignore:
Timestamp:
Apr 21, 2020, 11:11:05 PM (21 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v1 v1  
     1= Trac Reports
     2
     3[[TracGuideToc]]
     4
     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
     13  [components]
     14  trac.ticket.report.* = disabled
     15  }}}
     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.
     17
     18A report consists of these basic parts:
     19 * '''ID''' — Unique (sequential) identifier
     20 * '''Title''' — Descriptive title
     21 * '''Description''' — A brief description of the report, in WikiFormatting text.
     22 * '''Report Body''' — List of results from report query, formatted according to the methods described below.
     23 * '''Footer''' — Links to alternative download formats for this report.
     24
     25== Changing Sort Order
     26
     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.
     46
     47== Navigating Tickets
     48
     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.
     58
     59=== Comma-delimited - CSV (Comma Separated Values)
     60
     61Export the report as plain text, each row on its own line, columns separated by a single comma (',').
     62'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
     63
     64=== Tab-delimited
     65
     66Like above, but uses tabs (\t) instead of comma.
     67
     68=== RSS - XML Content Syndication
     69
     70All 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.
     71
     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
     84The ''ticket'' table has the following columns:
     85 * id
     86 * type
     87 * time
     88 * changetime
     89 * component
     90 * severity 
     91 * priority
     92 * owner
     93 * reporter
     94 * cc
     95 * version
     96 * milestone
     97 * status
     98 * resolution
     99 * summary
     100 * description
     101 * keywords
     102
     103See TracTickets for a detailed description of the column fields.
     104
     105Example: '''All active tickets, sorted by priority and time'''
     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
     117For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
     118In 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)//.
     119
     120=== Using Variables in a Query
     121
     122The syntax for dynamic variables is simple, any upper case word beginning with `$` is considered a variable.
     123
     124Example:
     125{{{#!sql
     126SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
     127}}}
     128
     129The value of the dynamic variable can be assigned in the report preferences form.
     130
     131To assign a value to `$PRIORITY` in the URL for a report, leave out the leading `$`:
     132{{{
     133 http://trac.edgewall.org/reports/14?PRIORITY=high
     134}}}
     135
     136To use multiple variables, separate them with an `&`:
     137{{{
     138 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
     139}}}
     140
     141It is possible to assign a default value to the variable, within a SQL comment:
     142
     143{{{#!sql
     144-- PRIORITY = high
     145
     146SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
     147}}}
     148
     149
     150=== !Special/Constant Variables
     151
     152There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
     153
     154 * $USER — Username of logged in user.
     155
     156Example: List all tickets assigned to me:
     157{{{#!sql
     158SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
     159}}}
     160
     161== Advanced Reports: Custom Formatting
     162
     163Trac 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.
     164
     165=== Special Columns
     166
     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.
     168
     169=== Automatically formatted columns
     170
     171 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
     172 * '''id''' — same as '''ticket''' above when '''realm''' is not set
     173 * '''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)
     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
     175 * '''created, modified, date, time''' — Format cell as a date and/or time.
     176 * '''description''' — Ticket description field, parsed through the wiki engine.
     177
     178'''Example:'''
     179{{{#!sql
     180SELECT id AS ticket, created, status, summary FROM ticket
     181}}}
     182
     183Those columns can also be defined but marked as hidden, see [#column-syntax below].
     184
     185See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
     186
     187=== Custom formatting columns
     188
     189Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
     190assumed to be ''formatting hints'', affecting the appearance of the row.
     191 
     192 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table.
     193 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
     194 * '''`__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.
     195{{{
     196#!html
     197<div style="margin-left:7.5em">Defaults:
     198<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
     199<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
     200<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span>
     201<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span>
     202<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span>
     203</div>
     204}}}
     205 * '''`__style__`''' — A custom CSS style expression to use on the `<tr>` element of the current row.
     206 * '''`__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.
     207
     208'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
     209{{{#!sql
     210SELECT p.value AS __color__,
     211     t.milestone AS __group__,
     212     '../milestone/' || t.milestone AS __grouplink__,
     213     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
     214     t.id AS ticket, summary
     215FROM ticket t,enum p
     216WHERE t.status IN ('new', 'assigned', 'reopened')
     217  AND p.name = t.priority AND p.type = 'priority'
     218ORDER BY t.milestone, p.value, t.severity, t.time
     219}}}
     220
     221'''Note:''' A table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
     222
     223=== Changing layout of report rows === #column-syntax
     224
     225By 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.
     226
     227 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line.
     228
     229 * '''`_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.
     230
     231 * '''`_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).
     232   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.
     233
     234'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     235
     236{{{#!sql
     237SELECT p.value AS __color__,
     238       t.milestone AS __group__,
     239       (CASE owner
     240          WHEN 'daniel' THEN 'font-weight: bold; background: red;'
     241          ELSE '' END) AS __style__,
     242       t.id AS ticket, summary AS summary_,             -- ## Break line here
     243       component,version, severity, milestone, status, owner,
     244       time AS created, changetime AS modified,         -- ## Dates are formatted
     245       description AS _description_,                    -- ## Uses a full row
     246       changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
     247FROM ticket t,enum p
     248WHERE t.status IN ('new', 'assigned', 'reopened')
     249  AND p.name = t.priority AND p.type = 'priority'
     250ORDER BY t.milestone, p.value, t.severity, t.time
     251}}}
     252
     253=== Reporting on custom fields
     254
     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.
     258
     259=== A note about SQL rewriting #rewriting
     260
     261Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports:
     262 1. [#sort-order changing the sort order]
     263 1. pagination support (limitation of the number of result rows displayed on each page)
     264In 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.
     265The 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:
     266 - `@SORT_COLUMN@`, the place where the name of the selected sort column will be inserted,
     267 - `@LIMIT_OFFSET@`, the place where the pagination support clause will be added
     268Note that if you write them after an SQL comment, `--`, you'll effectively disable rewriting if this is what you want!
     269
     270Let's take an example, consider the following SQL query:
     271{{{#!sql
     272-- ## 4: Assigned, Active Tickets by Owner ## --
     273
     274--
     275-- List assigned tickets, group by ticket owner, sorted by priority.
     276--
     277
     278SELECT p.value AS __color__,
     279   owner AS __group__,
     280   id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created,
     281   changetime AS _changetime, description AS _description,
     282   reporter AS _reporter
     283FROM ticket t,enum p
     284WHERE status = 'assigned'
     285  AND p.name = t.priority AND p.type = 'priority'
     286ORDER BY __group__, p.value, severity, time
     287}}}
     288
     289The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`):
     290{{{#!sql
     291SELECT p.value AS __color__,
     292   owner AS __group__,
     293   id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created,
     294   changetime AS _changetime, description AS _description,
     295   reporter AS _reporter
     296FROM ticket t,enum p
     297WHERE status = 'assigned'
     298  AND p.name = t.priority AND p.type = 'priority'
     299ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time
     300LIMIT 4 OFFSET 4
     301}}}
     302
     303The equivalent SQL query with the rewrite tokens would have been:
     304{{{#!sql
     305SELECT p.value AS __color__,
     306   owner AS __group__,
     307   id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created,
     308   changetime AS _changetime, description AS _description,
     309   reporter AS _reporter
     310FROM ticket t,enum p
     311WHERE status = 'assigned'
     312  AND p.name = t.priority AND p.type = 'priority'
     313ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time
     314@LIMIT_OFFSET@
     315}}}
     316
     317If you want to always sort first by priority and only then by the user selected sort column, simply use the following `ORDER BY` clause:
     318{{{#!sql
     319ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time
     320}}}
     321
     322----
     323See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]