![(please configure [header_logo] section in trac.ini)](https://lpsc.in2p3.fr/trac/chrome/common/logo_LPSC.png){kind=logo}
Changes between Version 11 and Version 12 of TracReports
- Timestamp:
- 17/07/2015 11:41:26 (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracReports
v11 v12 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 109 }}} 110 111 112 == Advanced Reports: Dynamic Variables == 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 113 115 For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements. 114 116 In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution. 115 117 116 === Using Variables in a Query === 118 === Using Variables in a Query 119 117 120 The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable. 118 121 119 122 Example: 120 {{{ 123 {{{#!sql 121 124 SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 122 125 }}} 123 126 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: 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 '$': 127 128 {{{ 128 129 http://trac.edgewall.org/reports/14?PRIORITY=high 129 130 }}} 130 131 131 To use multiple variables, separate them with an '&'. 132 133 Example: 132 To use multiple variables, separate them with an '&': 134 133 {{{ 135 134 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 136 135 }}} 137 136 138 139 === !Special/Constant Variables === 137 === !Special/Constant Variables 138 140 139 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 141 140 142 141 * $USER — Username of logged in user. 143 142 144 Example (''List all tickets assigned to me''):145 {{{ 143 Example: List all tickets assigned to me: 144 {{{#!sql 146 145 SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 147 146 }}} 148 147 149 150 151 == Advanced Reports: Custom Formatting == 152 Trac is also capable of more advanced reports, including custom layouts, 153 result grouping and user-defined CSS styles. To create such reports, we'll use 154 specialized SQL statements to control the output of the Trac report engine. 155 156 === Special Columns === 157 To format reports, TracReports looks for 'magic' column names in the query 158 result. These 'magic' names are processed and affect the layout and style of the 159 final report. 160 161 === Automatically formatted columns === 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 162 158 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 163 159 * '''id''' — same as '''ticket''' above when '''realm''' is not set … … 168 164 169 165 '''Example:''' 170 {{{ 166 {{{#!sql 171 167 SELECT id AS ticket, created, status, summary FROM ticket 172 168 }}} … … 176 172 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 177 173 178 === Custom formatting columns === 174 === Custom formatting columns 175 179 176 Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are 180 177 assumed to be ''formatting hints'', affecting the appearance of the row. … … 197 194 198 195 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 199 {{{ 196 {{{#!sql 200 197 SELECT p.value AS __color__, 201 198 t.milestone AS __group__, 202 199 '../milestone/' || t.milestone AS __grouplink__, 203 200 (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. 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. 213 209 214 210 === 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. 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. 218 213 219 214 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line. … … 226 221 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout'' 227 222 228 {{{ 223 {{{#!sql 229 224 SELECT p.value AS __color__, 230 225 t.milestone AS __group__, … … 237 232 description AS _description_, -- ## Uses a full row 238 233 changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output 239 240 241 AND p.name=t.priority AND p.type='priority'242 243 }}} 244 245 === Reporting on custom fields ===234 FROM ticket t,enum p 235 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.time 238 }}} 239 240 === Reporting on custom fields 246 241 247 242 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. … … 253 248 Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports: 254 249 1. [#sort-order changing the sort order] 255 2. pagination support (limitation of the number of result rows displayed on each page)250 1. pagination support (limitation of the number of result rows displayed on each page) 256 251 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. 257 252 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: … … 261 256 262 257 Let's take an example, consider the following SQL query: 263 {{{ 258 {{{#!sql 264 259 -- ## 4: Assigned, Active Tickets by Owner ## -- 265 260 … … 273 268 changetime AS _changetime, description AS _description, 274 269 reporter AS _reporter 275 276 277 AND p.name=t.priority AND p.type='priority'278 270 FROM ticket t,enum p 271 WHERE status = 'assigned' 272 AND p.name = t.priority AND p.type = 'priority' 273 ORDER BY __group__, p.value, severity, time 279 274 }}} 280 275 281 276 The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`): 282 {{{ 277 {{{#!sql 283 278 SELECT p.value AS __color__, 284 279 owner AS __group__, … … 286 281 changetime AS _changetime, description AS _description, 287 282 reporter AS _reporter 288 289 290 AND p.name=t.priority AND p.type='priority'291 292 283 FROM ticket t,enum p 284 WHERE status = 'assigned' 285 AND p.name = t.priority AND p.type = 'priority' 286 ORDER BY __group__ ASC, `component` ASC, __group__, p.value, severity, time 287 LIMIT 4 OFFSET 4 293 288 }}} 294 289 295 290 The equivalent SQL query with the rewrite tokens would have been: 296 {{{ 291 {{{#!sql 297 292 SELECT p.value AS __color__, 298 293 owner AS __group__, … … 300 295 changetime AS _changetime, description AS _description, 301 296 reporter AS _reporter 302 303 304 AND p.name=t.priority AND p.type='priority'305 297 FROM ticket t,enum p 298 WHERE status = 'assigned' 299 AND p.name = t.priority AND p.type = 'priority' 300 ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time 306 301 @LIMIT_OFFSET@ 307 302 }}} 308 303 309 304 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: 310 {{{ 311 305 {{{#!sql 306 ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time 312 307 }}} 313 308
