Changes between Version 9 and Version 10 of TracReports
- Timestamp:
- May 10, 2020, 8:18:21 PM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracReports
v9 v10 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.''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. 18 17 19 18 A report consists of these basic parts: … … 24 23 * '''Footer''' — Links to alternative download formats for this report. 25 24 26 == Changing Sort Order == 25 == Changing Sort Order 26 27 27 Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header. 28 28 29 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 30 31 == Changing Report Numbering == 31 == Changing Report Numbering 32 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: 33 34 * id integer PRIMARY KEY … … 37 38 * description text 38 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: 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).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. 43 44 44 45 You may also need to update or remove the report number stored in the report or query. 45 46 46 == Navigating Tickets == 47 == Navigating Tickets 48 47 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. 48 50 49 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). 50 52 51 == Alternative Download Formats == 53 == Alternative Download Formats 54 52 55 Aside from the default HTML view, reports can also be exported in a number of alternative formats. 53 56 At the bottom of the report page, you will find a list of available data formats. Click the desired link to 54 57 download the alternative report format. 55 58 56 === Comma-delimited - CSV (Comma Separated Values) === 59 === Comma-delimited - CSV (Comma Separated Values) 60 57 61 Export the report as plain text, each row on its own line, columns separated by a single comma (','). 58 62 '''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output. 59 63 60 === Tab-delimited === 64 === Tab-delimited 65 61 66 Like above, but uses tabs (\t) instead of comma. 62 67 63 === RSS - XML Content Syndication === 68 === RSS - XML Content Syndication 69 64 70 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. 65 71 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 == 72 == Creating Custom Reports 73 74 Creating a custom report requires a comfortable knowledge of SQL. 75 76 Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports. 77 78 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. 79 80 Typically, 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 82 84 The ''ticket'' table has the following columns: 83 85 * id … … 102 104 103 105 Example: '''All active tickets, sorted by priority and time''' 104 {{{ 105 SELECT id AS ticket, status, severity, priority, owner, 106 time AS created, summaryFROM ticket107 108 106 {{{#!sql 107 SELECT id AS ticket, status, severity, priority, owner, time AS created, summary 108 FROM ticket 109 WHERE status IN ('new', 'assigned', 'reopened') 110 ORDER BY priority, time 109 111 }}} 110 112 111 113 Dynamic variables can also be used in the report title and description (since 1.1.1). 112 114 113 == Advanced Reports: Dynamic Variables == 115 == Advanced Reports: Dynamic Variables 116 114 117 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. 118 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)//. 119 120 === Using Variables in a Query 121 122 The syntax for dynamic variables is simple, any upper case word beginning with `$` is considered a variable. 119 123 120 124 Example: 121 {{{ 125 {{{#!sql 122 126 SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 123 127 }}} 124 128 125 T o 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:129 The value of the dynamic variable can be assigned in the report preferences form. 130 131 To assign a value to `$PRIORITY` in the URL for a report, leave out the leading `$`: 128 132 {{{ 129 133 http://trac.edgewall.org/reports/14?PRIORITY=high 130 134 }}} 131 135 132 To use multiple variables, separate them with an '&'. 133 134 Example: 136 To use multiple variables, separate them with an `&`: 135 137 {{{ 136 138 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 137 139 }}} 138 140 139 140 === !Special/Constant Variables === 141 It is possible to assign a default value to the variable, within a SQL comment: 142 143 {{{#!sql 144 -- PRIORITY = high 145 146 SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 147 }}} 148 149 150 === !Special/Constant Variables 151 141 152 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 142 153 143 154 * $USER — Username of logged in user. 144 155 145 Example (''List all tickets assigned to me''):146 {{{ 156 Example: List all tickets assigned to me: 157 {{{#!sql 147 158 SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 148 159 }}} 149 160 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 === 161 == Advanced Reports: Custom Formatting 162 163 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. 164 165 === Special Columns 166 167 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. 168 169 === Automatically formatted columns 170 163 171 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 164 172 * '''id''' — same as '''ticket''' above when '''realm''' is not set … … 169 177 170 178 '''Example:''' 171 {{{ 179 {{{#!sql 172 180 SELECT id AS ticket, created, status, summary FROM ticket 173 181 }}} … … 177 185 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 178 186 179 === Custom formatting columns === 187 === Custom formatting columns 188 180 189 Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are 181 190 assumed to be ''formatting hints'', affecting the appearance of the row. … … 198 207 199 208 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 200 {{{ 209 {{{#!sql 201 210 SELECT p.value AS __color__, 202 211 t.milestone AS __group__, 203 212 '../milestone/' || t.milestone AS __grouplink__, 204 213 (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. 214 t.id AS ticket, summary 215 FROM ticket t,enum p 216 WHERE t.status IN ('new', 'assigned', 'reopened') 217 AND p.name = t.priority AND p.type = 'priority' 218 ORDER 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. 214 222 215 223 === 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. 224 225 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. 219 226 220 227 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line. … … 227 234 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout'' 228 235 229 {{{ 236 {{{#!sql 230 237 SELECT p.value AS __color__, 231 238 t.milestone AS __group__, … … 238 245 description AS _description_, -- ## Uses a full row 239 246 changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output 240 241 242 AND p.name=t.priority AND p.type='priority'243 244 }}} 245 246 === Reporting on custom fields ===247 FROM ticket t,enum p 248 WHERE t.status IN ('new', 'assigned', 'reopened') 249 AND p.name = t.priority AND p.type = 'priority' 250 ORDER BY t.milestone, p.value, t.severity, t.time 251 }}} 252 253 === Reporting on custom fields 247 254 248 255 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. … … 254 261 Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports: 255 262 1. [#sort-order changing the sort order] 256 2. pagination support (limitation of the number of result rows displayed on each page)263 1. pagination support (limitation of the number of result rows displayed on each page) 257 264 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. 258 265 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: … … 262 269 263 270 Let's take an example, consider the following SQL query: 264 {{{ 271 {{{#!sql 265 272 -- ## 4: Assigned, Active Tickets by Owner ## -- 266 273 … … 274 281 changetime AS _changetime, description AS _description, 275 282 reporter AS _reporter 276 277 278 AND p.name=t.priority AND p.type='priority'279 283 FROM ticket t,enum p 284 WHERE status = 'assigned' 285 AND p.name = t.priority AND p.type = 'priority' 286 ORDER BY __group__, p.value, severity, time 280 287 }}} 281 288 282 289 The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`): 283 {{{ 290 {{{#!sql 284 291 SELECT p.value AS __color__, 285 292 owner AS __group__, … … 287 294 changetime AS _changetime, description AS _description, 288 295 reporter AS _reporter 289 290 291 AND p.name=t.priority AND p.type='priority'292 293 296 FROM ticket t,enum p 297 WHERE status = 'assigned' 298 AND p.name = t.priority AND p.type = 'priority' 299 ORDER BY __group__ ASC, `component` ASC, __group__, p.value, severity, time 300 LIMIT 4 OFFSET 4 294 301 }}} 295 302 296 303 The equivalent SQL query with the rewrite tokens would have been: 297 {{{ 304 {{{#!sql 298 305 SELECT p.value AS __color__, 299 306 owner AS __group__, … … 301 308 changetime AS _changetime, description AS _description, 302 309 reporter AS _reporter 303 304 305 AND p.name=t.priority AND p.type='priority'306 310 FROM ticket t,enum p 311 WHERE status = 'assigned' 312 AND p.name = t.priority AND p.type = 'priority' 313 ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time 307 314 @LIMIT_OFFSET@ 308 315 }}} 309 316 310 317 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: 311 {{{ 312 318 {{{#!sql 319 ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time 313 320 }}} 314 321
