Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
11/06/17 14:13:34 (19 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v1 v2  
    1818 
    1919A report consists of these basic parts: 
    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. 
     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. 
    2525 
    2626== Changing Sort Order == 
     
    2929If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order. 
    3030 
     31== Changing Report Numbering == 
     32There 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)'': 
     33 * id integer PRIMARY KEY 
     34 * author text 
     35 * title text 
     36 * query text 
     37 * description text 
     38Changing 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: 
     39{{{ 
     40update report set id=5 where id=3; 
     41}}} 
     42Keep 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). 
     43 
     44You may also need to update or remove the report number stored in the report or query. 
     45 
     46== Navigating Tickets == 
     47Clicking 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 
     49You 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)'' 
    3150 
    3251== Alternative Download Formats == 
     
    3756=== Comma-delimited - CSV (Comma Separated Values) === 
    3857Export the report as plain text, each row on its own line, columns separated by a single comma (','). 
    39 '''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. 
    4059 
    4160=== Tab-delimited === 
     
    5372A report is basically a single named SQL query, executed and presented by 
    5473Trac.  Reports can be viewed and created from a custom SQL expression directly 
    55 in from the web interface. 
     74in the web interface. 
    5675 
    5776Typically, a report consists of a SELECT-expression from the 'ticket' table, 
     
    6180The ''ticket'' table has the following columns: 
    6281 * id 
     82 * type 
    6383 * time 
    6484 * changetime 
     
    7595 * summary 
    7696 * description 
     97 * keywords 
    7798 
    7899See TracTickets for a detailed description of the column fields. 
    79100 
    80 '''all active tickets, sorted by priority and time''' 
    81  
    82 '''Example:''' ''All active tickets, sorted by priority and time'' 
     101Example: '''All active tickets, sorted by priority and time''' 
    83102{{{ 
    84103SELECT id AS ticket, status, severity, priority, owner,  
    85        time as created, summary FROM ticket  
     104       time AS created, summary FROM ticket  
    86105  WHERE status IN ('new', 'assigned', 'reopened') 
    87106  ORDER BY priority, time 
    88107}}} 
    89108 
    90  
    91 ---- 
    92  
     109--- 
    93110 
    94111== Advanced Reports: Dynamic Variables == 
     
    101118Example: 
    102119{{{ 
    103 SELECT id AS ticket,summary FROM ticket WHERE priority='$PRIORITY' 
    104 }}} 
    105  
    106 To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the the leading '$'. 
     120SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 
     121}}} 
     122 
     123To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'. 
    107124 
    108125Example: 
    109126{{{ 
    110  http://projects.edgewall.com/trac/reports/14?PRIORITY=high 
     127 http://trac.edgewall.org/reports/14?PRIORITY=high 
    111128}}} 
    112129 
     
    115132Example: 
    116133{{{ 
    117  http://projects.edgewall.com/trac/reports/14?PRIORITY=high&SEVERITY=critical 
    118 }}} 
    119  
    120  
    121 === Special/Constant Variables === 
    122 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.  
    123  
    124  * $USER -- Username of logged in user. 
     134 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 
     135}}} 
     136 
     137 
     138=== !Special/Constant Variables === 
     139There 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. 
    125142 
    126143Example (''List all tickets assigned to me''): 
    127144{{{ 
    128 SELECT id AS ticket,summary FROM ticket WHERE owner='$USER' 
     145SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 
    129146}}} 
    130147 
     
    144161 
    145162=== Automatically formatted columns === 
    146  * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.  
    147  * '''created, modified, date, time''' -- Format cell as a date and/or time. 
    148  
    149  * '''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. 
    150168 
    151169'''Example:''' 
    152170{{{ 
    153 SELECT id as ticket, created, status, summary FROM ticket  
    154 }}} 
     171SELECT id AS ticket, created, status, summary FROM ticket  
     172}}} 
     173 
     174Those columns can also be defined but marked as hidden, see [#column-syntax below]. 
     175 
     176See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 
    155177 
    156178=== Custom formatting columns === 
     
    158180assumed to be ''formatting hints'', affecting the appearance of the row. 
    159181  
    160  * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table. 
    161  * '''`__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. 
    162  * '''`__style__`''' -- A custom CSS style expression to use for the current row.  
    163  
    164 '''Example:''' ''List active tickets, grouped by milestone, colored by 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. 
     185{{{ 
     186#!html 
     187<div style="margin-left:7.5em">Defaults:  
     188<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span> 
     189<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span> 
     190<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span> 
     191<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span> 
     192<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span> 
     193</div> 
     194}}} 
     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'' 
    165198{{{ 
    166199SELECT p.value AS __color__, 
    167200     t.milestone AS __group__, 
     201     '../milestone/' || t.milestone AS __grouplink__, 
    168202     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 
    169203       t.id AS ticket, summary 
     
    177211numeric representation from the ''enum'' table. 
    178212 
    179 === Changing layout of report rows === 
     213=== Changing layout of report rows === #column-syntax 
    180214By default, all columns on each row are display on a single row in the HTML 
    181215report, possibly formatted according to the descriptions above. However, it's 
    182216also possible to create multi-line report entries. 
    183217 
    184  * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line. 
    185  
    186  * '''`_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. 
    187  
    188  * '''`_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. 
    189224 
    190225'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout'' 
     
    209244=== Reporting on custom fields === 
    210245 
    211 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. 
    212  
    213 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. 
     246If 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. 
     247 
     248If 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. 
     249 
     250'''Note that you need to set up permissions in order to see the buttons for adding or editing reports.''' 
    214251 
    215252---- 
    216 See also: TracTickets, TracQuery, TracGuide 
     253See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]