Changes between Version 5 and Version 6 of Trac Reports


Ignore:
Timestamp:
Aug 19, 2021, 11:03:25 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Trac Reports

    v5 v6  
    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:
    20  * '''ID''' — Unique (sequential) identifier 
     19 * '''ID''' — Unique (sequential) identifier
    2120 * '''Title''' — Descriptive title
    2221 * '''Description''' — A brief description of the report, in WikiFormatting text.
    … …  
    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:
    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).
    50 
    51 == Alternative Download Formats ==
    52 Aside from the default HTML view, reports can also be exported in a number of alternative formats.
    53 At 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) ===
     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.
     40At the bottom of the report page, you will find a list of available data formats. Click the desired link to
     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
    … …  
    8672 * changetime
    8773 * component
    88  * severity 
    89  * priority 
     74 * severity
     75 * priority
    9076 * owner
    9177 * reporter
    … …  
    10288
    10389Example: '''All active tickets, sorted by priority and time'''
     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
     99For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
     100In 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)//.
     101
     102=== Using Variables in a Query
     103
     104The syntax for dynamic variables is simple, any upper case word beginning with `$` is considered a variable.
     105
     106Example:
     107{{{#!sql
     108SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
     109}}}
     110
     111The value of the dynamic variable can be assigned in the report preferences form.
     112
     113To assign a value to `$PRIORITY` in the URL for a report, leave out the leading `$`:
    104114{{{
    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 Dynamic variables can also be used in the report title and description (since 1.1.1).
    112 
    113 == Advanced Reports: Dynamic Variables ==
    114 For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
    115 In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution.
    116 
    117 === Using Variables in a Query ===
    118 The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
    119 
    120 Example:
     115 https://trac.edgewall.org/reports/14?PRIORITY=high
     116}}}
     117
     118To use multiple variables, separate them with an `&`:
    121119{{{
     120 https://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
     121}}}
     122
     123It is possible to assign a default value to the variable, within a SQL comment:
     124
     125{{{#!sql
     126-- PRIORITY = high
     127
    122128SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
    123129}}}
    124130
    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:
    128 {{{
    129  http://trac.edgewall.org/reports/14?PRIORITY=high
    130 }}}
    131 
    132 To use multiple variables, separate them with an '&'.
    133 
    134 Example:
    135 {{{
    136  http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    137 }}}
    138 
    139 
    140 === !Special/Constant Variables ===
    141 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
     131
     132=== !Special/Constant Variables
     133
     134There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
    142135
    143136 * $USER — Username of logged in user.
    144137
    145 Example (''List all tickets assigned to me''):
    146 {{{
     138Example: List all tickets assigned to me:
     139{{{#!sql
    147140SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
    148141}}}
    149142
    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 ===
    163  * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
     143== Advanced Reports: Custom Formatting
     144
     145Trac 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.
     146
     147=== Special Columns
     148
     149To 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.
     150
     151=== Automatically formatted columns
     152
     153 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
    164154 * '''id''' — same as '''ticket''' above when '''realm''' is not set
    165155 * '''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)
    166    - 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
     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
    167157 * '''created, modified, date, time''' — Format cell as a date and/or time.
    168158 * '''description''' — Ticket description field, parsed through the wiki engine.
    169159
    170160'''Example:'''
    171 {{{
    172 SELECT id AS ticket, created, status, summary FROM ticket 
     161{{{#!sql
     162SELECT id AS ticket, created, status, summary FROM ticket
    173163}}}
    174164
    175165Those columns can also be defined but marked as hidden, see [#column-syntax below].
    176166
    177 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
    178 
    179 === Custom formatting columns ===
    180 Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
     167See [trac:CookBook/Configuration/Reports] for examples of creating reports for realms other than ''ticket''.
     168
     169=== Custom formatting columns
     170
     171Columns whose names begin and end with 2 underscores (e.g. '''`__color__`''') are
    181172assumed to be ''formatting hints'', affecting the appearance of the row.
    182  
     173
    183174 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table.
    184175 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
    185176 * '''`__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.
    186 {{{
    187 #!html
    188 <div style="margin-left:7.5em">Defaults:
     177 {{{#!html
     178<div style="margin-left:3em">Defaults:
    189179<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
    190180<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
    … …  
    197187 * '''`__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.
    198188
    199 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
    200 {{{
     189'''Example:''' List active tickets, grouped by milestone, group header linked to milestone page, colored by priority:
     190{{{#!sql
    201191SELECT p.value AS __color__,
    202192     t.milestone AS __group__,
    203193     '../milestone/' || t.milestone AS __grouplink__,
    204194     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
    205        t.id AS ticket, summary
    206   FROM ticket t,enum p
    207   WHERE t.status IN ('new', 'assigned', 'reopened')
    208     AND p.name=t.priority AND p.type='priority'
    209   ORDER BY t.milestone, p.value, t.severity, t.time
    210 }}}
    211 
    212 '''Note:''' A table join is used to match ''ticket'' priorities with their
    213 numeric representation from the ''enum'' table.
     195     t.id AS ticket, summary
     196FROM ticket t,enum p
     197WHERE t.status IN ('new', 'assigned', 'reopened')
     198  AND p.name = t.priority AND p.type = 'priority'
     199ORDER BY t.milestone, p.value, t.severity, t.time
     200}}}
     201
     202Note that table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
    214203
    215204=== Changing layout of report rows === #column-syntax
    216 By default, all columns on each row are display on a single row in the HTML
    217 report, possibly formatted according to the descriptions above. However, it's
    218 also possible to create multi-line report entries.
     205
     206By 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.
    219207
    220208 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line.
    … …  
    225213   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.
    226214
    227 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
    228 
    229 {{{
     215'''Example:''' List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout:
     216
     217{{{#!sql
    230218SELECT p.value AS __color__,
    231219       t.milestone AS __group__,
    232        (CASE owner 
    233           WHEN 'daniel' THEN 'font-weight: bold; background: red;' 
     220       (CASE owner
     221          WHEN 'daniel' THEN 'font-weight: bold; background: red;'
    234222          ELSE '' END) AS __style__,
    235223       t.id AS ticket, summary AS summary_,             -- ## Break line here
    … …  
    238226       description AS _description_,                    -- ## Uses a full row
    239227       changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
    240   FROM ticket t,enum p
    241   WHERE t.status IN ('new', 'assigned', 'reopened')
    242     AND p.name=t.priority AND p.type='priority'
    243   ORDER BY t.milestone, p.value, t.severity, t.time
    244 }}}
    245 
    246 === Reporting on custom fields ===
    247 
    248 If 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.
    249 
    250 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.
     228FROM ticket t,enum p
     229WHERE t.status IN ('new', 'assigned', 'reopened')
     230  AND p.name = t.priority AND p.type = 'priority'
     231ORDER BY t.milestone, p.value, t.severity, t.time
     232}}}
     233
     234=== Reporting on custom fields
     235
     236If 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
     238If 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.
    251239
    252240=== A note about SQL rewriting #rewriting
    253241
    254242Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports:
    255  1. [#sort-order changing the sort order]
    256  2. pagination support (limitation of the number of result rows displayed on each page)
     243 1. [#sort-order sorting]
     244 1. pagination: limiting the number of results displayed on each page
    257245In 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.
    258246The 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:
    … …  
    262250
    263251Let's take an example, consider the following SQL query:
    264 {{{
     252{{{#!sql
    265253-- ## 4: Assigned, Active Tickets by Owner ## --
    266254
    267 -- 
     255--
    268256-- List assigned tickets, group by ticket owner, sorted by priority.
    269 -- 
     257--
    270258
    271259SELECT p.value AS __color__,
    … …  
    274262   changetime AS _changetime, description AS _description,
    275263   reporter AS _reporter
    276   FROM ticket t,enum p
    277   WHERE status = 'assigned'
    278 AND p.name=t.priority AND p.type='priority'
    279   ORDER BY __group__, p.value, severity, time
     264FROM ticket t,enum p
     265WHERE status = 'assigned'
     266  AND p.name = t.priority AND p.type = 'priority'
     267ORDER BY __group__, p.value, severity, time
    280268}}}
    281269
    282270The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`):
    283 {{{
     271{{{#!sql
    284272SELECT p.value AS __color__,
    285273   owner AS __group__,
    … …  
    287275   changetime AS _changetime, description AS _description,
    288276   reporter AS _reporter
    289   FROM ticket t,enum p
    290   WHERE status = 'assigned'
    291 AND p.name=t.priority AND p.type='priority'
    292   ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time
    293  LIMIT 4 OFFSET 4
     277FROM ticket t,enum p
     278WHERE status = 'assigned'
     279  AND p.name = t.priority AND p.type = 'priority'
     280ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time
     281LIMIT 4 OFFSET 4
    294282}}}
    295283
    296284The equivalent SQL query with the rewrite tokens would have been:
    297 {{{
     285{{{#!sql
    298286SELECT p.value AS __color__,
    299287   owner AS __group__,
    … …  
    301289   changetime AS _changetime, description AS _description,
    302290   reporter AS _reporter
    303   FROM ticket t,enum p
    304   WHERE status = 'assigned'
    305 AND p.name=t.priority AND p.type='priority'
    306   ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time
     291FROM ticket t,enum p
     292WHERE status = 'assigned'
     293  AND p.name = t.priority AND p.type = 'priority'
     294ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time
    307295@LIMIT_OFFSET@
    308296}}}
    309297
    310298If you want to always sort first by priority and only then by the user selected sort column, simply use the following `ORDER BY` clause:
    311 {{{
    312   ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time
    313 }}}
     299{{{#!sql
     300ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time
     301}}}
     302
     303== Changing Report Numbering
     304
     305There 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
     311Changing 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
     313UPDATE report SET id = 5 WHERE id = 3;
     314}}}
     315Keep 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
     317You may also need to update or remove the report number stored in the report or query.
    314318
    315319----
    316 See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
     320See also: TracTickets, TracQuery, [https://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]