Changes between Initial Version and Version 1 of TracReports


Ignore:
Timestamp:
10/22/12 17:38:43 (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v1 v1  
     1= Trac Reports =
     2[[TracGuideToc]]
     3
     4The Trac reports module provides a simple, yet powerful reporting facility
     5to present information about tickets in the Trac database.
     6
     7Rather than have its own report definition format, TracReports relies on standard SQL
     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
     19A 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.
     25
     26== Changing Sort Order ==
     27Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header.
     28
     29If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
     30
     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)''
     50
     51== Alternative Download Formats ==
     52Aside from the default HTML view, reports can also be exported in a number of alternative formats.
     53At the bottom of the report page, you will find a list of available data formats. Click the desired link to
     54download the alternative report format.
     55
     56=== Comma-delimited - CSV (Comma Separated Values) ===
     57Export the report as plain text, each row on its own line, columns separated by a single comma (',').
     58'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
     59
     60=== Tab-delimited ===
     61Like above, but uses tabs (\t) instead of comma.
     62
     63=== RSS - XML Content Syndication ===
     64All 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.
     65
     66----
     67
     68== Creating Custom Reports ==
     69
     70''Creating a custom report requires a comfortable knowledge of SQL.''
     71
     72A report is basically a single named SQL query, executed and presented by
     73Trac.  Reports can be viewed and created from a custom SQL expression directly
     74in the web interface.
     75
     76Typically, a report consists of a SELECT-expression from the 'ticket' table,
     77using the available columns and sorting the way you want it.
     78
     79== Ticket columns ==
     80The ''ticket'' table has the following columns:
     81 * id
     82 * type
     83 * time
     84 * changetime
     85 * component
     86 * severity 
     87 * priority
     88 * owner
     89 * reporter
     90 * cc
     91 * version
     92 * milestone
     93 * status
     94 * resolution
     95 * summary
     96 * description
     97 * keywords
     98
     99See TracTickets for a detailed description of the column fields.
     100
     101Example: '''All active tickets, sorted by priority and time'''
     102{{{
     103SELECT id AS ticket, status, severity, priority, owner,
     104       time AS created, summary FROM ticket
     105  WHERE status IN ('new', 'assigned', 'reopened')
     106  ORDER BY priority, time
     107}}}
     108
     109---
     110
     111== Advanced Reports: Dynamic Variables ==
     112For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
     113In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution.
     114
     115=== Using Variables in a Query ===
     116The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
     117
     118Example:
     119{{{
     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 '$'.
     124
     125Example:
     126{{{
     127 http://trac.edgewall.org/reports/14?PRIORITY=high
     128}}}
     129
     130To use multiple variables, separate them with an '&'.
     131
     132Example:
     133{{{
     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.
     142
     143Example (''List all tickets assigned to me''):
     144{{{
     145SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
     146}}}
     147
     148
     149----
     150
     151
     152== Advanced Reports: Custom Formatting ==
     153Trac is also capable of more advanced reports, including custom layouts,
     154result grouping and user-defined CSS styles. To create such reports, we'll use
     155specialized SQL statements to control the output of the Trac report engine.
     156
     157== Special Columns ==
     158To format reports, TracReports looks for 'magic' column names in the query
     159result. These 'magic' names are processed and affect the layout and style of the
     160final report.
     161
     162=== Automatically formatted columns ===
     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.
     168
     169'''Example:'''
     170{{{
     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''.
     177
     178=== Custom formatting columns ===
     179Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
     180assumed to be ''formatting hints'', affecting the appearance of the row.
     181 
     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''
     198{{{
     199SELECT p.value AS __color__,
     200     t.milestone AS __group__,
     201     '../milestone/' || t.milestone AS __grouplink__,
     202     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
     203       t.id AS ticket, summary
     204  FROM ticket t,enum p
     205  WHERE t.status IN ('new', 'assigned', 'reopened')
     206    AND p.name=t.priority AND p.type='priority'
     207  ORDER BY t.milestone, p.value, t.severity, t.time
     208}}}
     209
     210'''Note:''' A table join is used to match ''ticket'' priorities with their
     211numeric representation from the ''enum'' table.
     212
     213=== Changing layout of report rows === #column-syntax
     214By default, all columns on each row are display on a single row in the HTML
     215report, possibly formatted according to the descriptions above. However, it's
     216also possible to create multi-line report entries.
     217
     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.
     224
     225'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     226
     227{{{
     228SELECT p.value AS __color__,
     229       t.milestone AS __group__,
     230       (CASE owner
     231          WHEN 'daniel' THEN 'font-weight: bold; background: red;'
     232          ELSE '' END) AS __style__,
     233       t.id AS ticket, summary AS summary_,             -- ## Break line here
     234       component,version, severity, milestone, status, owner,
     235       time AS created, changetime AS modified,         -- ## Dates are formatted
     236       description AS _description_,                    -- ## Uses a full row
     237       changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
     238  FROM ticket t,enum p
     239  WHERE t.status IN ('new', 'assigned', 'reopened')
     240    AND p.name=t.priority AND p.type='priority'
     241  ORDER BY t.milestone, p.value, t.severity, t.time
     242}}}
     243
     244=== Reporting on custom fields ===
     245
     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.'''
     251
     252----
     253See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]