Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
Jul 23, 2018, 10:51:51 AM (15 months 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   '''''You will almost definitely need to restart your httpd at this point.'''''
    20 
    2119A report consists of these basic parts:
    22  * '''ID''' -- Unique (sequential) identifier
    23  * '''Title'''  -- Descriptive title
    24  * '''Description'''  -- A brief description of the report, in WikiFormatting text.
    25  * '''Report Body''' -- List of results from report query, formatted according to the methods described below.
    26  * '''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.
    2725
    2826== Changing Sort Order ==
     
    3230
    3331== Changing Report Numbering ==
    34 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:
    3533 * id integer PRIMARY KEY
    3634 * author text
     
    4442Keep 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).
    4543
     44You may also need to update or remove the report number stored in the report or query.
     45
    4646== Navigating Tickets ==
    4747Clicking 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.
    4848
    49 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).
    5050
    5151== Alternative Download Formats ==
     
    5656=== Comma-delimited - CSV (Comma Separated Values) ===
    5757Export the report as plain text, each row on its own line, columns separated by a single comma (',').
    58 '''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.
    5959
    6060=== Tab-delimited ===
     
    7070''Creating a custom report requires a comfortable knowledge of SQL.''
    7171
     72'''Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.'''
     73
    7274A report is basically a single named SQL query, executed and presented by
    7375Trac.  Reports can be viewed and created from a custom SQL expression directly
    74 in from the web interface.
     76in the web interface.
    7577
    7678Typically, a report consists of a SELECT-expression from the 'ticket' table,
     
    99101See TracTickets for a detailed description of the column fields.
    100102
    101 '''all active tickets, sorted by priority and time'''
    102 
    103 '''Example:''' ''All active tickets, sorted by priority and time''
     103Example: '''All active tickets, sorted by priority and time'''
    104104{{{
    105105SELECT id AS ticket, status, severity, priority, owner,
    106        time as created, summary FROM ticket
     106       time AS created, summary FROM ticket
    107107  WHERE status IN ('new', 'assigned', 'reopened')
    108108  ORDER BY priority, time
    109109}}}
    110110
    111 
    112 ----
    113 
     111Dynamic variables can also be used in the report title and description (since 1.1.1).
    114112
    115113== Advanced Reports: Dynamic Variables ==
     
    140138
    141139
    142 === Special/Constant Variables ===
    143 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.
    144 
    145  * $USER -- Username of logged in user.
     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.
    146144
    147145Example (''List all tickets assigned to me''):
     
    150148}}}
    151149
    152 
    153 ----
    154150
    155151
     
    159155specialized SQL statements to control the output of the Trac report engine.
    160156
    161 == Special Columns ==
     157=== Special Columns ===
    162158To format reports, TracReports looks for 'magic' column names in the query
    163159result. These 'magic' names are processed and affect the layout and style of the
     
    165161
    166162=== Automatically formatted columns ===
    167  * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.
    168  * '''created, modified, date, time''' -- Format cell as a date and/or time.
    169 
    170  * '''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   - 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
     167 * '''created, modified, date, time''' — Format cell as a date and/or time.
     168 * '''description''' — Ticket description field, parsed through the wiki engine.
    171169
    172170'''Example:'''
    173171{{{
    174 SELECT id as ticket, created, status, summary FROM ticket
    175 }}}
     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''.
    176178
    177179=== Custom formatting columns ===
     
    179181assumed to be ''formatting hints'', affecting the appearance of the row.
    180182 
    181  * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table.
    182  * '''`__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.
     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.
    183186{{{
    184187#!html
     
    191194</div>
    192195}}}
    193  * '''`__style__`''' -- A custom CSS style expression to use for the current row.
    194 
    195 '''Example:''' ''List active tickets, grouped by milestone, colored by priority''
     196 * '''`__style__`''' — A custom CSS style expression to use on the `<tr>` element of the current row.
     197 * '''`__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.
     198
     199'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
    196200{{{
    197201SELECT p.value AS __color__,
    198202     t.milestone AS __group__,
     203     '../milestone/' || t.milestone AS __grouplink__,
    199204     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
    200205       t.id AS ticket, summary
     
    208213numeric representation from the ''enum'' table.
    209214
    210 === Changing layout of report rows ===
     215=== Changing layout of report rows === #column-syntax
    211216By default, all columns on each row are display on a single row in the HTML
    212217report, possibly formatted according to the descriptions above. However, it's
    213218also possible to create multi-line report entries.
    214219
    215  * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line.
    216 
    217  * '''`_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.
    218 
    219  * '''`_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).
     220 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line.
     221
     222 * '''`_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.
     223
     224 * '''`_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).
     225   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.
    220226
    221227'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     
    240246=== Reporting on custom fields ===
    241247
    242 If 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.
    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 TracIniReportCustomFieldSample for some examples.
    245 
    246 '''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''
     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.
     251
     252=== A note about SQL rewriting #rewriting
     253
     254Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports:
     255 1. [#sort-order changing the sort order]
     256 2. pagination support (limitation of the number of result rows displayed on each page)
     257In 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.
     258The 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:
     259 - `@SORT_COLUMN@`, the place where the name of the selected sort column will be inserted,
     260 - `@LIMIT_OFFSET@`, the place where the pagination support clause will be added
     261Note that if you write them after an SQL comment, `--`, you'll effectively disable rewriting if this is what you want!
     262
     263Let's take an example, consider the following SQL query:
     264{{{
     265-- ## 4: Assigned, Active Tickets by Owner ## --
     266
     267--
     268-- List assigned tickets, group by ticket owner, sorted by priority.
     269--
     270
     271SELECT p.value AS __color__,
     272   owner AS __group__,
     273   id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created,
     274   changetime AS _changetime, description AS _description,
     275   reporter AS _reporter
     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
     280}}}
     281
     282The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`):
     283{{{
     284SELECT p.value AS __color__,
     285   owner AS __group__,
     286   id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created,
     287   changetime AS _changetime, description AS _description,
     288   reporter AS _reporter
     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
     294}}}
     295
     296The equivalent SQL query with the rewrite tokens would have been:
     297{{{
     298SELECT p.value AS __color__,
     299   owner AS __group__,
     300   id AS ticket, summary, component, milestone, t.type AS type, severity, time AS created,
     301   changetime AS _changetime, description AS _description,
     302   reporter AS _reporter
     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
     307@LIMIT_OFFSET@
     308}}}
     309
     310If you want to always sort first by priority and only then by the user selected sort column, simply use the following `ORDER BY` clause:
     311{{{
     312  ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time
     313}}}
    247314
    248315----