Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
08/23/10 11:39:44 (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v1 v2  
    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.'' 
    1818 
     19 
    1920A report consists of these basic parts: 
    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. 
     21 * '''ID''' Unique (sequential) identifier  
     22 * '''Title''' Descriptive title 
     23 * '''Description''' A brief description of the report, in WikiFormatting text. 
     24 * '''Report Body''' List of results from report query, formatted according to the methods described below. 
     25 * '''Footer''' Links to alternative download formats for this report. 
    2526 
    2627== Changing Sort Order == 
     
    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 
     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 ''(since 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)'' 
    3151 
    3252== Alternative Download Formats == 
     
    3757=== Comma-delimited - CSV (Comma Separated Values) === 
    3858Export the report as plain text, each row on its own line, columns separated by a single comma (','). 
    39 '''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure. 
     59'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output. 
    4060 
    4161=== Tab-delimited === 
     
    5373A report is basically a single named SQL query, executed and presented by 
    5474Trac.  Reports can be viewed and created from a custom SQL expression directly 
    55 in from the web interface. 
     75in the web interface. 
    5676 
    5777Typically, a report consists of a SELECT-expression from the 'ticket' table, 
     
    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. 
    79101 
    80 '''all active tickets, sorted by priority and time''' 
    81  
    82 '''Example:''' ''All active tickets, sorted by priority and time'' 
     102Example: '''All active tickets, sorted by priority and time''' 
    83103{{{ 
    84104SELECT id AS ticket, status, severity, priority, owner,  
    85        time as created, summary FROM ticket  
     105       time AS created, summary FROM ticket  
    86106  WHERE status IN ('new', 'assigned', 'reopened') 
    87107  ORDER BY priority, time 
    88108}}} 
    89109 
    90  
    91 ---- 
    92  
     110--- 
    93111 
    94112== Advanced Reports: Dynamic Variables == 
     
    101119Example: 
    102120{{{ 
    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 '$'. 
     121SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 
     122}}} 
     123 
     124To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'. 
    107125 
    108126Example: 
    109127{{{ 
    110  http://projects.edgewall.com/trac/reports/14?PRIORITY=high 
     128 http://trac.edgewall.org/reports/14?PRIORITY=high 
    111129}}} 
    112130 
     
    115133Example: 
    116134{{{ 
    117  http://projects.edgewall.com/trac/reports/14?PRIORITY=high&SEVERITY=critical 
    118 }}} 
    119  
    120  
    121 === Special/Constant Variables === 
    122 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.  
    123  
    124  * $USER -- Username of logged in user. 
     135 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 
     136}}} 
     137 
     138 
     139=== !Special/Constant Variables === 
     140There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.  
     141 
     142 * $USER Username of logged in user. 
    125143 
    126144Example (''List all tickets assigned to me''): 
    127145{{{ 
    128 SELECT id AS ticket,summary FROM ticket WHERE owner='$USER' 
     146SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 
    129147}}} 
    130148 
     
    144162 
    145163=== Automatically formatted columns === 
    146  * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.  
    147  * '''created, modified, date, time''' -- Format cell as a date and/or time. 
    148  
    149  * '''description''' -- Ticket description field, parsed through the wiki engine. 
     164 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.  
     165 * '''id''' — same as '''ticket''' above when '''realm''' is not set 
     166 * '''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) 
     167 * '''created, modified, date, time''' — Format cell as a date and/or time. 
     168 * '''description''' — Ticket description field, parsed through the wiki engine. 
    150169 
    151170'''Example:''' 
    152171{{{ 
    153 SELECT id as ticket, created, status, summary FROM ticket  
    154 }}} 
     172SELECT id AS ticket, created, status, summary FROM ticket  
     173}}} 
     174 
     175Those columns can also be defined but marked as hidden, see [#column-syntax below]. 
     176 
     177See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 
    155178 
    156179=== Custom formatting columns === 
     
    158181assumed to be ''formatting hints'', affecting the appearance of the row. 
    159182  
    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.  
    163  
    164 '''Example:''' ''List active tickets, grouped by milestone, colored by priority'' 
     183 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table. 
     184 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group. 
     185 * '''`__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. 
     186{{{ 
     187#!html 
     188<div style="margin-left:7.5em">Defaults:  
     189<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span> 
     190<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span> 
     191<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span> 
     192<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span> 
     193<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span> 
     194</div> 
     195}}} 
     196 * '''`__style__`''' — A custom CSS style expression to use for the current row.  
     197 
     198'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 
    165199{{{ 
    166200SELECT p.value AS __color__, 
    167201     t.milestone AS __group__, 
     202     '../milestone/' || t.milestone AS __grouplink__, 
    168203     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 
    169204       t.id AS ticket, summary 
     
    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. 
     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.''' 
    214252 
    215253---- 
    216 See also: TracTickets, TracQuery, TracGuide 
     254See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]