Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
Jun 19, 2006, 2:44:07 AM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v1 v2  
    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 be 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.''
    918
    1019A 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 
     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.
    1725
    1826== Changing Sort Order ==
     
    2937=== Comma-delimited - CSV (Comma Separated Values) ===
    3038Export 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.
     39'''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure.
    3240
    3341=== Tab-delimited ===
     
    3543
    3644=== 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.
    38 
    39 ----
     45All 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.
     46
     47----
     48
    4049== Creating Custom Reports ==
    4150
     
    6069 * reporter
    6170 * cc
    62  * url
    6371 * version
    6472 * milestone
     
    101109{{{
    102110 http://projects.edgewall.com/trac/reports/14?PRIORITY=high
     111}}}
     112
     113To use multiple variables, separate them with an '&'.
     114
     115Example:
     116{{{
     117 http://projects.edgewall.com/trac/reports/14?PRIORITY=high&SEVERITY=critical
    103118}}}
    104119
     
    192207}}}
    193208
     209=== Reporting on custom fields ===
     210
     211If 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
     213If 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.
    194214
    195215----