Changes between Version 7 and Version 8 of TracReports
- Timestamp:
- 02/04/2017 09:40:03 AM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracReports
v7 v8 1 = Trac Reports 2 1 = Trac Reports = 3 2 [[TracGuideToc]] 4 3 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 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 {{{ 13 14 [components] 14 15 trac.ticket.report.* = disabled 15 16 }}} 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.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.'' 17 18 18 19 A report consists of these basic parts: … … 23 24 * '''Footer''' — Links to alternative download formats for this report. 24 25 25 == Changing Sort Order 26 26 == Changing Sort Order == 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 32 31 == Changing Report Numbering == 33 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: 34 33 * id integer PRIMARY KEY … … 38 37 * description text 39 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: 40 {{{ #!sql41 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.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). 44 43 45 44 You may also need to update or remove the report number stored in the report or query. 46 45 47 == Navigating Tickets 48 46 == Navigating Tickets == 49 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. 50 48 51 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). 52 50 53 == Alternative Download Formats 54 51 == Alternative Download Formats == 55 52 Aside from the default HTML view, reports can also be exported in a number of alternative formats. 56 53 At the bottom of the report page, you will find a list of available data formats. Click the desired link to 57 54 download the alternative report format. 58 55 59 === Comma-delimited - CSV (Comma Separated Values) 60 56 === Comma-delimited - CSV (Comma Separated Values) === 61 57 Export the report as plain text, each row on its own line, columns separated by a single comma (','). 62 58 '''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output. 63 59 64 === Tab-delimited 65 60 === Tab-delimited === 66 61 Like above, but uses tabs (\t) instead of comma. 67 62 68 === RSS - XML Content Syndication 69 63 === RSS - XML Content Syndication === 70 64 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. 71 65 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 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 == 84 82 The ''ticket'' table has the following columns: 85 83 * id … … 104 102 105 103 Example: '''All active tickets, sorted by priority and time''' 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 111 }}} 112 113 == Advanced Reports: Dynamic Variables 114 104 {{{ 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 == 115 114 For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements. 116 115 In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution. 117 116 118 === Using Variables in a Query 119 117 === Using Variables in a Query === 120 118 The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable. 121 119 122 120 Example: 123 {{{ #!sql121 {{{ 124 122 SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 125 123 }}} 126 124 127 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 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 128 {{{ 129 129 http://trac.edgewall.org/reports/14?PRIORITY=high 130 130 }}} 131 131 132 To use multiple variables, separate them with an '&': 132 To use multiple variables, separate them with an '&'. 133 134 Example: 133 135 {{{ 134 136 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 135 137 }}} 136 138 137 === !Special/Constant Variables 138 139 140 === !Special/Constant Variables === 139 141 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 140 142 141 143 * $USER — Username of logged in user. 142 144 143 Example : List all tickets assigned to me:144 {{{ #!sql145 Example (''List all tickets assigned to me''): 146 {{{ 145 147 SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 146 148 }}} 147 149 148 == Advanced Reports: Custom Formatting 149 150 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. 151 152 === Special Columns 153 154 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. 155 156 === Automatically formatted columns 157 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 === 158 163 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 159 164 * '''id''' — same as '''ticket''' above when '''realm''' is not set … … 164 169 165 170 '''Example:''' 166 {{{ #!sql171 {{{ 167 172 SELECT id AS ticket, created, status, summary FROM ticket 168 173 }}} … … 172 177 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 173 178 174 === Custom formatting columns 175 179 === Custom formatting columns === 176 180 Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are 177 181 assumed to be ''formatting hints'', affecting the appearance of the row. … … 194 198 195 199 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 196 {{{ #!sql200 {{{ 197 201 SELECT p.value AS __color__, 198 202 t.milestone AS __group__, 199 203 '../milestone/' || t.milestone AS __grouplink__, 200 204 (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 201 t.id AS ticket, summary 202 FROM ticket t,enum p 203 WHERE t.status IN ('new', 'assigned', 'reopened') 204 AND p.name = t.priority AND p.type = 'priority' 205 ORDER BY t.milestone, p.value, t.severity, t.time 206 }}} 207 208 '''Note:''' A table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table. 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. 209 214 210 215 === Changing layout of report rows === #column-syntax 211 212 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. 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. 213 219 214 220 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line. … … 221 227 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout'' 222 228 223 {{{ #!sql229 {{{ 224 230 SELECT p.value AS __color__, 225 231 t.milestone AS __group__, … … 232 238 description AS _description_, -- ## Uses a full row 233 239 changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output 234 FROM ticket t,enum p235 WHERE t.status IN ('new', 'assigned', 'reopened')236 AND p.name = t.priority AND p.type ='priority'237 ORDER BY t.milestone, p.value, t.severity, t.time238 }}} 239 240 === Reporting on custom fields 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 === 241 247 242 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. … … 248 254 Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports: 249 255 1. [#sort-order changing the sort order] 250 1. pagination support (limitation of the number of result rows displayed on each page)256 2. pagination support (limitation of the number of result rows displayed on each page) 251 257 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. 252 258 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: … … 256 262 257 263 Let's take an example, consider the following SQL query: 258 {{{ #!sql264 {{{ 259 265 -- ## 4: Assigned, Active Tickets by Owner ## -- 260 266 … … 268 274 changetime AS _changetime, description AS _description, 269 275 reporter AS _reporter 270 FROM ticket t,enum p271 WHERE status = 'assigned'272 AND p.name = t.priority AND p.type ='priority'273 ORDER BY __group__, p.value, severity, time276 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 274 280 }}} 275 281 276 282 The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`): 277 {{{ #!sql283 {{{ 278 284 SELECT p.value AS __color__, 279 285 owner AS __group__, … … 281 287 changetime AS _changetime, description AS _description, 282 288 reporter AS _reporter 283 FROM ticket t,enum p284 WHERE status = 'assigned'285 AND p.name = t.priority AND p.type ='priority'286 ORDER BY __group__ ASC, `component` ASC, __group__, p.value, severity, time287 LIMIT 4 OFFSET 4289 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 288 294 }}} 289 295 290 296 The equivalent SQL query with the rewrite tokens would have been: 291 {{{ #!sql297 {{{ 292 298 SELECT p.value AS __color__, 293 299 owner AS __group__, … … 295 301 changetime AS _changetime, description AS _description, 296 302 reporter AS _reporter 297 FROM ticket t,enum p298 WHERE status = 'assigned'299 AND p.name = t.priority AND p.type ='priority'300 ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time303 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 301 307 @LIMIT_OFFSET@ 302 308 }}} 303 309 304 310 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: 305 {{{ #!sql306 ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time311 {{{ 312 ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time 307 313 }}} 308 314
