Changes between Version 3 and Version 4 of TracReports


Ignore:
Timestamp:
Dec 4, 2020, 2:27:59 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracReports

    v3 v4  
    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.''
    18 
     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.
    1917
    2018A report consists of these basic parts:
    … …  
    2523 * '''Footer''' — Links to alternative download formats for this report.
    2624
    27 == Changing Sort Order ==
     25== Changing Sort Order
     26
    2827Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header.
    2928
    3029If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
    3130
    32 == Changing Report Numbering ==
    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 ''(since 0.10)'':
     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:
    3434 * id integer PRIMARY KEY
    3535 * author text
    … …  
    3838 * description text
    3939Changing 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 {{{
    41 update report set id=5 where id=3;
    42 }}}
    43 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).
     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.
    4444
    4545You may also need to update or remove the report number stored in the report or query.
    4646
    47 == Navigating Tickets ==
     47== Navigating Tickets
     48
    4849Clicking 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.
    4950
    50 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)''
    51 
    52 == Alternative Download Formats ==
     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
    5355Aside from the default HTML view, reports can also be exported in a number of alternative formats.
    5456At the bottom of the report page, you will find a list of available data formats. Click the desired link to
    5557download the alternative report format.
    5658
    57 === Comma-delimited - CSV (Comma Separated Values) ===
     59=== Comma-delimited - CSV (Comma Separated Values)
     60
    5861Export the report as plain text, each row on its own line, columns separated by a single comma (',').
    5962'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
    6063
    61 === Tab-delimited ===
     64=== Tab-delimited
     65
    6266Like above, but uses tabs (\t) instead of comma.
    6367
    64 === RSS - XML Content Syndication ===
     68=== RSS - XML Content Syndication
     69
    6570All 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.
    6671
    67 ----
    68 
    69 == Creating Custom Reports ==
    70 
    71 ''Creating a custom report requires a comfortable knowledge of SQL.''
    72 
    73 A report is basically a single named SQL query, executed and presented by
    74 Trac.  Reports can be viewed and created from a custom SQL expression directly
    75 in the web interface.
    76 
    77 Typically, a report consists of a SELECT-expression from the 'ticket' table,
    78 using the available columns and sorting the way you want it.
    79 
    80 == Ticket columns ==
     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
    8184The ''ticket'' table has the following columns:
    8285 * id
    … …  
    101104
    102105Example: '''All active tickets, sorted by priority and time'''
    103 {{{
    104 SELECT id AS ticket, status, severity, priority, owner,
    105        time AS created, summary FROM ticket
    106   WHERE status IN ('new', 'assigned', 'reopened')
    107   ORDER BY priority, time
    108 }}}
    109 
    110 ---
    111 
    112 == Advanced Reports: Dynamic Variables ==
     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
    113117For 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 ===
    117 The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
     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.
    118123
    119124Example:
    120 {{{
     125{{{#!sql
    121126SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
    122127}}}
    123128
    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:
     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 `$`:
    127132{{{
    128133 http://trac.edgewall.org/reports/14?PRIORITY=high
    129134}}}
    130135
    131 To use multiple variables, separate them with an '&'.
    132 
    133 Example:
     136To use multiple variables, separate them with an `&`:
    134137{{{
    135138 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    136139}}}
    137140
    138 
    139 === !Special/Constant Variables ===
     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
    140152There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
    141153
    142154 * $USER — Username of logged in user.
    143155
    144 Example (''List all tickets assigned to me''):
    145 {{{
     156Example: List all tickets assigned to me:
     157{{{#!sql
    146158SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
    147159}}}
    148160
    149 
    150 ----
    151 
    152 
    153 == Advanced Reports: Custom Formatting ==
    154 Trac is also capable of more advanced reports, including custom layouts,
    155 result grouping and user-defined CSS styles. To create such reports, we'll use
    156 specialized SQL statements to control the output of the Trac report engine.
    157 
    158 == Special Columns ==
    159 To format reports, TracReports looks for 'magic' column names in the query
    160 result. These 'magic' names are processed and affect the layout and style of the
    161 final report.
    162 
    163 === Automatically formatted columns ===
     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
    164171 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
    165172 * '''id''' — same as '''ticket''' above when '''realm''' is not set
    166173 * '''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
    167175 * '''created, modified, date, time''' — Format cell as a date and/or time.
    168176 * '''description''' — Ticket description field, parsed through the wiki engine.
    169177
    170178'''Example:'''
    171 {{{
     179{{{#!sql
    172180SELECT id AS ticket, created, status, summary FROM ticket
    173181}}}
    … …  
    177185See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
    178186
    179 === Custom formatting columns ===
     187=== Custom formatting columns
     188
    180189Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
    181190assumed to be ''formatting hints'', affecting the appearance of the row.
    … …  
    194203</div>
    195204}}}
    196  * '''`__style__`''' — A custom CSS style expression to use for the current row.
     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.
    197207
    198208'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
    199 {{{
     209{{{#!sql
    200210SELECT p.value AS __color__,
    201211     t.milestone AS __group__,
    202212     '../milestone/' || t.milestone AS __grouplink__,
    203213     (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.
     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.
    213222
    214223=== 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.
     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.
    218226
    219227 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line.
    … …  
    226234'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
    227235
    228 {{{
     236{{{#!sql
    229237SELECT p.value AS __color__,
    230238       t.milestone AS __group__,
    … …  
    237245       description AS _description_,                    -- ## Uses a full row
    238246       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.
     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.
    248256
    249257If 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.
    250258
    251 '''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''
     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}}}
    252321
    253322----