![(please configure the [header_logo] section in trac.ini)](/pubtrac/Utilities/chrome/site/your_project_logo.png){kind=logo}
Changes between Version 2 and Version 3 of TracReports
- Timestamp:
- 12/24/20 10:50:42 (4 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracReports
v2 v3 5 5 The Trac reports module provides a simple, yet powerful reporting facility to present information about tickets in the Trac database. 6 6 7 Rather than have its own report definition format, TracReports relies on standard SQL `SELECT` statements for custom report definition. 7 Rather than have its own report definition format, TracReports relies on standard SQL `SELECT` statements for custom report definition. 8 8 9 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. … … 17 17 18 18 A report consists of these basic parts: 19 * '''ID''' — Unique (sequential) identifier 19 * '''ID''' — Unique (sequential) identifier 20 20 * '''Title''' — Descriptive title 21 21 * '''Description''' — A brief description of the report, in WikiFormatting text. … … 25 25 == Changing Sort Order 26 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. 27 Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header. 28 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 31 == Changing Report Numbering 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: 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 {{{#!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. 44 45 You may also need to update or remove the report number stored in the report or query. 30 46 31 47 == Navigating Tickets 32 48 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 == Alternat e Download Formats38 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 alternat eformat.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. 50 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). 52 53 == Alternative Download Formats 54 55 Aside from the default HTML view, reports can also be exported in a number of alternative formats. 56 At the bottom of the report page, you will find a list of available data formats. Click the desired link to 57 download the alternative report format. 42 58 43 59 === Comma-delimited - CSV (Comma Separated Values) … … 58 74 Creating a custom report requires a comfortable knowledge of SQL. 59 75 60 Note that you need grant[TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.76 Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports. 61 77 62 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. … … 72 88 * changetime 73 89 * component 74 * severity 75 * priority 90 * severity 91 * priority 76 92 * owner 77 93 * reporter … … 89 105 Example: '''All active tickets, sorted by priority and time''' 90 106 {{{#!sql 91 SELECT id AS ticket, status, severity, priority, owner, time AS created, summary 92 FROM ticket 107 SELECT id AS ticket, status, severity, priority, owner, time AS created, summary 108 FROM ticket 93 109 WHERE status IN ('new', 'assigned', 'reopened') 94 110 ORDER BY priority, time 95 111 }}} 96 112 113 Dynamic variables can also be used in the report title and description (since 1.1.1). 114 97 115 == Advanced Reports: Dynamic Variables 98 116 99 For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements. 117 For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements. 100 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)//. 101 119 … … 113 131 To assign a value to `$PRIORITY` in the URL for a report, leave out the leading `$`: 114 132 {{{ 115 http s://trac.edgewall.org/reports/14?PRIORITY=high133 http://trac.edgewall.org/reports/14?PRIORITY=high 116 134 }}} 117 135 118 136 To use multiple variables, separate them with an `&`: 119 137 {{{ 120 http s://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical138 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 121 139 }}} 122 140 … … 132 150 === !Special/Constant Variables 133 151 134 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 152 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 135 153 136 154 * $USER — Username of logged in user. … … 147 165 === Special Columns 148 166 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.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. 150 168 151 169 === Automatically formatted columns 152 170 153 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 171 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 154 172 * '''id''' — same as '''ticket''' above when '''realm''' is not set 155 173 * '''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''' columns174 - 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 157 175 * '''created, modified, date, time''' — Format cell as a date and/or time. 158 176 * '''description''' — Ticket description field, parsed through the wiki engine. … … 160 178 '''Example:''' 161 179 {{{#!sql 162 SELECT id AS ticket, created, status, summary FROM ticket 180 SELECT id AS ticket, created, status, summary FROM ticket 163 181 }}} 164 182 165 183 Those columns can also be defined but marked as hidden, see [#column-syntax below]. 166 184 167 See [trac:CookBook/Configuration/Reports] for examplesof creating reports for realms other than ''ticket''.185 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 168 186 169 187 === Custom formatting columns 170 188 171 Columns whose names begin and end with 2 underscores ( e.g.'''`__color__`''') are189 Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are 172 190 assumed to be ''formatting hints'', affecting the appearance of the row. 173 191 174 192 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table. 175 193 * '''`__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 194 * '''`__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: 195 {{{ 196 #!html 197 <div style="margin-left:7.5em">Defaults: 179 198 <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span> 180 199 <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span> … … 187 206 * '''`__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 207 189 '''Example:''' List active tickets, grouped by milestone, group header linked to milestone page, colored by priority:208 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 190 209 {{{#!sql 191 210 SELECT p.value AS __color__, … … 195 214 t.id AS ticket, summary 196 215 FROM ticket t,enum p 197 WHERE t.status IN ('new', 'assigned', 'reopened') 216 WHERE t.status IN ('new', 'assigned', 'reopened') 198 217 AND p.name = t.priority AND p.type = 'priority' 199 218 ORDER BY t.milestone, p.value, t.severity, t.time 200 219 }}} 201 220 202 Note thattable join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.221 '''Note:''' A table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table. 203 222 204 223 === Changing layout of report rows === #column-syntax … … 213 232 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. 214 233 215 '''Example:''' List active tickets, grouped by milestone, colored by priority, with description and multi-line layout:234 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout'' 216 235 217 236 {{{#!sql 218 237 SELECT p.value AS __color__, 219 238 t.milestone AS __group__, 220 (CASE owner 221 WHEN 'daniel' THEN 'font-weight: bold; background: red;' 239 (CASE owner 240 WHEN 'daniel' THEN 'font-weight: bold; background: red;' 222 241 ELSE '' END) AS __style__, 223 242 t.id AS ticket, summary AS summary_, -- ## Break line here … … 227 246 changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output 228 247 FROM ticket t,enum p 229 WHERE t.status IN ('new', 'assigned', 'reopened') 248 WHERE t.status IN ('new', 'assigned', 'reopened') 230 249 AND p.name = t.priority AND p.type = 'priority' 231 250 ORDER BY t.milestone, p.value, t.severity, t.time … … 234 253 === Reporting on custom fields 235 254 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.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. 256 257 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 258 240 259 === A note about SQL rewriting #rewriting 241 260 242 261 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 page262 1. [#sort-order changing the sort order] 263 1. pagination support (limitation of the number of result rows displayed on each page) 245 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. 246 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: … … 253 272 -- ## 4: Assigned, Active Tickets by Owner ## -- 254 273 255 -- 274 -- 256 275 -- List assigned tickets, group by ticket owner, sorted by priority. 257 -- 276 -- 258 277 259 278 SELECT p.value AS __color__, … … 301 320 }}} 302 321 303 == Changing Report Numbering304 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 KEY307 * author text308 * title text309 * query text310 * description text311 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 {{{#!sql313 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.318 319 322 ---- 320 See also: TracTickets, TracQuery, [https://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]323 See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
