Changes between Version 1 and Version 2 of TracReports
- Timestamp:
- 2023-04-20T18:30:58Z (19 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracReports
v1 v2 1 = Trac Reports = 1 = Trac Reports 2 2 3 [[TracGuideToc]] 3 4 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 {{{ 5 The Trac reports module provides a simple, yet powerful reporting facility to present information about tickets in the Trac database. 6 7 Rather 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 14 13 [components] 15 14 trac.ticket.report.* = disabled 16 15 }}} 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. 19 17 20 18 A report consists of these basic parts: 21 * '''ID''' -- Unique (sequential) identifier 22 * '''Title''' -- Descriptive title 23 * '''Description''' -- A brief description of the report, in WikiFormatting text. 24 * '''Report Body''' -- List of results from report query, formatted according to the methods described below. 25 * '''Footer''' -- Links to alternative download formats for this report. 26 27 == Changing Sort Order == 28 Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header. 29 30 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. 31 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 (as of 0.10): 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 {{{ 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). 44 45 You may also need to update or remove the report number stored in the report or query. 46 47 == Navigating Tickets == 48 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. 49 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 == 53 Aside from the default HTML view, reports can also be exported in a number of alternative formats. 54 At the bottom of the report page, you will find a list of available data formats. Click the desired link to 55 download the alternative report format. 56 57 === Comma-delimited - CSV (Comma Separated Values) === 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 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. 30 31 == Navigating Tickets 32 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. 42 43 === Comma-delimited - CSV (Comma Separated Values) 44 58 45 Export the report as plain text, each row on its own line, columns separated by a single comma (','). 59 '''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure. 60 61 === Tab-delimited === 46 '''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output. 47 48 === Tab-delimited 49 62 50 Like above, but uses tabs (\t) instead of comma. 63 51 64 === RSS - XML Content Syndication === 52 === RSS - XML Content Syndication 53 65 54 All 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. 66 55 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 from 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 == 56 == Creating Custom Reports 57 58 Creating a custom report requires a comfortable knowledge of SQL. 59 60 Note that you need grant [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports. 61 62 A 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 64 Typically, 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 81 68 The ''ticket'' table has the following columns: 82 69 * id … … 85 72 * changetime 86 73 * component 87 * severity 88 * priority 74 * severity 75 * priority 89 76 * owner 90 77 * reporter … … 100 87 See TracTickets for a detailed description of the column fields. 101 88 102 '''all active tickets, sorted by priority and time''' 103 104 '''Example:''' ''All active tickets, sorted by priority and time'' 89 Example: '''All active tickets, sorted by priority and time''' 90 {{{#!sql 91 SELECT id AS ticket, status, severity, priority, owner, time AS created, summary 92 FROM ticket 93 WHERE status IN ('new', 'assigned', 'reopened') 94 ORDER BY priority, time 95 }}} 96 97 == Advanced Reports: Dynamic Variables 98 99 For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements. 100 In 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 104 The syntax for dynamic variables is simple, any upper case word beginning with `$` is considered a variable. 105 106 Example: 107 {{{#!sql 108 SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 109 }}} 110 111 The value of the dynamic variable can be assigned in the report preferences form. 112 113 To assign a value to `$PRIORITY` in the URL for a report, leave out the leading `$`: 105 114 {{{ 106 SELECT id AS ticket, status, severity, priority, owner, 107 time as created, summary FROM ticket 108 WHERE status IN ('new', 'assigned', 'reopened') 109 ORDER BY priority, time 110 }}} 111 112 113 ---- 114 115 116 == Advanced Reports: Dynamic Variables == 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. 119 120 === Using Variables in a Query === 121 The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable. 122 123 Example: 115 https://trac.edgewall.org/reports/14?PRIORITY=high 116 }}} 117 118 To use multiple variables, separate them with an `&`: 124 119 {{{ 120 https://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 121 }}} 122 123 It is possible to assign a default value to the variable, within a SQL comment: 124 125 {{{#!sql 126 -- PRIORITY = high 127 125 128 SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 126 129 }}} 127 130 128 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 '$'. 129 130 Example: 131 {{{ 132 http://trac.edgewall.org/reports/14?PRIORITY=high 133 }}} 134 135 To use multiple variables, separate them with an '&'. 136 137 Example: 138 {{{ 139 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 140 }}} 141 142 143 === Special/Constant Variables === 144 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL. 145 146 * $USER -- Username of logged in user. 147 148 Example (''List all tickets assigned to me''): 149 {{{ 131 132 === !Special/Constant Variables 133 134 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 135 136 * $USER — Username of logged in user. 137 138 Example: List all tickets assigned to me: 139 {{{#!sql 150 140 SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 151 141 }}} 152 142 153 154 ---- 155 156 157 == Advanced Reports: Custom Formatting == 158 Trac is also capable of more advanced reports, including custom layouts, 159 result grouping and user-defined CSS styles. To create such reports, we'll use 160 specialized SQL statements to control the output of the Trac report engine. 161 162 == Special Columns == 163 To format reports, TracReports looks for 'magic' column names in the query 164 result. These 'magic' names are processed and affect the layout and style of the 165 final report. 166 167 === Automatically formatted columns === 168 * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket. 169 * '''id''' -- same as '''ticket''' above when '''realm''' is not set 170 * '''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) 171 * '''created, modified, date, time''' -- Format cell as a date and/or time. 172 * '''description''' -- Ticket description field, parsed through the wiki engine. 143 == Advanced Reports: Custom Formatting 144 145 Trac 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 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. 150 151 === Automatically formatted columns 152 153 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 154 * '''id''' — same as '''ticket''' above when '''realm''' is not set 155 * '''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 157 * '''created, modified, date, time''' — Format cell as a date and/or time. 158 * '''description''' — Ticket description field, parsed through the wiki engine. 173 159 174 160 '''Example:''' 175 {{{ 176 SELECT id as ticket, created, status, summary FROM ticket161 {{{#!sql 162 SELECT id AS ticket, created, status, summary FROM ticket 177 163 }}} 178 164 179 165 Those columns can also be defined but marked as hidden, see [#column-syntax below]. 180 166 181 === Custom formatting columns === 182 Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are 167 See [trac:CookBook/Configuration/Reports] for examples of creating reports for realms other than ''ticket''. 168 169 === Custom formatting columns 170 171 Columns whose names begin and end with 2 underscores (e.g. '''`__color__`''') are 183 172 assumed to be ''formatting hints'', affecting the appearance of the row. 184 185 * '''`__group__`''' --Group results based on values in this column. Each group will have its own header and table.186 * '''`__ 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.187 {{{ 188 #!html189 <div style="margin-left: 7.5em">Defaults:173 174 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table. 175 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group. 176 * '''`__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: 190 179 <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span> 191 180 <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span> … … 195 184 </div> 196 185 }}} 197 * '''`__style__`''' -- A custom CSS style expression to use for the current row. 198 199 '''Example:''' ''List active tickets, grouped by milestone, colored by priority'' 200 {{{ 186 * '''`__style__`''' — A custom CSS style expression to use on the `<tr>` element of the current row. 187 * '''`__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. 188 189 '''Example:''' List active tickets, grouped by milestone, group header linked to milestone page, colored by priority: 190 {{{#!sql 201 191 SELECT p.value AS __color__, 202 192 t.milestone AS __group__, 193 '../milestone/' || t.milestone AS __grouplink__, 203 194 (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. 195 t.id AS ticket, summary 196 FROM ticket t,enum p 197 WHERE t.status IN ('new', 'assigned', 'reopened') 198 AND p.name = t.priority AND p.type = 'priority' 199 ORDER BY t.milestone, p.value, t.severity, t.time 200 }}} 201 202 Note that table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table. 213 203 214 204 === 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. 218 219 * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line. 220 221 * '''`_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. 222 223 * '''`_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). 205 206 By 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. 207 208 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line. 209 210 * '''`_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. 211 212 * '''`_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). 224 213 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. 225 214 226 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout''227 228 {{{ 215 '''Example:''' List active tickets, grouped by milestone, colored by priority, with description and multi-line layout: 216 217 {{{#!sql 229 218 SELECT p.value AS __color__, 230 219 t.milestone AS __group__, 231 (CASE owner 232 WHEN 'daniel' THEN 'font-weight: bold; background: red;' 220 (CASE owner 221 WHEN 'daniel' THEN 'font-weight: bold; background: red;' 233 222 ELSE '' END) AS __style__, 234 223 t.id AS ticket, summary AS summary_, -- ## Break line here … … 237 226 description AS _description_, -- ## Uses a full row 238 227 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. 248 249 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. 250 251 '''Note that you need to set up permissions in order to see the buttons for adding or editing reports.''' 228 FROM ticket t,enum p 229 WHERE t.status IN ('new', 'assigned', 'reopened') 230 AND p.name = t.priority AND p.type = 'priority' 231 ORDER BY t.milestone, p.value, t.severity, t.time 232 }}} 233 234 === Reporting on custom fields 235 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. 239 240 === A note about SQL rewriting #rewriting 241 242 Beyond 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 245 In 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. 246 The 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: 247 - `@SORT_COLUMN@`, the place where the name of the selected sort column will be inserted, 248 - `@LIMIT_OFFSET@`, the place where the pagination support clause will be added 249 Note that if you write them after an SQL comment, `--`, you'll effectively disable rewriting if this is what you want! 250 251 Let's take an example, consider the following SQL query: 252 {{{#!sql 253 -- ## 4: Assigned, Active Tickets by Owner ## -- 254 255 -- 256 -- List assigned tickets, group by ticket owner, sorted by priority. 257 -- 258 259 SELECT p.value AS __color__, 260 owner AS __group__, 261 id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 262 changetime AS _changetime, description AS _description, 263 reporter AS _reporter 264 FROM ticket t,enum p 265 WHERE status = 'assigned' 266 AND p.name = t.priority AND p.type = 'priority' 267 ORDER BY __group__, p.value, severity, time 268 }}} 269 270 The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`): 271 {{{#!sql 272 SELECT p.value AS __color__, 273 owner AS __group__, 274 id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 275 changetime AS _changetime, description AS _description, 276 reporter AS _reporter 277 FROM ticket t,enum p 278 WHERE status = 'assigned' 279 AND p.name = t.priority AND p.type = 'priority' 280 ORDER BY __group__ ASC, `component` ASC, __group__, p.value, severity, time 281 LIMIT 4 OFFSET 4 282 }}} 283 284 The equivalent SQL query with the rewrite tokens would have been: 285 {{{#!sql 286 SELECT p.value AS __color__, 287 owner AS __group__, 288 id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 289 changetime AS _changetime, description AS _description, 290 reporter AS _reporter 291 FROM ticket t,enum p 292 WHERE status = 'assigned' 293 AND p.name = t.priority AND p.type = 'priority' 294 ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time 295 @LIMIT_OFFSET@ 296 }}} 297 298 If you want to always sort first by priority and only then by the user selected sort column, simply use the following `ORDER BY` clause: 299 {{{#!sql 300 ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time 301 }}} 302 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. 252 318 253 319 ---- 254 See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]320 See also: TracTickets, TracQuery, [https://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
