Changes between Version 2 and Version 3 of TracReports
- Timestamp:
- Aug 1, 2024, 10:29:26 AM (4 months 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 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. 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. 46 30 47 31 == Navigating Tickets 48 32 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 == Alternat ive Download Formats54 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 alternat ive reportformat.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 == Alternate Download Formats 38 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 alternate format. 58 42 59 43 === Comma-delimited - CSV (Comma Separated Values) … … 74 58 Creating a custom report requires a comfortable knowledge of SQL. 75 59 76 Note that you need to set up[TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.60 Note that you need grant [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports. 77 61 78 62 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. … … 88 72 * changetime 89 73 * component 90 * severity 91 * priority 74 * severity 75 * priority 92 76 * owner 93 77 * reporter … … 105 89 Example: '''All active tickets, sorted by priority and time''' 106 90 {{{#!sql 107 SELECT id AS ticket, status, severity, priority, owner, time AS created, summary 108 FROM ticket 91 SELECT id AS ticket, status, severity, priority, owner, time AS created, summary 92 FROM ticket 109 93 WHERE status IN ('new', 'assigned', 'reopened') 110 94 ORDER BY priority, time … … 113 97 == Advanced Reports: Dynamic Variables 114 98 115 For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements. 116 In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution. 99 For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements. 100 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)//. 117 101 118 102 === Using Variables in a Query 119 103 120 The syntax for dynamic variables is simple, any upper case word beginning with '$'is considered a variable.104 The syntax for dynamic variables is simple, any upper case word beginning with `$` is considered a variable. 121 105 122 106 Example: … … 125 109 }}} 126 110 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 '$': 111 The value of the dynamic variable can be assigned in the report preferences form. 112 113 To assign a value to `$PRIORITY` in the URL for a report, leave out the leading `$`: 128 114 {{{ 129 http ://trac.edgewall.org/reports/14?PRIORITY=high130 }}} 131 132 To use multiple variables, separate them with an '&':115 https://trac.edgewall.org/reports/14?PRIORITY=high 116 }}} 117 118 To use multiple variables, separate them with an `&`: 133 119 {{{ 134 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 135 }}} 120 https://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 121 }}} 122 123 It is possible to assign a default value to the variable, within a SQL comment: 124 125 {{{#!sql 126 -- PRIORITY = high 127 128 SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 129 }}} 130 136 131 137 132 === !Special/Constant Variables 138 133 139 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 134 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 140 135 141 136 * $USER — Username of logged in user. … … 152 147 === Special Columns 153 148 154 To format reports, TracReports look sfor 'magic' column names in the query result. These 'magic' names are processed and affect the layout and style of the final report.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. 155 150 156 151 === Automatically formatted columns 157 152 158 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 153 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 159 154 * '''id''' — same as '''ticket''' above when '''realm''' is not set 160 155 * '''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) 161 - 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''' columns156 - 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''' columns 162 157 * '''created, modified, date, time''' — Format cell as a date and/or time. 163 158 * '''description''' — Ticket description field, parsed through the wiki engine. … … 165 160 '''Example:''' 166 161 {{{#!sql 167 SELECT id AS ticket, created, status, summary FROM ticket 162 SELECT id AS ticket, created, status, summary FROM ticket 168 163 }}} 169 164 170 165 Those columns can also be defined but marked as hidden, see [#column-syntax below]. 171 166 172 See trac:wiki/CookBook/Configuration/Reports for some exampleof creating reports for realms other than ''ticket''.167 See [trac:CookBook/Configuration/Reports] for examples of creating reports for realms other than ''ticket''. 173 168 174 169 === Custom formatting columns 175 170 176 Columns whose names begin and end with 2 underscores ( Example:'''`__color__`''') are171 Columns whose names begin and end with 2 underscores (e.g. '''`__color__`''') are 177 172 assumed to be ''formatting hints'', affecting the appearance of the row. 178 173 179 174 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table. 180 175 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group. 181 176 * '''`__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. 182 {{{ 183 #!html 184 <div style="margin-left:7.5em">Defaults: 177 {{{#!html 178 <div style="margin-left:3em">Defaults: 185 179 <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span> 186 180 <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span> … … 193 187 * '''`__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. 194 188 195 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''189 '''Example:''' List active tickets, grouped by milestone, group header linked to milestone page, colored by priority: 196 190 {{{#!sql 197 191 SELECT p.value AS __color__, … … 201 195 t.id AS ticket, summary 202 196 FROM ticket t,enum p 203 WHERE t.status IN ('new', 'assigned', 'reopened') 197 WHERE t.status IN ('new', 'assigned', 'reopened') 204 198 AND p.name = t.priority AND p.type = 'priority' 205 199 ORDER BY t.milestone, p.value, t.severity, t.time 206 200 }}} 207 201 208 '''Note:''' Atable join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.202 Note that table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table. 209 203 210 204 === Changing layout of report rows === #column-syntax … … 219 213 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. 220 214 221 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout''215 '''Example:''' List active tickets, grouped by milestone, colored by priority, with description and multi-line layout: 222 216 223 217 {{{#!sql 224 218 SELECT p.value AS __color__, 225 219 t.milestone AS __group__, 226 (CASE owner 227 WHEN 'daniel' THEN 'font-weight: bold; background: red;' 220 (CASE owner 221 WHEN 'daniel' THEN 'font-weight: bold; background: red;' 228 222 ELSE '' END) AS __style__, 229 223 t.id AS ticket, summary AS summary_, -- ## Break line here … … 233 227 changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output 234 228 FROM ticket t,enum p 235 WHERE t.status IN ('new', 'assigned', 'reopened') 229 WHERE t.status IN ('new', 'assigned', 'reopened') 236 230 AND p.name = t.priority AND p.type = 'priority' 237 231 ORDER BY t.milestone, p.value, t.severity, t.time … … 240 234 === Reporting on custom fields 241 235 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.243 244 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.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. 245 239 246 240 === A note about SQL rewriting #rewriting 247 241 248 242 Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports: 249 1. [#sort-order changing the sort order]250 1. pagination support (limitation of the number of result rows displayed on each page)243 1. [#sort-order sorting] 244 1. pagination: limiting the number of results displayed on each page 251 245 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 246 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 253 -- ## 4: Assigned, Active Tickets by Owner ## -- 260 254 261 -- 255 -- 262 256 -- List assigned tickets, group by ticket owner, sorted by priority. 263 -- 257 -- 264 258 265 259 SELECT p.value AS __color__, … … 307 301 }}} 308 302 303 == Changing Report Numbering 304 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 KEY 307 * author text 308 * title text 309 * query text 310 * description text 311 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 {{{#!sql 313 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 309 319 ---- 310 See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]320 See also: TracTickets, TracQuery, [https://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
