Changes between Version 4 and Version 5 of TracReports


Ignore:
Timestamp:
Mar 27, 2008, 7:31:47 AM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v4 v5  
    1010  '''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.''
    1111
    12   ''You can already completely replace the reports module by the query module simply be disabling the former in [wiki:TracIni trac.ini]:''
     12  ''You can already completely replace the reports module by the query module simply by disabling the former in [wiki:TracIni trac.ini]:''
    1313  {{{
    1414  [components]
     
    1616  }}}
    1717  ''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.'''''
    1820
    1921A report consists of these basic parts:
     
    2931If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
    3032
    31 
    32 == Alternate Download Formats ==
    33 Aside from the default HTML view, reports can also be exported in a number of alternate formats.
     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.
    3440At the bottom of the report page, you will find a list of available data formats. Click the desired link to
    35 download the alternate report format.
     41download the alternative report format.
    3642
    3743=== Comma-delimited - CSV (Comma Separated Values) ===
     
    6167The ''ticket'' table has the following columns:
    6268 * id
     69 * type
    6370 * time
    6471 * changetime
     
    7582 * summary
    7683 * description
     84 * keywords
    7785
    7886See TracTickets for a detailed description of the column fields.
     
    101109Example:
    102110{{{
    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 '$'.
     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 '$'.
    107115
    108116Example:
    109117{{{
    110  http://projects.edgewall.com/trac/reports/14?PRIORITY=high
     118 http://trac.edgewall.org/reports/14?PRIORITY=high
    111119}}}
    112120
     
    115123Example:
    116124{{{
    117  http://projects.edgewall.com/trac/reports/14?PRIORITY=high&SEVERITY=critical
     125 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    118126}}}
    119127
     
    126134Example (''List all tickets assigned to me''):
    127135{{{
    128 SELECT id AS ticket,summary FROM ticket WHERE owner='$USER'
     136SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
    129137}}}
    130138
     
    155163
    156164=== Custom formatting columns ===
    157 Columns whose names begin and end with 2 underscores (Example: '''_''''''_color_''''''_''') are
     165Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
    158166assumed to be ''formatting hints'', affecting the appearance of the row.
    159167 
    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.
     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.
    163181
    164182'''Example:''' ''List active tickets, grouped by milestone, colored by priority''
     
    182200also possible to create multi-line report entries.
    183201
    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).
     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).
    189207
    190208'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     
    209227=== Reporting on custom fields ===
    210228
    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.
     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.
    212230
    213231If 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.
    214232
    215 ----
    216 See also: TracTickets, TracQuery, TracGuide
     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]