Code

Changes between Version 3 and Version 4 of TracReports


Ignore:
Timestamp:
01/28/11 12:52:13 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v3 v4  
    66 
    77Rather than have its own report definition format, TracReports relies on standard SQL 
    8 SELECT statements for custom report definition.  
     8`SELECT` statements for custom report definition.  
     9 
     10  '''Note:''' ''The report module is being phased out in its current form because it seriously limits the ability of the Trac team to make adjustments to the underlying database schema. We believe that the [wiki:TracQuery query module] is a good replacement that provides more flexibility and better usability. While there are certain reports that cannot yet be handled by the query module, we intend to further enhance it so that at some point the reports module can be completely removed. This also means that there will be no major enhancements to the report module anymore.'' 
     11 
     12  ''You can already completely replace the reports module by the query module simply by disabling the former in [wiki:TracIni trac.ini]:'' 
     13  {{{ 
     14  [components] 
     15  trac.ticket.report.* = disabled 
     16  }}} 
     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 
    919 
    1020A report consists of these basic parts: 
    11  * ID -- Unique (sequential) identifier  
    12  * Title  -- Descriptive title 
    13  * Description  -- A brief description of the report, in WikiFormatting text. 
    14  * Report Body -- List of results from report query, formatted according to the methods described below. 
    15  * Footer -- Links to alternative download formats for this report. 
    16  
     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. 
    1726 
    1827== Changing Sort Order == 
     
    2130If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order. 
    2231 
    23  
    24 == Alternate Download Formats == 
    25 Aside from the default HTML view, reports can also be exported in a number of alternate formats. 
     32== Changing Report Numbering == 
     33There 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 
     39Changing 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{{{ 
     41update report set id=5 where id=3; 
     42}}} 
     43Keep 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 
     45You may also need to update or remove the report number stored in the report or query. 
     46 
     47== Navigating Tickets == 
     48Clicking 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 
     50You 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 
     52== Alternative Download Formats == 
     53Aside from the default HTML view, reports can also be exported in a number of alternative formats. 
    2654At the bottom of the report page, you will find a list of available data formats. Click the desired link to  
    27 download the alternate report format. 
     55download the alternative report format. 
    2856 
    2957=== Comma-delimited - CSV (Comma Separated Values) === 
    3058Export the report as plain text, each row on its own line, columns separated by a single comma (','). 
    31 '''Note:''' Column data is stripped from carriage returns, line feeds and commas to preserve structure. 
     59'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output. 
    3260 
    3361=== Tab-delimited === 
     
    3563 
    3664=== RSS - XML Content Syndication === 
    37 All reports support syndication using XML/RSS 2.0. To subscribe to a , click the the orange 'XML' icon at the bottom of the page. See TracRss for general information on RSS support in Trac. 
     65All reports support syndication using XML/RSS 2.0. To subscribe to an RSS feed, click the orange 'XML' icon at the bottom of the page. See TracRss for general information on RSS support in Trac. 
    3866 
    3967---- 
     68 
    4069== Creating Custom Reports == 
    4170 
     
    4473A report is basically a single named SQL query, executed and presented by 
    4574Trac.  Reports can be viewed and created from a custom SQL expression directly 
    46 in from the web interface. 
     75in the web interface. 
    4776 
    4877Typically, a report consists of a SELECT-expression from the 'ticket' table, 
     
    5281The ''ticket'' table has the following columns: 
    5382 * id 
     83 * type 
    5484 * time 
    5585 * changetime 
     
    6090 * reporter 
    6191 * cc 
    62  * url 
    6392 * version 
    6493 * milestone 
     
    6796 * summary 
    6897 * description 
     98 * keywords 
    6999 
    70100See TracTickets for a detailed description of the column fields. 
    71101 
    72 '''all active tickets, sorted by priority and time''' 
    73  
    74 '''Example:''' ''All active tickets, sorted by priority and time'' 
     102Example: '''All active tickets, sorted by priority and time''' 
    75103{{{ 
    76104SELECT id AS ticket, status, severity, priority, owner,  
    77        time as created, summary FROM ticket  
     105       time AS created, summary FROM ticket  
    78106  WHERE status IN ('new', 'assigned', 'reopened') 
    79107  ORDER BY priority, time 
    80108}}} 
    81109 
    82  
    83 ---- 
    84  
     110--- 
    85111 
    86112== Advanced Reports: Dynamic Variables == 
     
    93119Example: 
    94120{{{ 
    95 SELECT id AS ticket,summary FROM ticket WHERE priority='$PRIORITY' 
    96 }}} 
    97  
    98 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 '$'. 
     121SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 
     122}}} 
     123 
     124To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'. 
    99125 
    100126Example: 
    101127{{{ 
    102  http://projects.edgewall.com/trac/reports/14?PRIORITY=high 
    103 }}} 
    104  
    105  
    106 === Special/Constant Variables === 
    107 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.  
    108  
    109  * $USER -- Username of logged in user. 
     128 http://trac.edgewall.org/reports/14?PRIORITY=high 
     129}}} 
     130 
     131To use multiple variables, separate them with an '&'. 
     132 
     133Example: 
     134{{{ 
     135 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 
     136}}} 
     137 
     138 
     139=== !Special/Constant Variables === 
     140There 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. 
    110143 
    111144Example (''List all tickets assigned to me''): 
    112145{{{ 
    113 SELECT id AS ticket,summary FROM ticket WHERE owner='$USER' 
     146SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 
    114147}}} 
    115148 
     
    129162 
    130163=== Automatically formatted columns === 
    131  * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.  
    132  * '''created, modified, date, time''' -- Format cell as a date and/or time. 
    133  
    134  * '''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. 
    135169 
    136170'''Example:''' 
    137171{{{ 
    138 SELECT id as ticket, created, status, summary FROM ticket  
    139 }}} 
     172SELECT id AS ticket, created, status, summary FROM ticket  
     173}}} 
     174 
     175Those columns can also be defined but marked as hidden, see [#column-syntax below]. 
     176 
     177See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 
    140178 
    141179=== Custom formatting columns === 
    142 Columns whose names begin and end with 2 underscores (Example: '''_''''''_color_''''''_''') are 
     180Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are 
    143181assumed to be ''formatting hints'', affecting the appearance of the row. 
    144182  
    145  * '''_''''''_group_''''''_''' -- Group results based on values in this column. Each group will have its own header and table. 
    146  * '''_''''''_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. 
    147  * '''_''''''_style_''''''_''' -- A custom CSS style expression to use for the current row.  
    148  
    149 '''Example:''' ''List active tickets, grouped by milestone, colored by 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. 
     186{{{ 
     187#!html 
     188<div style="margin-left:7.5em">Defaults:  
     189<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span> 
     190<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span> 
     191<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span> 
     192<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span> 
     193<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span> 
     194</div> 
     195}}} 
     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'' 
    150199{{{ 
    151200SELECT p.value AS __color__, 
    152201     t.milestone AS __group__, 
     202     '../milestone/' || t.milestone AS __grouplink__, 
    153203     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 
    154204       t.id AS ticket, summary 
     
    162212numeric representation from the ''enum'' table. 
    163213 
    164 === Changing layout of report rows === 
     214=== Changing layout of report rows === #column-syntax 
    165215By default, all columns on each row are display on a single row in the HTML 
    166216report, possibly formatted according to the descriptions above. However, it's 
    167217also possible to create multi-line report entries. 
    168218 
    169  * '''column_''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line. 
    170  
    171  * '''_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. 
    172  
    173  * '''_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 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. 
    174225 
    175226'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout'' 
     
    192243}}} 
    193244 
     245=== Reporting on custom fields === 
     246 
     247If 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 
     249If 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.''' 
    194252 
    195253---- 
    196 See also: TracTickets, TracQuery, TracGuide 
     254See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]