Changes between Version 2 and Version 3 of TracReports

Timestamp:

Sep 13, 2025, 3:01:44 PM (12 months ago)

Author:

trac

Comment:

--

TracReports

@@ -5 +5 @@
 The Trac reports module provides a simple, yet powerful reporting facility to present information about tickets in the Trac database.
 
-Rather than have its own report definition format, TracReports relies on standard SQL `SELECT` statements for custom report definition. 
+Rather than have its own report definition format, TracReports relies on standard SQL `SELECT` statements for custom report definition.
 
   '''Note:''' The report module is being phased out in its current form because it seriously limits the ability of the Trac team to make adjustments to the underlying database schema. We believe that the [wiki:TracQuery query module] is a good replacement that provides more flexibility and better usability. While there are certain reports that cannot yet be handled by the query module, we intend to further enhance it so that at some point the reports module can be completely removed. This also means that there will be no major enhancements to the report module anymore.
@@ -17 +17 @@
 
 A report consists of these basic parts:
- * '''ID''' — Unique (sequential) identifier 
+ * '''ID''' — Unique (sequential) identifier
  * '''Title''' — Descriptive title
  * '''Description''' — A brief description of the report, in WikiFormatting text.
@@ -25 +25 @@
 == Changing Sort Order
 
-Simple reports - ungrouped reports to be specific - can be sorted by clicking the column header. 
+Simple reports - ungrouped reports to be specific - can be sorted by clicking the column header.
 
 If a column header is a hyperlink (red), click the column to sort by it. Clicking the same header again reverses the sort order.
@@ -38 +38 @@
 
 In addition to the HTML view, reports can also be exported in a number of alternate formats.
-At the bottom of the report page, you will find a list of available data formats. Click the desired link to 
+At the bottom of the report page, you will find a list of available data formats. Click the desired link to
 download the alternate format.
 
@@ -72 +72 @@
  * changetime
  * component
- * severity  
- * priority 
+ * severity
+ * priority
  * owner
  * reporter
@@ -89 +89 @@
 Example: '''All active tickets, sorted by priority and time'''
 {{{#!sql
-SELECT id AS ticket, status, severity, priority, owner, time AS created, summary 
-FROM ticket 
+SELECT id AS ticket, status, severity, priority, owner, time AS created, summary
+FROM ticket
 WHERE status IN ('new', 'assigned', 'reopened')
 ORDER BY priority, time
@@ -97 +97 @@
 == Advanced Reports: Dynamic Variables
 
-For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements. 
-In 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)//.
+For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
+In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution. Dynamic variables are entered through the preferences form and the values are autocompleted //(Since 1.3.2)//.
 
 === Using Variables in a Query
 
-The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.
+The syntax for dynamic variables is simple, any upper case word beginning with `$` is considered a variable.
 
 Example:
@@ -109 +109 @@
 }}}
 
-To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$':
+The value of the dynamic variable can be assigned in the report preferences form.
+
+To assign a value to `$PRIORITY` in the URL for a report, leave out the leading `$`:
 {{{
- http://trac.edgewall.org/reports/14?PRIORITY=high
-}}}
-
-To use multiple variables, separate them with an '&':
+ https://trac.edgewall.org/reports/14?PRIORITY=high
+}}}
+
+To use multiple variables, separate them with an `&`:
 {{{
- http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
-}}}
+ https://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
+}}}
+
+It is possible to assign a default value to the variable, within a SQL comment:
+
+{{{#!sql
+-- PRIORITY = high
+
+SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
+}}}
+
 
 === !Special/Constant Variables
 
-There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 
+There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
 
  * $USER — Username of logged in user.
@@ -140 +151 @@
 === Automatically formatted columns
 
- * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 
+ * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
  * '''id''' — same as '''ticket''' above when '''realm''' is not set
  * '''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)
@@ -149 +160 @@
 '''Example:'''
 {{{#!sql
-SELECT id AS ticket, created, status, summary FROM ticket 
+SELECT id AS ticket, created, status, summary FROM ticket
 }}}
 
@@ -160 +171 @@
 Columns whose names begin and end with 2 underscores (e.g. '''`__color__`''') are
 assumed to be ''formatting hints'', affecting the appearance of the row.
- 
+
  * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table.
  * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
  * '''`__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.
  {{{#!html
-<div style="margin-left:3em">Defaults: 
+<div style="margin-left:3em">Defaults:
 <span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
 <span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
@@ -184 +195 @@
      t.id AS ticket, summary
 FROM ticket t,enum p
-WHERE t.status IN ('new', 'assigned', 'reopened') 
+WHERE t.status IN ('new', 'assigned', 'reopened')
   AND p.name = t.priority AND p.type = 'priority'
 ORDER BY t.milestone, p.value, t.severity, t.time
@@ -207 +218 @@
 SELECT p.value AS __color__,
        t.milestone AS __group__,
-       (CASE owner 
-          WHEN 'daniel' THEN 'font-weight: bold; background: red;' 
+       (CASE owner
+          WHEN 'daniel' THEN 'font-weight: bold; background: red;'
           ELSE '' END) AS __style__,
        t.id AS ticket, summary AS summary_,             -- ## Break line here
@@ -216 +227 @@
        changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
 FROM ticket t,enum p
-WHERE t.status IN ('new', 'assigned', 'reopened') 
+WHERE t.status IN ('new', 'assigned', 'reopened')
   AND p.name = t.priority AND p.type = 'priority'
 ORDER BY t.milestone, p.value, t.severity, t.time
@@ -242 +253 @@
 -- ## 4: Assigned, Active Tickets by Owner ## --
 
--- 
+--
 -- List assigned tickets, group by ticket owner, sorted by priority.
--- 
+--
 
 SELECT p.value AS __color__,
@@ -307 +318 @@
 
 ----
-See also: TracTickets, TracQuery, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
+See also: TracTickets, TracQuery, [https://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]