Changes between Version 3 and Version 4 of TracReports


Ignore:
Timestamp:
09/03/19 22:57:48 (7 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v3 v4  
    2525== Changing Sort Order
    2626
    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.
     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
     32
     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:
     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{{{#!sql
     41UPDATE report SET id = 5 WHERE id = 3;
     42}}}
     43Keep in mind that the integrity has to be maintained, ie 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.
    3046
    3147== Navigating Tickets
    3248
    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.
     49Clicking 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.
     50
     51You 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).
     52
     53== Alternative Download Formats
     54
     55Aside from the default HTML view, reports can also be exported in a number of alternative formats.
    4056At 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.
     57download the alternative report format.
    4258
    4359=== Comma-delimited - CSV (Comma Separated Values)
     
    5874Creating a custom report requires a comfortable knowledge of SQL.
    5975
    60 Note that you need grant [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.
     76Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.
    6177
    6278A 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.
     
    95111}}}
    96112
     113Dynamic variables can also be used in the report title and description (since 1.1.1).
     114
    97115== Advanced Reports: Dynamic Variables
    98116
    99117For 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)//.
     118In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution. Dynamic variables are entered through the preferences form and the values are autocompleted //(Since 1.3.2)//.
    101119
    102120=== Using Variables in a Query
    103121
    104 The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
     122The syntax for dynamic variables is simple, any upper case word beginning with `$` is considered a variable.
    105123
    106124Example:
     
    109127}}}
    110128
    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 '$':
     129The value of the dynamic variable can be assigned in the report preferences form.
     130
     131To assign a value to `$PRIORITY` in the URL for a report, leave out the leading `$`:
    112132{{{
    113133 http://trac.edgewall.org/reports/14?PRIORITY=high
    114134}}}
    115135
    116 To use multiple variables, separate them with an '&':
     136To use multiple variables, separate them with an `&`:
    117137{{{
    118138 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    119139}}}
    120140
     141It is possible to assign a default value to the variable, within a SQL comment:
     142
     143{{{#!sql
     144-- PRIORITY = high
     145
     146SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
     147}}}
     148
     149
    121150=== !Special/Constant Variables
    122151
     
    136165=== Special Columns
    137166
    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.
     167To format reports, TracReports looks for 'magic' column names in the query result. These 'magic' names are processed and affect the layout and style of the final report.
    139168
    140169=== Automatically formatted columns
     
    143172 * '''id''' — same as '''ticket''' above when '''realm''' is not set
    144173 * '''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
     174   - 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
    146175 * '''created, modified, date, time''' — Format cell as a date and/or time.
    147176 * '''description''' — Ticket description field, parsed through the wiki engine.
     
    154183Those columns can also be defined but marked as hidden, see [#column-syntax below].
    155184
    156 See [trac:CookBook/Configuration/Reports] for examples of creating reports for realms other than ''ticket''.
     185See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
    157186
    158187=== Custom formatting columns
    159188
    160 Columns whose names begin and end with 2 underscores (e.g. '''`__color__`''') are
     189Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
    161190assumed to be ''formatting hints'', affecting the appearance of the row.
    162191 
     
    164193 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
    165194 * '''`__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:
     195{{{
     196#!html
     197<div style="margin-left:7.5em">Defaults:
    168198<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
    169199<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
     
    176206 * '''`__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.
    177207
    178 '''Example:''' List active tickets, grouped by milestone, group header linked to milestone page, colored by priority:
     208'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
    179209{{{#!sql
    180210SELECT p.value AS __color__,
     
    189219}}}
    190220
    191 Note that table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
     221'''Note:''' A table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
    192222
    193223=== Changing layout of report rows === #column-syntax
     
    202232   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.
    203233
    204 '''Example:''' List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout:
     234'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
    205235
    206236{{{#!sql
     
    223253=== Reporting on custom fields
    224254
    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.
     255If 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.
     256
     257If 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.
    228258
    229259=== A note about SQL rewriting #rewriting
    230260
    231261Beyond 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
     262 1. [#sort-order changing the sort order]
     263 1. pagination support (limitation of the number of result rows displayed on each page)
    234264In 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.
    235265The 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:
     
    290320}}}
    291321
    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.
    307 
    308322----
    309 See also: TracTickets, TracQuery, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
     323See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]