Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
Jan 12, 2010 9:24:17 PM (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v1 v2  
    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
    1819
    1920A report consists of these basic parts:
     
    2930If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
    3031
    31 
    32 == Alternate Download Formats ==
    33 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 (as of 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.
    3454At 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.
     55download the alternative report format.
    3656
    3757=== Comma-delimited - CSV (Comma Separated Values) ===
     
    6181The ''ticket'' table has the following columns:
    6282 * id
     83 * type
    6384 * time
    6485 * changetime
     
    7596 * summary
    7697 * description
     98 * keywords
    7799
    78100See TracTickets for a detailed description of the column fields.
     
    101123Example:
    102124{{{
    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 '$'.
     125SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
     126}}}
     127
     128To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'.
    107129
    108130Example:
    109131{{{
    110  http://projects.edgewall.com/trac/reports/14?PRIORITY=high
     132 http://trac.edgewall.org/reports/14?PRIORITY=high
    111133}}}
    112134
     
    115137Example:
    116138{{{
    117  http://projects.edgewall.com/trac/reports/14?PRIORITY=high&SEVERITY=critical
     139 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    118140}}}
    119141
     
    126148Example (''List all tickets assigned to me''):
    127149{{{
    128 SELECT id AS ticket,summary FROM ticket WHERE owner='$USER'
     150SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
    129151}}}
    130152
     
    145167=== Automatically formatted columns ===
    146168 * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.
     169 * '''id''' -- same as '''ticket''' above when '''realm''' is not set
     170 * '''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)
    147171 * '''created, modified, date, time''' -- Format cell as a date and/or time.
    148 
    149172 * '''description''' -- Ticket description field, parsed through the wiki engine.
    150173
     
    154177}}}
    155178
     179Those columns can also be defined but marked as hidden, see [#column-syntax below].
     180
    156181=== Custom formatting columns ===
    157 Columns whose names begin and end with 2 underscores (Example: '''_''''''_color_''''''_''') are
     182Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
    158183assumed to be ''formatting hints'', affecting the appearance of the row.
    159184 
    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.
     185 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table.
     186 * '''`__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.
     187{{{
     188#!html
     189<div style="margin-left:7.5em">Defaults:
     190<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
     191<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
     192<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span>
     193<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span>
     194<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span>
     195</div>
     196}}}
     197 * '''`__style__`''' -- A custom CSS style expression to use for the current row.
    163198
    164199'''Example:''' ''List active tickets, grouped by milestone, colored by priority''
     
    177212numeric representation from the ''enum'' table.
    178213
    179 === Changing layout of report rows ===
     214=== Changing layout of report rows === #column-syntax
    180215By default, all columns on each row are display on a single row in the HTML
    181216report, possibly formatted according to the descriptions above. However, it's
    182217also possible to create multi-line report entries.
    183218
    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).
     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.
    189225
    190226'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     
    209245=== Reporting on custom fields ===
    210246
    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.
    212 
    213 If 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.
    214 
    215 ----
    216 See also: TracTickets, TracQuery, TracGuide
     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.'''
     252
     253----
     254See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]