Changes between Version 4 and Version 5 of TracReports


Ignore:
Timestamp:
Apr 13, 2010, 3:53:03 AM (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v4 v5  
    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.'''''
    1920
    2021A report consists of these basic parts:
     
    3132
    3233== Changing Report Numbering ==
    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 ''(since 0.10)'':
     34There 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):
    3435 * id integer PRIMARY KEY
    3536 * author text
     
    4344Keep 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).
    4445
    45 You may also need to update or remove the report number stored in the report or query.
    46 
    4746== Navigating Tickets ==
    4847Clicking 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.
    4948
    50 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). ''(since 0.11)''
    5150
    5251== Alternative Download Formats ==
     
    5756=== Comma-delimited - CSV (Comma Separated Values) ===
    5857Export the report as plain text, each row on its own line, columns separated by a single comma (',').
    59 '''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
     58'''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure.
    6059
    6160=== Tab-delimited ===
     
    7372A report is basically a single named SQL query, executed and presented by
    7473Trac.  Reports can be viewed and created from a custom SQL expression directly
    75 in the web interface.
     74in from the web interface.
    7675
    7776Typically, a report consists of a SELECT-expression from the 'ticket' table,
     
    10099See TracTickets for a detailed description of the column fields.
    101100
    102 Example: '''All active tickets, sorted by priority and time'''
     101'''all active tickets, sorted by priority and time'''
     102
     103'''Example:''' ''All active tickets, sorted by priority and time''
    103104{{{
    104105SELECT id AS ticket, status, severity, priority, owner,
    105        time AS created, summary FROM ticket
     106       time as created, summary FROM ticket
    106107  WHERE status IN ('new', 'assigned', 'reopened')
    107108  ORDER BY priority, time
    108109}}}
    109110
    110 ---
     111
     112----
     113
    111114
    112115== Advanced Reports: Dynamic Variables ==
     
    137140
    138141
    139 === !Special/Constant Variables ===
    140 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
     142=== Special/Constant Variables ===
     143There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.
    141144
    142145 * $USER -- Username of logged in user.
     
    163166=== Automatically formatted columns ===
    164167 * '''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)
    167168 * '''created, modified, date, time''' -- Format cell as a date and/or time.
     169
    168170 * '''description''' -- Ticket description field, parsed through the wiki engine.
    169171
    170172'''Example:'''
    171173{{{
    172 SELECT id AS ticket, created, status, summary FROM ticket
    173 }}}
    174 
    175 Those columns can also be defined but marked as hidden, see [#column-syntax below].
    176 
    177 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
     174SELECT id as ticket, created, status, summary FROM ticket
     175}}}
    178176
    179177=== Custom formatting columns ===
     
    182180 
    183181 * '''`__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.
    185182 * '''`__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.
    186183{{{
     
    196193 * '''`__style__`''' -- A custom CSS style expression to use for the current row.
    197194
    198 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
     195'''Example:''' ''List active tickets, grouped by milestone, colored by priority''
    199196{{{
    200197SELECT p.value AS __color__,
    201198     t.milestone AS __group__,
    202      '../milestone/' || t.milestone AS __grouplink__,
    203199     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
    204200       t.id AS ticket, summary
     
    212208numeric representation from the ''enum'' table.
    213209
    214 === Changing layout of report rows === #column-syntax
     210=== Changing layout of report rows ===
    215211By default, all columns on each row are display on a single row in the HTML
    216212report, possibly formatted according to the descriptions above. However, it's
     
    222218
    223219 * '''`_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.
    225220
    226221'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png