Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
Jul 17, 2008 10:45:00 AM (12 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.''''' 
     20 
    1921A report consists of these basic parts: 
    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. 
     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. 
    2527 
    2628== Changing Sort Order == 
     
    3032 
    3133== Changing Report Numbering == 
    32 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): 
    3335 * id integer PRIMARY KEY 
    3436 * author text 
     
    4244Keep 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). 
    4345 
    44 You 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). ''(since 0.11)'' 
    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:''' 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. 
    5959 
    6060=== Tab-delimited === 
     
    7272A report is basically a single named SQL query, executed and presented by 
    7373Trac.  Reports can be viewed and created from a custom SQL expression directly 
    74 in the web interface. 
     74in from the web interface. 
    7575 
    7676Typically, a report consists of a SELECT-expression from the 'ticket' table, 
     
    9999See TracTickets for a detailed description of the column fields. 
    100100 
    101 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'' 
    102104{{{ 
    103105SELECT id AS ticket, status, severity, priority, owner,  
    104        time AS created, summary FROM ticket  
     106       time as created, summary FROM ticket  
    105107  WHERE status IN ('new', 'assigned', 'reopened') 
    106108  ORDER BY priority, time 
    107109}}} 
    108110 
    109 --- 
     111 
     112---- 
     113 
    110114 
    111115== Advanced Reports: Dynamic Variables == 
     
    136140 
    137141 
    138 === !Special/Constant Variables === 
    139 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.  
    140  
    141  * $USER Username of logged in user. 
     142=== Special/Constant Variables === 
     143There 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. 
    142146 
    143147Example (''List all tickets assigned to me''): 
     
    161165 
    162166=== Automatically formatted columns === 
    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  * '''created, modified, date, time''' — Format cell as a date and/or time. 
    167  * '''description''' — Ticket description field, parsed through the wiki engine. 
     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. 
    168171 
    169172'''Example:''' 
    170173{{{ 
    171 SELECT id AS ticket, created, status, summary FROM ticket  
    172 }}} 
    173  
    174 Those columns can also be defined but marked as hidden, see [#column-syntax below]. 
    175  
    176 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}}} 
    177176 
    178177=== Custom formatting columns === 
     
    180179assumed to be ''formatting hints'', affecting the appearance of the row. 
    181180  
    182  * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table. 
    183  * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group. 
    184  * '''`__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. 
     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. 
    185183{{{ 
    186184#!html 
     
    193191</div> 
    194192}}} 
    195  * '''`__style__`''' A custom CSS style expression to use for the current row.  
    196  
    197 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 
     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'' 
    198196{{{ 
    199197SELECT p.value AS __color__, 
    200198     t.milestone AS __group__, 
    201      '../milestone/' || t.milestone AS __grouplink__, 
    202199     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 
    203200       t.id AS ticket, summary 
     
    211208numeric representation from the ''enum'' table. 
    212209 
    213 === Changing layout of report rows === #column-syntax 
     210=== Changing layout of report rows === 
    214211By default, all columns on each row are display on a single row in the HTML 
    215212report, possibly formatted according to the descriptions above. However, it's 
    216213also possible to create multi-line report entries. 
    217214 
    218  * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line. 
    219  
    220  * '''`_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. 
    221  
    222  * '''`_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). 
    223    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. 
     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). 
    224220 
    225221'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout'' 
     
    246242If 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. 
    247243 
    248 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. 
     244If 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. 
    249245 
    250246'''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''