![(please configure the [header_logo] section in trac.ini)](/projects/libs/chrome/site/your_project_logo.png){kind=logo}
Changes between Version 1 and Version 2 of TracReports
- Timestamp:
- 12/04/17 13:27:33 (7 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 * '''ID''' --Unique (sequential) identifier22 * '''Title''' --Descriptive title23 * '''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.20 * '''ID''' — Unique (sequential) identifier 21 * '''Title''' — Descriptive title 22 * '''Description''' — A brief description of the report, in WikiFormatting text. 23 * '''Report Body''' — List of results from report query, formatted according to the methods described below. 24 * '''Footer''' — Links to alternative download formats for this report. 26 25 27 26 == Changing Sort Order == … … 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 (as of 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 ''(since 0.10)'': 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 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)''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). ''(since 0.11)'' 51 50 52 51 == Alternative Download Formats == … … 57 56 === Comma-delimited - CSV (Comma Separated Values) === 58 57 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.58 '''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output. 60 59 61 60 === Tab-delimited === … … 73 72 A report is basically a single named SQL query, executed and presented by 74 73 Trac. Reports can be viewed and created from a custom SQL expression directly 75 in fromthe web interface.74 in the web interface. 76 75 77 76 Typically, a report consists of a SELECT-expression from the 'ticket' table, … … 100 99 See TracTickets for a detailed description of the column fields. 101 100 102 '''all active tickets, sorted by priority and time''' 103 104 '''Example:''' ''All active tickets, sorted by priority and time'' 101 Example: '''All active tickets, sorted by priority and time''' 105 102 {{{ 106 103 SELECT id AS ticket, status, severity, priority, owner, 107 time ascreated, summary FROM ticket104 time AS created, summary FROM ticket 108 105 WHERE status IN ('new', 'assigned', 'reopened') 109 106 ORDER BY priority, time 110 107 }}} 111 108 112 113 ---- 114 109 --- 115 110 116 111 == Advanced Reports: Dynamic Variables == … … 141 136 142 137 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.138 === !Special/Constant Variables === 139 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 140 141 * $USER — Username of logged in user. 147 142 148 143 Example (''List all tickets assigned to me''): … … 166 161 167 162 === Automatically formatted columns === 168 * '''ticket''' --Ticket ID number. Becomes a hyperlink to that ticket.169 * '''id''' --same as '''ticket''' above when '''realm''' is not set170 * '''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)171 * '''created, modified, date, time''' --Format cell as a date and/or time.172 * '''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. 173 168 174 169 '''Example:''' 175 170 {{{ 176 SELECT id asticket, created, status, summary FROM ticket171 SELECT id AS ticket, created, status, summary FROM ticket 177 172 }}} 178 173 179 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''. 180 177 181 178 === Custom formatting columns === … … 183 180 assumed to be ''formatting hints'', affecting the appearance of the row. 184 181 185 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table. 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. 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. 187 185 {{{ 188 186 #!html … … 195 193 </div> 196 194 }}} 197 * '''`__style__`''' --A custom CSS style expression to use for the current row.198 199 '''Example:''' ''List active tickets, grouped by milestone, colored by priority''195 * '''`__style__`''' — A custom CSS style expression to use for the current row. 196 197 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 200 198 {{{ 201 199 SELECT p.value AS __color__, 202 200 t.milestone AS __group__, 201 '../milestone/' || t.milestone AS __grouplink__, 203 202 (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 204 203 t.id AS ticket, summary … … 217 216 also possible to create multi-line report entries. 218 217 219 * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will bebe 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).218 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line. 219 220 * '''`_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. 221 222 * '''`_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 223 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. 225 224
