Changes between Version 6 and Version 7 of TracReports


Ignore:
Timestamp:
2013-05-22T09:31:17+02:00 (18 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v6 v7  
    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  
    2019A report consists of these basic parts: 
    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. 
     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. 
    2625 
    2726== Changing Sort Order == 
     
    3130 
    3231== Changing Report Numbering == 
    33 There 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): 
     32There 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)'': 
    3433 * id integer PRIMARY KEY 
    3534 * author text 
     
    4847Clicking 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. 
    4948 
    50 You 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)'' 
     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)'' 
    5150 
    5251== Alternative Download Formats == 
     
    5756=== Comma-delimited - CSV (Comma Separated Values) === 
    5857Export the report as plain text, each row on its own line, columns separated by a single comma (','). 
    59 '''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure. 
     58'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output. 
    6059 
    6160=== Tab-delimited === 
     
    7170''Creating a custom report requires a comfortable knowledge of SQL.'' 
    7271 
     72'''Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.''' 
     73 
    7374A report is basically a single named SQL query, executed and presented by 
    7475Trac.  Reports can be viewed and created from a custom SQL expression directly 
    75 in from the web interface. 
     76in the web interface. 
    7677 
    7778Typically, a report consists of a SELECT-expression from the 'ticket' table, 
     
    100101See TracTickets for a detailed description of the column fields. 
    101102 
    102 '''all active tickets, sorted by priority and time''' 
    103  
    104 '''Example:''' ''All active tickets, sorted by priority and time'' 
     103Example: '''All active tickets, sorted by priority and time''' 
    105104{{{ 
    106105SELECT id AS ticket, status, severity, priority, owner,  
    107        time as created, summary FROM ticket  
     106       time AS created, summary FROM ticket  
    108107  WHERE status IN ('new', 'assigned', 'reopened') 
    109108  ORDER BY priority, time 
    110109}}} 
    111  
    112  
    113 ---- 
    114110 
    115111 
     
    140136}}} 
    141137 
    142  
    143 === Special/Constant Variables === 
    144 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.  
    145  
    146  * $USER -- Username of logged in user. 
     138Dynamic variables can also be used in the report title and description (since 1.1.1). 
     139 
     140=== !Special/Constant Variables === 
     141There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.  
     142 
     143 * $USER — Username of logged in user. 
    147144 
    148145Example (''List all tickets assigned to me''): 
     
    151148}}} 
    152149 
    153  
    154 ---- 
    155150 
    156151 
     
    160155specialized SQL statements to control the output of the Trac report engine. 
    161156 
    162 == Special Columns == 
     157=== Special Columns === 
    163158To format reports, TracReports looks for 'magic' column names in the query 
    164159result. These 'magic' names are processed and affect the layout and style of the  
     
    166161 
    167162=== Automatically formatted columns === 
    168  * '''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) 
    171  * '''created, modified, date, time''' -- Format cell as a date and/or time. 
    172  * '''description''' -- Ticket description field, parsed through the wiki engine. 
     163 * '''ticket''' Ticket ID number. Becomes a hyperlink to that ticket.  
     164 * '''id''' same as '''ticket''' above when '''realm''' is not set 
     165 * '''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) 
     166 * '''created, modified, date, time''' Format cell as a date and/or time. 
     167 * '''description''' Ticket description field, parsed through the wiki engine. 
    173168 
    174169'''Example:''' 
    175170{{{ 
    176 SELECT id as ticket, created, status, summary FROM ticket  
     171SELECT id AS ticket, created, status, summary FROM ticket  
    177172}}} 
    178173 
    179174Those columns can also be defined but marked as hidden, see [#column-syntax below]. 
     175 
     176See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 
    180177 
    181178=== Custom formatting columns === 
     
    183180assumed to be ''formatting hints'', affecting the appearance of the row. 
    184181  
    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. 
     182 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table. 
     183 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group. 
     184 * '''`__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. 
    187185{{{ 
    188186#!html 
     
    195193</div> 
    196194}}} 
    197  * '''`__style__`''' -- A custom CSS style expression to use for the current row.  
    198  
    199 '''Example:''' ''List active tickets, grouped by milestone, colored by priority'' 
     195 * '''`__style__`''' — A custom CSS style expression to use on the `<tr>` element of the current row. 
     196 * '''`__class__`''' — Zero or more space-separated CSS class names to be set on the `<tr>` element of the current row. These classes are added to the class name derived from `__color__` and the odd / even indicator. 
     197 
     198'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 
    200199{{{ 
    201200SELECT p.value AS __color__, 
    202201     t.milestone AS __group__, 
     202     '../milestone/' || t.milestone AS __grouplink__, 
    203203     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 
    204204       t.id AS ticket, summary 
     
    217217also possible to create multi-line report entries. 
    218218 
    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). 
     219 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will 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). 
    224224   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. 
    225225 
     
    249249If 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. 
    250250 
    251 '''Note that you need to set up permissions in order to see the buttons for adding or editing reports.''' 
     251=== A note about SQL rewriting #rewriting 
     252 
     253Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports: 
     254 1. [#sort-order changing the sort order] 
     255 2. pagination support (limitation of the number of result rows displayed on each page) 
     256In order to support the first feature, the sort column is inserted in the `ORDER BY` clause in the first position or in the second position if a `__group__` column is specified (an `ORDER BY` clause is created if needed). In order to support pagination, a `LIMIT ... OFFSET ...` clause is appended. 
     257The query might be too complex for the automatic rewrite to work correctly, resulting in an erroneous query. In this case you still have the possibility to control exactly how the rewrite is done by manually inserting the following tokens: 
     258 - `@SORT_COLUMN@`, the place where the name of the selected sort column will be inserted, 
     259 - `@LIMIT_OFFSET@`, the place where the pagination support clause will be added 
     260Note that if you write them after an SQL comment, `--`, you'll effectively disable rewriting if this is what you want! 
     261 
     262Let's take an example, consider the following SQL query: 
     263{{{ 
     264-- ## 4: Assigned, Active Tickets by Owner ## -- 
     265 
     266--  
     267-- List assigned tickets, group by ticket owner, sorted by priority. 
     268--  
     269 
     270SELECT p.value AS __color__, 
     271   owner AS __group__, 
     272   id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 
     273   changetime AS _changetime, description AS _description, 
     274   reporter AS _reporter 
     275  FROM ticket t,enum p 
     276  WHERE status = 'assigned' 
     277AND p.name=t.priority AND p.type='priority' 
     278  ORDER BY __group__, p.value, severity, time 
     279}}} 
     280 
     281The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`): 
     282{{{ 
     283SELECT p.value AS __color__, 
     284   owner AS __group__, 
     285   id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 
     286   changetime AS _changetime, description AS _description, 
     287   reporter AS _reporter 
     288  FROM ticket t,enum p 
     289  WHERE status = 'assigned' 
     290AND p.name=t.priority AND p.type='priority' 
     291  ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time 
     292 LIMIT 4 OFFSET 4 
     293}}} 
     294 
     295The equivalent SQL query with the rewrite tokens would have been: 
     296{{{ 
     297SELECT p.value AS __color__, 
     298   owner AS __group__, 
     299   id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created, 
     300   changetime AS _changetime, description AS _description, 
     301   reporter AS _reporter 
     302  FROM ticket t,enum p 
     303  WHERE status = 'assigned' 
     304AND p.name=t.priority AND p.type='priority' 
     305  ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time 
     306@LIMIT_OFFSET@ 
     307}}} 
     308 
     309If you want to always sort first by priority and only then by the user selected sort column, simply use the following `ORDER BY` clause: 
     310{{{ 
     311  ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time 
     312}}} 
    252313 
    253314----