Changes between Version 2 and Version 3 of TracReports


Ignore:
Timestamp:
Jan 25, 2009 10:55:08 AM (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v2 v3  
    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 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.''''' 
    920 
    1021A 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  
     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. 
    1727 
    1828== Changing Sort Order == 
     
    2131If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order. 
    2232 
    23  
    24 == Alternate Download Formats == 
    25 Aside from the default HTML view, reports can also be exported in a number of alternate formats. 
     33== Changing Report Numbering == 
     34There 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): 
     35 * id integer PRIMARY KEY 
     36 * author text 
     37 * title text 
     38 * query text 
     39 * description text 
     40Changing 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: 
     41{{{ 
     42update report set id=5 where id=3; 
     43}}} 
     44Keep 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). 
     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. 
    2653At the bottom of the report page, you will find a list of available data formats. Click the desired link to  
    27 download the alternate report format. 
     54download the alternative report format. 
    2855 
    2956=== Comma-delimited - CSV (Comma Separated Values) === 
     
    3865 
    3966---- 
     67 
    4068== Creating Custom Reports == 
    4169 
     
    5280The ''ticket'' table has the following columns: 
    5381 * id 
     82 * type 
    5483 * time 
    5584 * changetime 
     
    6089 * reporter 
    6190 * cc 
    62  * url 
    6391 * version 
    6492 * milestone 
     
    6795 * summary 
    6896 * description 
     97 * keywords 
    6998 
    7099See TracTickets for a detailed description of the column fields. 
     
    93122Example: 
    94123{{{ 
    95 SELECT id AS ticket,summary FROM ticket WHERE priority='$PRIORITY' 
    96 }}} 
    97  
    98 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 '$'. 
     124SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 
     125}}} 
     126 
     127To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'. 
    99128 
    100129Example: 
    101130{{{ 
    102  http://projects.edgewall.com/trac/reports/14?PRIORITY=high 
     131 http://trac.edgewall.org/reports/14?PRIORITY=high 
    103132}}} 
    104133 
     
    107136Example: 
    108137{{{ 
    109  http://projects.edgewall.com/trac/reports/14?PRIORITY=high&SEVERITY=critical 
     138 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 
    110139}}} 
    111140 
     
    118147Example (''List all tickets assigned to me''): 
    119148{{{ 
    120 SELECT id AS ticket,summary FROM ticket WHERE owner='$USER' 
     149SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 
    121150}}} 
    122151 
     
    147176 
    148177=== Custom formatting columns === 
    149 Columns whose names begin and end with 2 underscores (Example: '''_''''''_color_''''''_''') are 
     178Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are 
    150179assumed to be ''formatting hints'', affecting the appearance of the row. 
    151180  
    152  * '''_''''''_group_''''''_''' -- Group results based on values in this column. Each group will have its own header and table. 
    153  * '''_''''''_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. 
    154  * '''_''''''_style_''''''_''' -- A custom CSS style expression to use for the current row.  
     181 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table. 
     182 * '''`__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. 
     183{{{ 
     184#!html 
     185<div style="margin-left:7.5em">Defaults:  
     186<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span> 
     187<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span> 
     188<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span> 
     189<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span> 
     190<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span> 
     191</div> 
     192}}} 
     193 * '''`__style__`''' -- A custom CSS style expression to use for the current row.  
    155194 
    156195'''Example:''' ''List active tickets, grouped by milestone, colored by priority'' 
     
    174213also possible to create multi-line report entries. 
    175214 
    176  * '''column_''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line. 
    177  
    178  * '''_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. 
    179  
    180  * '''_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). 
     215 * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line. 
     216 
     217 * '''`_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. 
     218 
     219 * '''`_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). 
    181220 
    182221'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout'' 
     
    201240=== Reporting on custom fields === 
    202241 
    203 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. 
     242If 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. 
    204243 
    205244If 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. 
    206245 
    207 ---- 
    208 See also: TracTickets, TracQuery, TracGuide 
     246'''Note that you need to set up permissions in order to see the buttons for adding or editing reports.''' 
     247 
     248---- 
     249See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]