Changes between Initial Version and Version 1 of TracReports


Ignore:
Timestamp:
01/06/08 13:29:56 (12 years ago)
Author:
trac (IP: 127.0.0.1)
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
     19  '''''You will almost definitely need to restart your httpd at this point.'''''
     20
     21A report consists of these basic parts:
     22 * '''ID''' -- Unique (sequential) identifier
     23 * '''Title'''  -- Descriptive title
     24 * '''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.
     27
     28== Changing Sort Order ==
     29Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header.
     30
     31If 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
     33== Navigating Tickets ==
     34Clicking 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
     36You 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
     38== Alternative Download Formats ==
     39Aside from the default HTML view, reports can also be exported in a number of alternative formats.
     40At the bottom of the report page, you will find a list of available data formats. Click the desired link to
     41download the alternative report format.
     42
     43=== Comma-delimited - CSV (Comma Separated Values) ===
     44Export 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.
     46
     47=== Tab-delimited ===
     48Like above, but uses tabs (\t) instead of comma.
     49
     50=== RSS - XML Content Syndication ===
     51All 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.
     52
     53----
     54
     55== Creating Custom Reports ==
     56
     57''Creating a custom report requires a comfortable knowledge of SQL.''
     58
     59A report is basically a single named SQL query, executed and presented by
     60Trac.  Reports can be viewed and created from a custom SQL expression directly
     61in from the web interface.
     62
     63Typically, a report consists of a SELECT-expression from the 'ticket' table,
     64using the available columns and sorting the way you want it.
     65
     66== Ticket columns ==
     67The ''ticket'' table has the following columns:
     68 * id
     69 * type
     70 * time
     71 * changetime
     72 * component
     73 * severity 
     74 * priority
     75 * owner
     76 * reporter
     77 * cc
     78 * version
     79 * milestone
     80 * status
     81 * resolution
     82 * summary
     83 * description
     84 * keywords
     85
     86See TracTickets for a detailed description of the column fields.
     87
     88'''all active tickets, sorted by priority and time'''
     89
     90'''Example:''' ''All active tickets, sorted by priority and time''
     91{{{
     92SELECT id AS ticket, status, severity, priority, owner,
     93       time as created, summary FROM ticket
     94  WHERE status IN ('new', 'assigned', 'reopened')
     95  ORDER BY priority, time
     96}}}
     97
     98
     99----
     100
     101
     102== Advanced Reports: Dynamic Variables ==
     103For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
     104In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution.
     105
     106=== Using Variables in a Query ===
     107The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
     108
     109Example:
     110{{{
     111SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
     112}}}
     113
     114To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'.
     115
     116Example:
     117{{{
     118 http://trac.edgewall.org/reports/14?PRIORITY=high
     119}}}
     120
     121To use multiple variables, separate them with an '&'.
     122
     123Example:
     124{{{
     125 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
     126}}}
     127
     128
     129=== Special/Constant Variables ===
     130There 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.
     133
     134Example (''List all tickets assigned to me''):
     135{{{
     136SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
     137}}}
     138
     139
     140----
     141
     142
     143== Advanced Reports: Custom Formatting ==
     144Trac is also capable of more advanced reports, including custom layouts,
     145result grouping and user-defined CSS styles. To create such reports, we'll use
     146specialized SQL statements to control the output of the Trac report engine.
     147
     148== Special Columns ==
     149To format reports, TracReports looks for 'magic' column names in the query
     150result. These 'magic' names are processed and affect the layout and style of the
     151final report.
     152
     153=== 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.
     158
     159'''Example:'''
     160{{{
     161SELECT id as ticket, created, status, summary FROM ticket
     162}}}
     163
     164=== Custom formatting columns ===
     165Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
     166assumed to be ''formatting hints'', affecting the appearance of the row.
     167 
     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.
     170{{{
     171#!html
     172<div style="margin-left:7.5em">Defaults:
     173<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
     174<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
     175<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span>
     176<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span>
     177<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span>
     178</div>
     179}}}
     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''
     183{{{
     184SELECT p.value AS __color__,
     185     t.milestone AS __group__,
     186     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
     187       t.id AS ticket, summary
     188  FROM ticket t,enum p
     189  WHERE t.status IN ('new', 'assigned', 'reopened')
     190    AND p.name=t.priority AND p.type='priority'
     191  ORDER BY t.milestone, p.value, t.severity, t.time
     192}}}
     193
     194'''Note:''' A table join is used to match ''ticket'' priorities with their
     195numeric representation from the ''enum'' table.
     196
     197=== Changing layout of report rows ===
     198By default, all columns on each row are display on a single row in the HTML
     199report, possibly formatted according to the descriptions above. However, it's
     200also possible to create multi-line report entries.
     201
     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).
     207
     208'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     209
     210{{{
     211SELECT p.value AS __color__,
     212       t.milestone AS __group__,
     213       (CASE owner
     214          WHEN 'daniel' THEN 'font-weight: bold; background: red;'
     215          ELSE '' END) AS __style__,
     216       t.id AS ticket, summary AS summary_,             -- ## Break line here
     217       component,version, severity, milestone, status, owner,
     218       time AS created, changetime AS modified,         -- ## Dates are formatted
     219       description AS _description_,                    -- ## Uses a full row
     220       changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
     221  FROM ticket t,enum p
     222  WHERE t.status IN ('new', 'assigned', 'reopened')
     223    AND p.name=t.priority AND p.type='priority'
     224  ORDER BY t.milestone, p.value, t.severity, t.time
     225}}}
     226
     227=== Reporting on custom fields ===
     228
     229If 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
     231If 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.
     232
     233'''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''
     234
     235----
     236See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]