close Warning: Can't synchronize with repository "(default)" (/common/SVN/wimax does not appear to be a Subversion repository.). Look in the Trac log for more information.

Changes between Version 3 and Version 4 of TracReports


Ignore:
Timestamp:
Jan 30, 2019, 11:46:28 PM (18 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v3 v4  
    1 = Trac Reports
    2 
     1= Trac Reports =
    32[[TracGuideToc]]
    43
    5 The Trac reports module provides a simple, yet powerful reporting facility to present information about tickets in the Trac database.
    6 
    7 Rather than have its own report definition format, TracReports relies on standard SQL `SELECT` statements for custom report definition.
    8 
    9   '''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.
    10 
    11   You can already completely replace the reports module by the query module simply by disabling the former in [wiki:TracIni trac.ini]:
    12   {{{#!ini
     4The Trac reports module provides a simple, yet powerful reporting facility
     5to present information about tickets in the Trac database.
     6
     7Rather than have its own report definition format, TracReports relies on standard SQL
     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  {{{
    1314  [components]
    1415  trac.ticket.report.* = disabled
    1516  }}}
    16   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.
     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.''
    1718
    1819A report consists of these basic parts:
     
    2324 * '''Footer''' — Links to alternative download formats for this report.
    2425
    25 == Changing Sort Order
    26 
    27 Simple reports - ungrouped reports to be specific - can be sorted by clicking the column header.
    28 
    29 If a column header is a hyperlink (red), click the column to sort by it. Clicking the same header again reverses the sort order.
    30 
    31 == Navigating Tickets
    32 
    33 Clicking 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'' contextual navigation links, or click the ''Back to Report'' link to return to the report page.
    34 
    35 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, in contrast to the query results (see TracQuery#NavigatingTickets).
    36 
    37 == Alternate Download Formats
    38 
    39 In addition to the HTML view, reports can also be exported in a number of alternate formats.
     26== Changing Sort Order ==
     27Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header.
     28
     29If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
     30
     31== Changing Report Numbering ==
     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:
     33 * id integer PRIMARY KEY
     34 * author text
     35 * title text
     36 * query text
     37 * description text
     38Changing 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:
     39{{{
     40update report set id=5 where id=3;
     41}}}
     42Keep 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).
     43
     44You may also need to update or remove the report number stored in the report or query.
     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).
     50
     51== Alternative Download Formats ==
     52Aside from the default HTML view, reports can also be exported in a number of alternative formats.
    4053At the bottom of the report page, you will find a list of available data formats. Click the desired link to
    41 download the alternate format.
    42 
    43 === Comma-delimited - CSV (Comma Separated Values)
    44 
     54download the alternative report format.
     55
     56=== Comma-delimited - CSV (Comma Separated Values) ===
    4557Export the report as plain text, each row on its own line, columns separated by a single comma (',').
    4658'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
    4759
    48 === Tab-delimited
    49 
     60=== Tab-delimited ===
    5061Like above, but uses tabs (\t) instead of comma.
    5162
    52 === RSS - XML Content Syndication
    53 
     63=== RSS - XML Content Syndication ===
    5464All reports support syndication using XML/RSS 2.0. To subscribe to an RSS feed, click the orange 'XML' icon at the bottom of the page. See TracRss for general information on RSS support in Trac.
    5565
    56 == Creating Custom Reports
    57 
    58 Creating a custom report requires a comfortable knowledge of SQL.
    59 
    60 Note that you need grant [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.
    61 
    62 A report is basically a single named SQL query, executed and presented by Trac. Reports can be viewed and created from a custom SQL expression directly in the web interface.
    63 
    64 Typically, a report consists of a SELECT-expression from the 'ticket' table, using the available columns and sorting the way you want it.
    65 
    66 == Ticket columns
    67 
     66----
     67
     68== Creating Custom Reports ==
     69
     70''Creating a custom report requires a comfortable knowledge of SQL.''
     71
     72'''Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.'''
     73
     74A report is basically a single named SQL query, executed and presented by
     75Trac.  Reports can be viewed and created from a custom SQL expression directly
     76in the web interface.
     77
     78Typically, a report consists of a SELECT-expression from the 'ticket' table,
     79using the available columns and sorting the way you want it.
     80
     81== Ticket columns ==
    6882The ''ticket'' table has the following columns:
    6983 * id
     
    88102
    89103Example: '''All active tickets, sorted by priority and time'''
    90 {{{#!sql
    91 SELECT id AS ticket, status, severity, priority, owner, time AS created, summary
    92 FROM ticket
    93 WHERE status IN ('new', 'assigned', 'reopened')
    94 ORDER BY priority, time
    95 }}}
    96 
    97 == Advanced Reports: Dynamic Variables
    98 
     104{{{
     105SELECT id AS ticket, status, severity, priority, owner,
     106       time AS created, summary FROM ticket
     107  WHERE status IN ('new', 'assigned', 'reopened')
     108  ORDER BY priority, time
     109}}}
     110
     111Dynamic variables can also be used in the report title and description (since 1.1.1).
     112
     113== Advanced Reports: Dynamic Variables ==
    99114For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
    100 In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution. Dynamic variables can also be used in the report title and description //(since 1.1.1)//.
    101 
    102 === Using Variables in a Query
    103 
     115In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution.
     116
     117=== Using Variables in a Query ===
    104118The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
    105119
    106120Example:
    107 {{{#!sql
     121{{{
    108122SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
    109123}}}
    110124
    111 To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$':
     125To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'.
     126
     127Example:
    112128{{{
    113129 http://trac.edgewall.org/reports/14?PRIORITY=high
    114130}}}
    115131
    116 To use multiple variables, separate them with an '&':
     132To use multiple variables, separate them with an '&'.
     133
     134Example:
    117135{{{
    118136 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    119137}}}
    120138
    121 === !Special/Constant Variables
    122 
     139
     140=== !Special/Constant Variables ===
    123141There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
    124142
    125143 * $USER — Username of logged in user.
    126144
    127 Example: List all tickets assigned to me:
    128 {{{#!sql
     145Example (''List all tickets assigned to me''):
     146{{{
    129147SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
    130148}}}
    131149
    132 == Advanced Reports: Custom Formatting
    133 
    134 Trac is also capable of more advanced reports, including custom layouts, result grouping and user-defined CSS styles. To create such reports, we will use specialized SQL statements to control the output of the Trac report engine.
    135 
    136 === Special Columns
    137 
    138 To format reports, TracReports look for 'magic' column names in the query result. These 'magic' names are processed and affect the layout and style of the final report.
    139 
    140 === Automatically formatted columns
    141 
     150
     151
     152== Advanced Reports: Custom Formatting ==
     153Trac is also capable of more advanced reports, including custom layouts,
     154result grouping and user-defined CSS styles. To create such reports, we'll use
     155specialized SQL statements to control the output of the Trac report engine.
     156
     157=== Special Columns ===
     158To format reports, TracReports looks for 'magic' column names in the query
     159result. These 'magic' names are processed and affect the layout and style of the
     160final report.
     161
     162=== Automatically formatted columns ===
    142163 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
    143164 * '''id''' — same as '''ticket''' above when '''realm''' is not set
    144165 * '''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)
    145    - for some resources, it may be necessary to specify their ''parent'' resources (e.g. for ''changeset'', the ''repos'') and this can be achieved using the '''parent_realm''' and '''parent_id''' columns
     166   - for some kind of resources, it may be necessary to specify their ''parent'' resources (e.g. for ''changeset'', which ''repos'') and this can be achieved using the '''parent_realm''' and '''parent_id''' columns
    146167 * '''created, modified, date, time''' — Format cell as a date and/or time.
    147168 * '''description''' — Ticket description field, parsed through the wiki engine.
    148169
    149170'''Example:'''
    150 {{{#!sql
     171{{{
    151172SELECT id AS ticket, created, status, summary FROM ticket
    152173}}}
     
    154175Those columns can also be defined but marked as hidden, see [#column-syntax below].
    155176
    156 See [trac:CookBook/Configuration/Reports] for examples of creating reports for realms other than ''ticket''.
    157 
    158 === Custom formatting columns
    159 
    160 Columns whose names begin and end with 2 underscores (e.g. '''`__color__`''') are
     177See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
     178
     179=== Custom formatting columns ===
     180Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
    161181assumed to be ''formatting hints'', affecting the appearance of the row.
    162182 
     
    164184 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
    165185 * '''`__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.
    166  {{{#!html
    167 <div style="margin-left:3em">Defaults:
     186{{{
     187#!html
     188<div style="margin-left:7.5em">Defaults:
    168189<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
    169190<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
     
    176197 * '''`__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.
    177198
    178 '''Example:''' List active tickets, grouped by milestone, group header linked to milestone page, colored by priority:
    179 {{{#!sql
     199'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
     200{{{
    180201SELECT p.value AS __color__,
    181202     t.milestone AS __group__,
    182203     '../milestone/' || t.milestone AS __grouplink__,
    183204     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
    184      t.id AS ticket, summary
    185 FROM ticket t,enum p
    186 WHERE t.status IN ('new', 'assigned', 'reopened')
    187   AND p.name = t.priority AND p.type = 'priority'
    188 ORDER BY t.milestone, p.value, t.severity, t.time
    189 }}}
    190 
    191 Note that table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
     205       t.id AS ticket, summary
     206  FROM ticket t,enum p
     207  WHERE t.status IN ('new', 'assigned', 'reopened')
     208    AND p.name=t.priority AND p.type='priority'
     209  ORDER BY t.milestone, p.value, t.severity, t.time
     210}}}
     211
     212'''Note:''' A table join is used to match ''ticket'' priorities with their
     213numeric representation from the ''enum'' table.
    192214
    193215=== Changing layout of report rows === #column-syntax
    194 
    195 By default, all columns on each row are display on a single row in the HTML report, possibly formatted according to the descriptions above. However, it is also possible to create multi-line report entries.
     216By default, all columns on each row are display on a single row in the HTML
     217report, possibly formatted according to the descriptions above. However, it's
     218also possible to create multi-line report entries.
    196219
    197220 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line.
     
    202225   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.
    203226
    204 '''Example:''' List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout:
    205 
    206 {{{#!sql
     227'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     228
     229{{{
    207230SELECT p.value AS __color__,
    208231       t.milestone AS __group__,
     
    215238       description AS _description_,                    -- ## Uses a full row
    216239       changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
    217 FROM ticket t,enum p
    218 WHERE t.status IN ('new', 'assigned', 'reopened')
    219   AND p.name = t.priority AND p.type = 'priority'
    220 ORDER BY t.milestone, p.value, t.severity, t.time
    221 }}}
    222 
    223 === Reporting on custom fields
    224 
    225 If you have added [TracTicketsCustomFields custom fields] to your tickets, you can write a SQL query to include them in a report. You'll need to make a join on the `ticket_custom` table.
    226 
    227 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 [trac:TracIniReportCustomFieldSample TracIniReportCustomFieldSample] for some examples.
     240  FROM ticket t,enum p
     241  WHERE t.status IN ('new', 'assigned', 'reopened')
     242    AND p.name=t.priority AND p.type='priority'
     243  ORDER BY t.milestone, p.value, t.severity, t.time
     244}}}
     245
     246=== Reporting on custom fields ===
     247
     248If you have added custom fields to your tickets (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.
     249
     250If 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.
    228251
    229252=== A note about SQL rewriting #rewriting
    230253
    231254Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports:
    232  1. [#sort-order sorting]
    233  1. pagination: limiting the number of results displayed on each page
     255 1. [#sort-order changing the sort order]
     256 2. pagination support (limitation of the number of result rows displayed on each page)
    234257In 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.
    235258The 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:
     
    239262
    240263Let's take an example, consider the following SQL query:
    241 {{{#!sql
     264{{{
    242265-- ## 4: Assigned, Active Tickets by Owner ## --
    243266
     
    251274   changetime AS _changetime, description AS _description,
    252275   reporter AS _reporter
    253 FROM ticket t,enum p
    254 WHERE status = 'assigned'
    255   AND p.name = t.priority AND p.type = 'priority'
    256 ORDER BY __group__, p.value, severity, time
     276  FROM ticket t,enum p
     277  WHERE status = 'assigned'
     278AND p.name=t.priority AND p.type='priority'
     279  ORDER BY __group__, p.value, severity, time
    257280}}}
    258281
    259282The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`):
    260 {{{#!sql
     283{{{
    261284SELECT p.value AS __color__,
    262285   owner AS __group__,
     
    264287   changetime AS _changetime, description AS _description,
    265288   reporter AS _reporter
    266 FROM ticket t,enum p
    267 WHERE status = 'assigned'
    268   AND p.name = t.priority AND p.type = 'priority'
    269 ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time
    270 LIMIT 4 OFFSET 4
     289  FROM ticket t,enum p
     290  WHERE status = 'assigned'
     291AND p.name=t.priority AND p.type='priority'
     292  ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time
     293 LIMIT 4 OFFSET 4
    271294}}}
    272295
    273296The equivalent SQL query with the rewrite tokens would have been:
    274 {{{#!sql
     297{{{
    275298SELECT p.value AS __color__,
    276299   owner AS __group__,
     
    278301   changetime AS _changetime, description AS _description,
    279302   reporter AS _reporter
    280 FROM ticket t,enum p
    281 WHERE status = 'assigned'
    282   AND p.name = t.priority AND p.type = 'priority'
    283 ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time
     303  FROM ticket t,enum p
     304  WHERE status = 'assigned'
     305AND p.name=t.priority AND p.type='priority'
     306  ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time
    284307@LIMIT_OFFSET@
    285308}}}
    286309
    287310If you want to always sort first by priority and only then by the user selected sort column, simply use the following `ORDER BY` clause:
    288 {{{#!sql
    289 ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time
    290 }}}
    291 
    292 == Changing Report Numbering
    293 
    294 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:
    295  * id integer PRIMARY KEY
    296  * author text
    297  * title text
    298  * query text
    299  * description text
    300 Changing 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:
    301 {{{#!sql
    302 UPDATE report SET id = 5 WHERE id = 3;
    303 }}}
    304 Keep 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 for your database.
    305 
    306 You may also need to update or remove the report number stored in the report or query.
     311{{{
     312  ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time
     313}}}
    307314
    308315----
    309 See also: TracTickets, TracQuery, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
     316See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]