Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
Oct 11, 2013 12:04:33 AM (6 years 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.'''''
    2019
    2120A 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.
     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.
    2726
    2827== Changing Sort Order ==
     
    3130If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
    3231
     32== Changing Report Numbering ==
     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 ''(since 0.10)'':
     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{{{
     41update report set id=5 where id=3;
     42}}}
     43Keep 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).
     44
     45You may also need to update or remove the report number stored in the report or query.
     46
    3347== Navigating Tickets ==
    3448Clicking 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.
    3549
    36 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)''
     50You 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)''
    3751
    3852== Alternative Download Formats ==
     
    4357=== Comma-delimited - CSV (Comma Separated Values) ===
    4458Export the report as plain text, each row on its own line, columns separated by a single comma (',').
    45 '''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure.
     59'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
    4660
    4761=== Tab-delimited ===
     
    5973A report is basically a single named SQL query, executed and presented by
    6074Trac.  Reports can be viewed and created from a custom SQL expression directly
    61 in from the web interface.
     75in the web interface.
    6276
    6377Typically, a report consists of a SELECT-expression from the 'ticket' table,
     
    86100See TracTickets for a detailed description of the column fields.
    87101
    88 '''all active tickets, sorted by priority and time'''
    89 
    90 '''Example:''' ''All active tickets, sorted by priority and time''
     102Example: '''All active tickets, sorted by priority and time'''
    91103{{{
    92104SELECT id AS ticket, status, severity, priority, owner,
    93        time as created, summary FROM ticket
     105       time AS created, summary FROM ticket
    94106  WHERE status IN ('new', 'assigned', 'reopened')
    95107  ORDER BY priority, time
    96108}}}
    97109
    98 
    99 ----
    100 
     110---
    101111
    102112== Advanced Reports: Dynamic Variables ==
     
    127137
    128138
    129 === Special/Constant Variables ===
    130 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.
    131 
    132  * $USER -- Username of logged in user.
     139=== !Special/Constant Variables ===
     140There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
     141
     142 * $USER Username of logged in user.
    133143
    134144Example (''List all tickets assigned to me''):
     
    152162
    153163=== Automatically formatted columns ===
    154  * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.
    155  * '''created, modified, date, time''' -- Format cell as a date and/or time.
    156 
    157  * '''description''' -- Ticket description field, parsed through the wiki engine.
     164 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
     165 * '''id''' — same as '''ticket''' above when '''realm''' is not set
     166 * '''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)
     167 * '''created, modified, date, time''' — Format cell as a date and/or time.
     168 * '''description''' — Ticket description field, parsed through the wiki engine.
    158169
    159170'''Example:'''
    160171{{{
    161 SELECT id as ticket, created, status, summary FROM ticket
    162 }}}
     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''.
    163178
    164179=== Custom formatting columns ===
     
    166181assumed to be ''formatting hints'', affecting the appearance of the row.
    167182 
    168  * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table.
    169  * '''`__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.
    170186{{{
    171187#!html
     
    178194</div>
    179195}}}
    180  * '''`__style__`''' -- A custom CSS style expression to use for the current row.
    181 
    182 '''Example:''' ''List active tickets, grouped by milestone, colored by priority''
     196 * '''`__style__`''' A custom CSS style expression to use for the current row.
     197
     198'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
    183199{{{
    184200SELECT p.value AS __color__,
    185201     t.milestone AS __group__,
     202     '../milestone/' || t.milestone AS __grouplink__,
    186203     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
    187204       t.id AS ticket, summary
     
    195212numeric representation from the ''enum'' table.
    196213
    197 === Changing layout of report rows ===
     214=== Changing layout of report rows === #column-syntax
    198215By default, all columns on each row are display on a single row in the HTML
    199216report, possibly formatted according to the descriptions above. However, it's
    200217also possible to create multi-line report entries.
    201218
    202  * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line.
    203 
    204  * '''`_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.
    205 
    206  * '''`_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).
     224   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.
    207225
    208226'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     
    229247If 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.
    230248
    231 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.
     249If 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.
    232250
    233251'''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''