Changes between Version 5 and Version 6 of TracReports
- Timestamp:
- 01/24/11 13:44:21 (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracReports
v5 v6 1 2 1 = Trac Reports = 3 2 [[TracGuideToc]] … … 18 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.'' 19 18 19 20 20 A report consists of these basic parts: 21 21 * '''ID''' -- Unique (sequential) identifier … … 30 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. 31 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 (as of 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 47 == Navigating Tickets == 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. 49 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)'' 32 51 33 52 == Alternative Download Formats == … … 62 81 The ''ticket'' table has the following columns: 63 82 * id 83 * type 64 84 * time 65 85 * changetime … … 76 96 * summary 77 97 * description 98 * keywords 78 99 79 100 See TracTickets for a detailed description of the column fields. … … 84 105 {{{ 85 106 SELECT id AS ticket, status, severity, priority, owner, 86 time ascreated, summary FROM ticket107 time AS created, summary FROM ticket 87 108 WHERE status IN ('new', 'assigned', 'reopened') 88 109 ORDER BY priority, time … … 102 123 Example: 103 124 {{{ 104 SELECT id AS ticket,summary FROM ticket WHERE priority= '$PRIORITY'105 }}} 106 107 To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the theleading '$'.125 SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 126 }}} 127 128 To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'. 108 129 109 130 Example: 110 131 {{{ 111 http:// projects.edgewall.com/trac/reports/14?PRIORITY=high132 http://trac.edgewall.org/reports/14?PRIORITY=high 112 133 }}} 113 134 … … 116 137 Example: 117 138 {{{ 118 http:// projects.edgewall.com/trac/reports/14?PRIORITY=high&SEVERITY=critical139 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 119 140 }}} 120 141 … … 127 148 Example (''List all tickets assigned to me''): 128 149 {{{ 129 SELECT id AS ticket,summary FROM ticket WHERE owner= '$USER'150 SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 130 151 }}} 131 152 … … 146 167 === Automatically formatted columns === 147 168 * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket. 169 * '''id''' -- same as '''ticket''' above when '''realm''' is not set 170 * '''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) 148 171 * '''created, modified, date, time''' -- Format cell as a date and/or time. 149 150 172 * '''description''' -- Ticket description field, parsed through the wiki engine. 151 173 152 174 '''Example:''' 153 175 {{{ 154 SELECT id as ticket, created, status, summary FROM ticket 155 }}} 176 SELECT id AS ticket, created, status, summary FROM ticket 177 }}} 178 179 Those columns can also be defined but marked as hidden, see [#column-syntax below]. 156 180 157 181 === Custom formatting columns === … … 161 185 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table. 162 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. 187 {{{ 188 #!html 189 <div style="margin-left:7.5em">Defaults: 190 <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span> 191 <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span> 192 <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span> 193 <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span> 194 <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span> 195 </div> 196 }}} 163 197 * '''`__style__`''' -- A custom CSS style expression to use for the current row. 164 198 … … 178 212 numeric representation from the ''enum'' table. 179 213 180 === Changing layout of report rows === 214 === Changing layout of report rows === #column-syntax 181 215 By default, all columns on each row are display on a single row in the HTML 182 216 report, possibly formatted according to the descriptions above. However, it's … … 188 222 189 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. 190 225 191 226 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout'' … … 210 245 === Reporting on custom fields === 211 246 212 If you have added custom fields to your tickets (experimental feature in 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. 213 214 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. 215 216 ---- 217 See also: TracTickets, TracQuery, TracGuide 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. 248 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 '''Note that you need to set up permissions in order to see the buttons for adding or editing reports.''' 252 253 ---- 254 See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
