Changes between Version 1 and Version 2 of TracReports
- Timestamp:
- Oct 20, 2012 6:38:57 PM (12 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 '''''You will almost definitely need to restart your httpd at this point.'''''20 19 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 == … … 31 30 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. 32 31 32 == 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 ''(since 0.10)'': 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 {{{ 41 update report set id=5 where id=3; 42 }}} 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). 44 45 You may also need to update or remove the report number stored in the report or query. 46 33 47 == Navigating Tickets == 34 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. 35 49 36 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)'' 37 51 38 52 == Alternative Download Formats == … … 43 57 === Comma-delimited - CSV (Comma Separated Values) === 44 58 Export the report as plain text, each row on its own line, columns separated by a single comma (','). 45 '''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. 46 60 47 61 === Tab-delimited === … … 59 73 A report is basically a single named SQL query, executed and presented by 60 74 Trac. Reports can be viewed and created from a custom SQL expression directly 61 in fromthe web interface.75 in the web interface. 62 76 63 77 Typically, a report consists of a SELECT-expression from the 'ticket' table, … … 86 100 See TracTickets for a detailed description of the column fields. 87 101 88 '''all active tickets, sorted by priority and time''' 89 90 '''Example:''' ''All active tickets, sorted by priority and time'' 102 Example: '''All active tickets, sorted by priority and time''' 91 103 {{{ 92 104 SELECT id AS ticket, status, severity, priority, owner, 93 time ascreated, summary FROM ticket105 time AS created, summary FROM ticket 94 106 WHERE status IN ('new', 'assigned', 'reopened') 95 107 ORDER BY priority, time 96 108 }}} 97 109 98 99 ---- 100 110 --- 101 111 102 112 == Advanced Reports: Dynamic Variables == … … 127 137 128 138 129 === Special/Constant Variables ===130 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.131 132 * $USER --Username of logged in user.139 === !Special/Constant Variables === 140 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 141 142 * $USER — Username of logged in user. 133 143 134 144 Example (''List all tickets assigned to me''): … … 152 162 153 163 === Automatically formatted columns === 154 * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket. 155 * '''created, modified, date, time''' -- Format cell as a date and/or time. 156 157 * '''description''' -- Ticket description field, parsed through the wiki engine. 164 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 165 * '''id''' — same as '''ticket''' above when '''realm''' is not set 166 * '''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) 167 * '''created, modified, date, time''' — Format cell as a date and/or time. 168 * '''description''' — Ticket description field, parsed through the wiki engine. 158 169 159 170 '''Example:''' 160 171 {{{ 161 SELECT id as ticket, created, status, summary FROM ticket 162 }}} 172 SELECT id AS ticket, created, status, summary FROM ticket 173 }}} 174 175 Those columns can also be defined but marked as hidden, see [#column-syntax below]. 176 177 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 163 178 164 179 === Custom formatting columns === … … 166 181 assumed to be ''formatting hints'', affecting the appearance of the row. 167 182 168 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table. 169 * '''`__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 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table. 184 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group. 185 * '''`__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. 170 186 {{{ 171 187 #!html … … 178 194 </div> 179 195 }}} 180 * '''`__style__`''' --A custom CSS style expression to use for the current row.181 182 '''Example:''' ''List active tickets, grouped by milestone, colored by priority''196 * '''`__style__`''' — A custom CSS style expression to use for the current row. 197 198 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 183 199 {{{ 184 200 SELECT p.value AS __color__, 185 201 t.milestone AS __group__, 202 '../milestone/' || t.milestone AS __grouplink__, 186 203 (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 187 204 t.id AS ticket, summary … … 195 212 numeric representation from the ''enum'' table. 196 213 197 === Changing layout of report rows === 214 === Changing layout of report rows === #column-syntax 198 215 By default, all columns on each row are display on a single row in the HTML 199 216 report, possibly formatted according to the descriptions above. However, it's 200 217 also possible to create multi-line report entries. 201 218 202 * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line. 203 204 * '''`_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. 205 206 * '''`_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. 207 225 208 226 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout'' … … 229 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. 230 248 231 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.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. 232 250 233 251 '''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''
