Changes between Version 4 and Version 5 of TracReports
- Timestamp:
- Apr 6, 2012, 4:33:19 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracReports
v4 v5 18 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.'' 19 19 20 '''''You will almost definitely need to restart your httpd at this point.'''''21 20 22 21 A report consists of these basic parts: 23 * '''ID''' --Unique (sequential) identifier24 * '''Title''' --Descriptive title25 * '''Description''' --A brief description of the report, in WikiFormatting text.26 * '''Report Body''' --List of results from report query, formatted according to the methods described below.27 * '''Footer''' --Links to alternative download formats for this report.22 * '''ID''' — Unique (sequential) identifier 23 * '''Title''' — Descriptive title 24 * '''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. 28 27 29 28 == Changing Sort Order == … … 33 32 34 33 == Changing Report Numbering == 35 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):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 ''(since 0.10)'': 36 35 * id integer PRIMARY KEY 37 36 * author text … … 45 44 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). 46 45 46 You may also need to update or remove the report number stored in the report or query. 47 47 48 == Navigating Tickets == 48 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. 49 50 50 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)''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). ''(since 0.11)'' 51 52 52 53 == Alternative Download Formats == … … 57 58 === Comma-delimited - CSV (Comma Separated Values) === 58 59 Export the report as plain text, each row on its own line, columns separated by a single comma (','). 59 '''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure.60 '''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output. 60 61 61 62 === Tab-delimited === … … 73 74 A report is basically a single named SQL query, executed and presented by 74 75 Trac. Reports can be viewed and created from a custom SQL expression directly 75 in fromthe web interface.76 in the web interface. 76 77 77 78 Typically, a report consists of a SELECT-expression from the 'ticket' table, … … 100 101 See TracTickets for a detailed description of the column fields. 101 102 102 '''all active tickets, sorted by priority and time''' 103 104 '''Example:''' ''All active tickets, sorted by priority and time'' 103 Example: '''All active tickets, sorted by priority and time''' 105 104 {{{ 106 105 SELECT id AS ticket, status, severity, priority, owner, 107 time ascreated, summary FROM ticket106 time AS created, summary FROM ticket 108 107 WHERE status IN ('new', 'assigned', 'reopened') 109 108 ORDER BY priority, time 110 109 }}} 111 110 112 113 ---- 114 111 --- 115 112 116 113 == Advanced Reports: Dynamic Variables == … … 141 138 142 139 143 === Special/Constant Variables ===144 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.145 146 * $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. 147 144 148 145 Example (''List all tickets assigned to me''): … … 166 163 167 164 === Automatically formatted columns === 168 * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket. 169 * '''created, modified, date, time''' -- Format cell as a date and/or time. 170 171 * '''description''' -- Ticket description field, parsed through the wiki engine. 165 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 166 * '''id''' — same as '''ticket''' above when '''realm''' is not set 167 * '''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) 168 * '''created, modified, date, time''' — Format cell as a date and/or time. 169 * '''description''' — Ticket description field, parsed through the wiki engine. 172 170 173 171 '''Example:''' 174 172 {{{ 175 SELECT id as ticket, created, status, summary FROM ticket 176 }}} 173 SELECT id AS ticket, created, status, summary FROM ticket 174 }}} 175 176 Those columns can also be defined but marked as hidden, see [#column-syntax below]. 177 178 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 177 179 178 180 === Custom formatting columns === … … 180 182 assumed to be ''formatting hints'', affecting the appearance of the row. 181 183 182 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table. 183 * '''`__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. 184 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table. 185 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group. 186 * '''`__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. 184 187 {{{ 185 188 #!html … … 192 195 </div> 193 196 }}} 194 * '''`__style__`''' --A custom CSS style expression to use for the current row.195 196 '''Example:''' ''List active tickets, grouped by milestone, colored by priority''197 * '''`__style__`''' — A custom CSS style expression to use for the current row. 198 199 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 197 200 {{{ 198 201 SELECT p.value AS __color__, 199 202 t.milestone AS __group__, 203 '../milestone/' || t.milestone AS __grouplink__, 200 204 (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 201 205 t.id AS ticket, summary … … 209 213 numeric representation from the ''enum'' table. 210 214 211 === Changing layout of report rows === 215 === Changing layout of report rows === #column-syntax 212 216 By default, all columns on each row are display on a single row in the HTML 213 217 report, possibly formatted according to the descriptions above. However, it's 214 218 also possible to create multi-line report entries. 215 219 216 * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line. 217 218 * '''`_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. 219 220 * '''`_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). 220 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line. 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. 223 224 * '''`_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). 225 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. 221 226 222 227 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout'' … … 249 254 ---- 250 255 See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite] 256
