Changes between Version 1 and Version 2 of TracReports
- Timestamp:
- Apr 3, 2020, 9:27:29 PM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracReports
v1 v2 17 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 18 19 20 19 A report consists of these basic parts: 21 20 * '''ID''' — Unique (sequential) identifier … … 31 30 32 31 == 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)'':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 35 34 * author text … … 48 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. 49 48 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)''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). 51 50 52 51 == Alternative Download Formats == … … 70 69 71 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.''' 72 73 73 74 A report is basically a single named SQL query, executed and presented by … … 108 109 }}} 109 110 110 --- 111 Dynamic variables can also be used in the report title and description (since 1.1.1). 111 112 112 113 == Advanced Reports: Dynamic Variables == … … 147 148 }}} 148 149 149 150 ----151 150 152 151 … … 156 155 specialized SQL statements to control the output of the Trac report engine. 157 156 158 == Special Columns==157 === Special Columns === 159 158 To format reports, TracReports looks for 'magic' column names in the query 160 159 result. These 'magic' names are processed and affect the layout and style of the … … 165 164 * '''id''' — same as '''ticket''' above when '''realm''' is not set 166 165 * '''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) 166 - 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 167 167 * '''created, modified, date, time''' — Format cell as a date and/or time. 168 168 * '''description''' — Ticket description field, parsed through the wiki engine. … … 194 194 </div> 195 195 }}} 196 * '''`__style__`''' — A custom CSS style expression to use for the current row. 196 * '''`__style__`''' — A custom CSS style expression to use on the `<tr>` element of the current row. 197 * '''`__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. 197 198 198 199 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' … … 217 218 also possible to create multi-line report entries. 218 219 219 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be becontinued on a second line.220 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line. 220 221 221 222 * '''`_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. … … 245 246 === Reporting on custom fields === 246 247 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 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 249 249 250 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 251 '''Note that you need to set up permissions in order to see the buttons for adding or editing reports.''' 252 === A note about SQL rewriting #rewriting 253 254 Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports: 255 1. [#sort-order changing the sort order] 256 2. pagination support (limitation of the number of result rows displayed on each page) 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. 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: 259 - `@SORT_COLUMN@`, the place where the name of the selected sort column will be inserted, 260 - `@LIMIT_OFFSET@`, the place where the pagination support clause will be added 261 Note that if you write them after an SQL comment, `--`, you'll effectively disable rewriting if this is what you want! 262 263 Let's take an example, consider the following SQL query: 264 {{{ 265 -- ## 4: Assigned, Active Tickets by Owner ## -- 266 267 -- 268 -- List assigned tickets, group by ticket owner, sorted by priority. 269 -- 270 271 SELECT p.value AS __color__, 272 owner AS __group__, 273 id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 274 changetime AS _changetime, description AS _description, 275 reporter AS _reporter 276 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 280 }}} 281 282 The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`): 283 {{{ 284 SELECT p.value AS __color__, 285 owner AS __group__, 286 id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 287 changetime AS _changetime, description AS _description, 288 reporter AS _reporter 289 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 294 }}} 295 296 The equivalent SQL query with the rewrite tokens would have been: 297 {{{ 298 SELECT p.value AS __color__, 299 owner AS __group__, 300 id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 301 changetime AS _changetime, description AS _description, 302 reporter AS _reporter 303 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 307 @LIMIT_OFFSET@ 308 }}} 309 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: 311 {{{ 312 ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time 313 }}} 252 314 253 315 ----
