Changes between Version 4 and Version 5 of TracReports


Ignore:
Timestamp:
May 8, 2022, 3:11:05 PM (7 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v4 v5  
    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 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 
    33 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:
    34  * id integer PRIMARY KEY
    35  * author text
    36  * title text
    37  * query text
    38  * description text
    39 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:
    40 {{{#!sql
    41 UPDATE report SET id = 5 WHERE id = 3;
    42 }}}
    43 Keep 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 
    45 You may also need to update or remove the report number stored in the report or query.
     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.
    4630
    4731== Navigating Tickets
    4832
    49 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.
    50 
    51 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).
    52 
    53 == Alternative Download Formats
    54 
    55 Aside from the default HTML view, reports can also be exported in a number of alternative formats.
    56 At the bottom of the report page, you will find a list of available data formats. Click the desired link to 
    57 download the alternative report format.
     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.
    5842
    5943=== Comma-delimited - CSV (Comma Separated Values)
     
    7458Creating a custom report requires a comfortable knowledge of SQL.
    7559
    76 Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.
     60Note that you need grant [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.
    7761
    7862A 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.
     
    8872 * changetime
    8973 * component
    90  * severity 
    91  * priority 
     74 * severity
     75 * priority
    9276 * owner
    9377 * reporter
     
    10589Example: '''All active tickets, sorted by priority and time'''
    10690{{{#!sql
    107 SELECT id AS ticket, status, severity, priority, owner, time AS created, summary 
    108 FROM ticket 
     91SELECT id AS ticket, status, severity, priority, owner, time AS created, summary
     92FROM ticket
    10993WHERE status IN ('new', 'assigned', 'reopened')
    11094ORDER BY priority, time
    11195}}}
    11296
    113 Dynamic variables can also be used in the report title and description (since 1.1.1).
    114 
    11597== Advanced Reports: Dynamic Variables
    11698
    117 For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements. 
    118 In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution.
     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)//.
    119101
    120102=== Using Variables in a Query
    121103
    122 The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
     104The syntax for dynamic variables is simple, any upper case word beginning with `$` is considered a variable.
    123105
    124106Example:
     
    127109}}}
    128110
    129 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 '$':
     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 `$`:
    130114{{{
    131  http://trac.edgewall.org/reports/14?PRIORITY=high
    132 }}}
    133 
    134 To use multiple variables, separate them with an '&':
     115 https://trac.edgewall.org/reports/14?PRIORITY=high
     116}}}
     117
     118To use multiple variables, separate them with an `&`:
    135119{{{
    136  http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    137 }}}
     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
     128SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
     129}}}
     130
    138131
    139132=== !Special/Constant Variables
    140133
    141 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 
     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.
     
    154147=== Special Columns
    155148
    156 To 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.
     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.
    157150
    158151=== Automatically formatted columns
    159152
    160  * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 
     153 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
    161154 * '''id''' — same as '''ticket''' above when '''realm''' is not set
    162155 * '''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)
    163    - 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
    164157 * '''created, modified, date, time''' — Format cell as a date and/or time.
    165158 * '''description''' — Ticket description field, parsed through the wiki engine.
     
    167160'''Example:'''
    168161{{{#!sql
    169 SELECT id AS ticket, created, status, summary FROM ticket 
     162SELECT id AS ticket, created, status, summary FROM ticket
    170163}}}
    171164
    172165Those columns can also be defined but marked as hidden, see [#column-syntax below].
    173166
    174 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
     167See [trac:CookBook/Configuration/Reports] for examples of creating reports for realms other than ''ticket''.
    175168
    176169=== Custom formatting columns
    177170
    178 Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
     171Columns whose names begin and end with 2 underscores (e.g. '''`__color__`''') are
    179172assumed to be ''formatting hints'', affecting the appearance of the row.
    180  
     173
    181174 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table.
    182175 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
    183176 * '''`__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.
    184 {{{
    185 #!html
    186 <div style="margin-left:7.5em">Defaults:
     177 {{{#!html
     178<div style="margin-left:3em">Defaults:
    187179<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
    188180<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
     
    195187 * '''`__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.
    196188
    197 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
     189'''Example:''' List active tickets, grouped by milestone, group header linked to milestone page, colored by priority:
    198190{{{#!sql
    199191SELECT p.value AS __color__,
     
    203195     t.id AS ticket, summary
    204196FROM ticket t,enum p
    205 WHERE t.status IN ('new', 'assigned', 'reopened') 
     197WHERE t.status IN ('new', 'assigned', 'reopened')
    206198  AND p.name = t.priority AND p.type = 'priority'
    207199ORDER BY t.milestone, p.value, t.severity, t.time
    208200}}}
    209201
    210 '''Note:''' A table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
     202Note that table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
    211203
    212204=== Changing layout of report rows === #column-syntax
     
    221213   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.
    222214
    223 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     215'''Example:''' List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout:
    224216
    225217{{{#!sql
    226218SELECT p.value AS __color__,
    227219       t.milestone AS __group__,
    228        (CASE owner 
    229           WHEN 'daniel' THEN 'font-weight: bold; background: red;' 
     220       (CASE owner
     221          WHEN 'daniel' THEN 'font-weight: bold; background: red;'
    230222          ELSE '' END) AS __style__,
    231223       t.id AS ticket, summary AS summary_,             -- ## Break line here
     
    235227       changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
    236228FROM ticket t,enum p
    237 WHERE t.status IN ('new', 'assigned', 'reopened') 
     229WHERE t.status IN ('new', 'assigned', 'reopened')
    238230  AND p.name = t.priority AND p.type = 'priority'
    239231ORDER BY t.milestone, p.value, t.severity, t.time
     
    242234=== Reporting on custom fields
    243235
    244 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.
    245 
    246 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.
     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.
    247239
    248240=== A note about SQL rewriting #rewriting
    249241
    250242Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports:
    251  1. [#sort-order changing the sort order]
    252  1. 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
    253245In 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.
    254246The 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:
     
    261253-- ## 4: Assigned, Active Tickets by Owner ## --
    262254
    263 -- 
     255--
    264256-- List assigned tickets, group by ticket owner, sorted by priority.
    265 -- 
     257--
    266258
    267259SELECT p.value AS __color__,
     
    309301}}}
    310302
     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.
     318
    311319----
    312 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]