Changes between Version 2 and Version 3 of TracReports
- Timestamp:
- Sep 5, 2013, 11:00:02 AM (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracReports
v2 v3 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 '''''You will almost definitely need to restart your httpd at this point.'''''20 21 19 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.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. 27 25 28 26 == Changing Sort Order == … … 32 30 33 31 == 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):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)'': 35 33 * id integer PRIMARY KEY 36 34 * author text … … 44 42 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 43 44 You may also need to update or remove the report number stored in the report or query. 45 46 46 == Navigating Tickets == 47 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. 48 48 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)''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)'' 50 50 51 51 == Alternative Download Formats == … … 56 56 === Comma-delimited - CSV (Comma Separated Values) === 57 57 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.58 '''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output. 59 59 60 60 === Tab-delimited === … … 72 72 A report is basically a single named SQL query, executed and presented by 73 73 Trac. Reports can be viewed and created from a custom SQL expression directly 74 in fromthe web interface.74 in the web interface. 75 75 76 76 Typically, a report consists of a SELECT-expression from the 'ticket' table, … … 99 99 See TracTickets for a detailed description of the column fields. 100 100 101 '''all active tickets, sorted by priority and time''' 102 103 '''Example:''' ''All active tickets, sorted by priority and time'' 101 Example: '''All active tickets, sorted by priority and time''' 104 102 {{{ 105 103 SELECT id AS ticket, status, severity, priority, owner, 106 time ascreated, summary FROM ticket104 time AS created, summary FROM ticket 107 105 WHERE status IN ('new', 'assigned', 'reopened') 108 106 ORDER BY priority, time 109 107 }}} 110 108 111 112 ---- 113 109 --- 114 110 115 111 == Advanced Reports: Dynamic Variables == … … 140 136 141 137 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.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. 146 142 147 143 Example (''List all tickets assigned to me''): … … 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 for the current row. 196 197 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 196 198 {{{ 197 199 SELECT p.value AS __color__, 198 200 t.milestone AS __group__, 201 '../milestone/' || t.milestone AS __grouplink__, 199 202 (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 200 203 t.id AS ticket, summary … … 208 211 numeric representation from the ''enum'' table. 209 212 210 === Changing layout of report rows === 213 === Changing layout of report rows === #column-syntax 211 214 By default, all columns on each row are display on a single row in the HTML 212 215 report, possibly formatted according to the descriptions above. However, it's 213 216 also possible to create multi-line report entries. 214 217 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). 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). 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. 220 224 221 225 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout'' … … 242 246 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 247 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 TracIniReportCustomFieldSamplefor some examples.248 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 249 246 250 '''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''
