Changes between Version 2 and Version 3 of TracReports
- Timestamp:
- Sep 9, 2012, 11:47:55 PM (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracReports
v2 v3 1 ** Note: this page documents the version 1.0 of Trac, see [[0.12/TracReports]] if you need the previous version ** 1 2 = Trac Reports = 2 3 [[TracGuideToc]] … … 17 18 ''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 19 19 '''''You will almost definitely need to restart your httpd at this point.'''''20 21 20 A report consists of these basic parts: 22 * '''ID''' --Unique (sequential) identifier23 * '''Title''' --Descriptive title24 * '''Description''' --A brief description of the report, in WikiFormatting text.25 * '''Report Body''' --List of results from report query, formatted according to the methods described below.26 * '''Footer''' --Links to alternative download formats for this report.21 * '''ID''' — Unique (sequential) identifier 22 * '''Title''' — Descriptive title 23 * '''Description''' — A brief description of the report, in WikiFormatting text. 24 * '''Report Body''' — List of results from report query, formatted according to the methods described below. 25 * '''Footer''' — Links to alternative download formats for this report. 27 26 28 27 == Changing Sort Order == … … 32 31 33 32 == Changing Report Numbering == 34 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 (as of 0.10):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)'': 35 34 * id integer PRIMARY KEY 36 35 * author text … … 44 43 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). 45 44 45 You may also need to update or remove the report number stored in the report or query. 46 46 47 == Navigating Tickets == 47 48 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 49 49 You can safely edit any of the tickets and continue to navigate through the results using the Next/Previous/Back to Reportlinks 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)''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)'' 50 51 51 52 == Alternative Download Formats == … … 56 57 === Comma-delimited - CSV (Comma Separated Values) === 57 58 Export the report as plain text, each row on its own line, columns separated by a single comma (','). 58 '''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure.59 '''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output. 59 60 60 61 === Tab-delimited === … … 70 71 ''Creating a custom report requires a comfortable knowledge of SQL.'' 71 72 73 '''Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.''' 74 72 75 A report is basically a single named SQL query, executed and presented by 73 76 Trac. Reports can be viewed and created from a custom SQL expression directly 74 in fromthe web interface.77 in the web interface. 75 78 76 79 Typically, a report consists of a SELECT-expression from the 'ticket' table, … … 99 102 See TracTickets for a detailed description of the column fields. 100 103 101 '''all active tickets, sorted by priority and time''' 102 103 '''Example:''' ''All active tickets, sorted by priority and time'' 104 Example: '''All active tickets, sorted by priority and time''' 104 105 {{{ 105 106 SELECT id AS ticket, status, severity, priority, owner, 106 time ascreated, summary FROM ticket107 time AS created, summary FROM ticket 107 108 WHERE status IN ('new', 'assigned', 'reopened') 108 109 ORDER BY priority, time 109 110 }}} 110 111 112 ----113 111 114 112 … … 140 138 141 139 142 === Special/Constant Variables ===143 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.144 145 * $USER --Username of logged in user.140 === !Special/Constant Variables === 141 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 142 143 * $USER — Username of logged in user. 146 144 147 145 Example (''List all tickets assigned to me''): … … 150 148 }}} 151 149 152 153 ----154 150 155 151 … … 159 155 specialized SQL statements to control the output of the Trac report engine. 160 156 161 == Special Columns==157 === Special Columns === 162 158 To format reports, TracReports looks for 'magic' column names in the query 163 159 result. These 'magic' names are processed and affect the layout and style of the … … 165 161 166 162 === Automatically formatted columns === 167 * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket. 168 * '''created, modified, date, time''' -- Format cell as a date and/or time. 169 170 * '''description''' -- Ticket description field, parsed through the wiki engine. 163 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 164 * '''id''' — same as '''ticket''' above when '''realm''' is not set 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 * '''created, modified, date, time''' — Format cell as a date and/or time. 167 * '''description''' — Ticket description field, parsed through the wiki engine. 171 168 172 169 '''Example:''' 173 170 {{{ 174 SELECT id as ticket, created, status, summary FROM ticket 175 }}} 171 SELECT id AS ticket, created, status, summary FROM ticket 172 }}} 173 174 Those columns can also be defined but marked as hidden, see [#column-syntax below]. 175 176 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 176 177 177 178 === Custom formatting columns === … … 179 180 assumed to be ''formatting hints'', affecting the appearance of the row. 180 181 181 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table. 182 * '''`__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 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table. 183 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group. 184 * '''`__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. 183 185 {{{ 184 186 #!html … … 191 193 </div> 192 194 }}} 193 * '''`__style__`''' -- A custom CSS style expression to use for the current row. 194 195 '''Example:''' ''List active tickets, grouped by milestone, colored by priority'' 195 * '''`__style__`''' — A custom CSS style expression to use on the `<tr>` element of the current row. 196 * '''`__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 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 196 199 {{{ 197 200 SELECT p.value AS __color__, 198 201 t.milestone AS __group__, 202 '../milestone/' || t.milestone AS __grouplink__, 199 203 (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 200 204 t.id AS ticket, summary … … 208 212 numeric representation from the ''enum'' table. 209 213 210 === Changing layout of report rows === 214 === Changing layout of report rows === #column-syntax 211 215 By default, all columns on each row are display on a single row in the HTML 212 216 report, possibly formatted according to the descriptions above. However, it's 213 217 also possible to create multi-line report entries. 214 218 215 * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line. 216 217 * '''`_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. 218 219 * '''`_column`''' -- ''Hide data''. Prepending an underscore ('_') to a column name instructs Trac to hide the contents from the HTML output. This is useful for information to be visible only if downloaded in other formats (like CSV or RSS/XML). 219 * '''`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 * '''`_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. 222 223 * '''`_column`''' — ''Hide data''. Prepending an underscore ('_') to a column name instructs Trac to hide the contents from the HTML output. This is useful for information to be visible only if downloaded in other formats (like CSV or RSS/XML). 224 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 225 221 226 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout'' … … 242 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. 243 248 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 TracIniReportCustomFieldSample for some examples. 245 246 '''Note that you need to set up permissions in order to see the buttons for adding or editing reports.''' 249 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 === A note about SQL rewriting #rewriting 252 253 Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports: 254 1. [#sort-order changing the sort order] 255 2. pagination support (limitation of the number of result rows displayed on each page) 256 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 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: 258 - `@SORT_COLUMN@`, the place where the name of the selected sort column will be inserted, 259 - `@LIMIT_OFFSET@`, the place where the pagination support clause will be added 260 Note that if you write them after an SQL comment, `--`, you'll effectively disable rewriting if this is what you want! 261 262 Let's take an example, consider the following SQL query: 263 {{{ 264 -- ## 4: Assigned, Active Tickets by Owner ## -- 265 266 -- 267 -- List assigned tickets, group by ticket owner, sorted by priority. 268 -- 269 270 SELECT p.value AS __color__, 271 owner AS __group__, 272 id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 273 changetime AS _changetime, description AS _description, 274 reporter AS _reporter 275 FROM ticket t,enum p 276 WHERE status = 'assigned' 277 AND p.name=t.priority AND p.type='priority' 278 ORDER BY __group__, p.value, severity, time 279 }}} 280 281 The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`): 282 {{{ 283 SELECT p.value AS __color__, 284 owner AS __group__, 285 id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 286 changetime AS _changetime, description AS _description, 287 reporter AS _reporter 288 FROM ticket t,enum p 289 WHERE status = 'assigned' 290 AND p.name=t.priority AND p.type='priority' 291 ORDER BY __group__ ASC, `component` ASC, __group__, p.value, severity, time 292 LIMIT 4 OFFSET 4 293 }}} 294 295 The equivalent SQL query with the rewrite tokens would have been: 296 {{{ 297 SELECT p.value AS __color__, 298 owner AS __group__, 299 id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 300 changetime AS _changetime, description AS _description, 301 reporter AS _reporter 302 FROM ticket t,enum p 303 WHERE status = 'assigned' 304 AND p.name=t.priority AND p.type='priority' 305 ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time 306 @LIMIT_OFFSET@ 307 }}} 308 309 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 ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time 312 }}} 247 313 248 314 ----
