Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
Jan 13, 2020, 11:20:56 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracReports

    v1 v2  
    2525== Changing Sort Order
    2626
    27 Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header.
    28 
    29 If 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 
    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:
    34  * id integer PRIMARY KEY
    35  * author text
    36  * title text
    37  * query text
    38  * description text
    39 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:
    40 {{{#!sql
    41 UPDATE report SET id = 5 WHERE id = 3;
    42 }}}
    43 Keep 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 
    45 You may also need to update or remove the report number stored in the report or query.
     27Simple reports - ungrouped reports to be specific - can be sorted by clicking the column header.
     28
     29If a column header is a hyperlink (red), click the column to sort by it. Clicking the same header again reverses the sort order.
    4630
    4731== Navigating Tickets
    4832
    49 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'' links just below the main menu bar, or click the ''Back to Report'' link to return to the report page.
    50 
    51 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).
    52 
    53 == Alternative Download Formats
    54 
    55 Aside from the default HTML view, reports can also be exported in a number of alternative formats.
     33Clicking 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
     35You 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
     39In addition to the HTML view, reports can also be exported in a number of alternate formats.
    5640At the bottom of the report page, you will find a list of available data formats. Click the desired link to
    57 download the alternative report format.
     41download the alternate format.
    5842
    5943=== Comma-delimited - CSV (Comma Separated Values)
    … …  
    7458Creating a custom report requires a comfortable knowledge of SQL.
    7559
    76 Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.
     60Note that you need grant [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.
    7761
    7862A 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.
    … …  
    11498
    11599For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
    116 In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution.
     100In 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)//.
    117101
    118102=== Using Variables in a Query
    … …  
    152136=== Special Columns
    153137
    154 To 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.
     138To 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.
    155139
    156140=== Automatically formatted columns
    … …  
    159143 * '''id''' — same as '''ticket''' above when '''realm''' is not set
    160144 * '''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)
    161    - 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
     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
    162146 * '''created, modified, date, time''' — Format cell as a date and/or time.
    163147 * '''description''' — Ticket description field, parsed through the wiki engine.
    … …  
    170154Those columns can also be defined but marked as hidden, see [#column-syntax below].
    171155
    172 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
     156See [trac:CookBook/Configuration/Reports] for examples of creating reports for realms other than ''ticket''.
    173157
    174158=== Custom formatting columns
    175159
    176 Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
     160Columns whose names begin and end with 2 underscores (e.g. '''`__color__`''') are
    177161assumed to be ''formatting hints'', affecting the appearance of the row.
    178162 
    … …  
    180164 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
    181165 * '''`__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 {{{
    183 #!html
    184 <div style="margin-left:7.5em">Defaults:
     166 {{{#!html
     167<div style="margin-left:3em">Defaults:
    185168<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
    186169<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
    … …  
    193176 * '''`__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.
    194177
    195 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
     178'''Example:''' List active tickets, grouped by milestone, group header linked to milestone page, colored by priority:
    196179{{{#!sql
    197180SELECT p.value AS __color__,
    … …  
    206189}}}
    207190
    208 '''Note:''' A table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
     191Note that table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
    209192
    210193=== Changing layout of report rows === #column-syntax
    … …  
    219202   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.
    220203
    221 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     204'''Example:''' List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout:
    222205
    223206{{{#!sql
    … …  
    240223=== Reporting on custom fields
    241224
    242 If 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.
    243 
    244 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.
     225If 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
     227If 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.
    245228
    246229=== A note about SQL rewriting #rewriting
    247230
    248231Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports:
    249  1. [#sort-order changing the sort order]
    250  1. pagination support (limitation of the number of result rows displayed on each page)
     232 1. [#sort-order sorting]
     233 1. pagination: limiting the number of results displayed on each page
    251234In 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.
    252235The 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:
    … …  
    307290}}}
    308291
     292== Changing Report Numbering
     293
     294There 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
     300Changing 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
     302UPDATE report SET id = 5 WHERE id = 3;
     303}}}
     304Keep 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
     306You may also need to update or remove the report number stored in the report or query.
     307
    309308----
    310 See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
     309See also: TracTickets, TracQuery, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]