Changes between Version 4 and Version 5 of TracReports


Ignore:
Timestamp:
03/19/10 15:41:44 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v4 v5  
    1  
    2  
    31= Trac Reports = 
    42[[TracGuideToc]] 
     
    1917  ''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.'' 
    2018 
     19 
    2120A report consists of these basic parts: 
    2221 * '''ID''' -- Unique (sequential) identifier  
     
    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 (as of 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 
     47== Navigating Tickets == 
     48Clicking 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. 
     49 
     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)'' 
    3351 
    3452== Alternative Download Formats == 
     
    6381The ''ticket'' table has the following columns: 
    6482 * id 
     83 * type 
    6584 * time 
    6685 * changetime 
     
    7796 * summary 
    7897 * description 
     98 * keywords 
    7999 
    80100See TracTickets for a detailed description of the column fields. 
     
    103123Example: 
    104124{{{ 
    105 SELECT id AS ticket,summary FROM ticket WHERE priority='$PRIORITY' 
    106 }}} 
    107  
    108 To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the the leading '$'. 
     125SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 
     126}}} 
     127 
     128To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'. 
    109129 
    110130Example: 
    111131{{{ 
    112  http://projects.edgewall.com/trac/reports/14?PRIORITY=high 
     132 http://trac.edgewall.org/reports/14?PRIORITY=high 
    113133}}} 
    114134 
     
    117137Example: 
    118138{{{ 
    119  http://projects.edgewall.com/trac/reports/14?PRIORITY=high&SEVERITY=critical 
     139 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical 
    120140}}} 
    121141 
     
    128148Example (''List all tickets assigned to me''): 
    129149{{{ 
    130 SELECT id AS ticket,summary FROM ticket WHERE owner='$USER' 
     150SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 
    131151}}} 
    132152 
     
    147167=== Automatically formatted columns === 
    148168 * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.  
     169 * '''id''' -- same as '''ticket''' above when '''realm''' is not set 
     170 * '''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) 
    149171 * '''created, modified, date, time''' -- Format cell as a date and/or time. 
    150  
    151172 * '''description''' -- Ticket description field, parsed through the wiki engine. 
    152173 
     
    155176SELECT id as ticket, created, status, summary FROM ticket  
    156177}}} 
     178 
     179Those columns can also be defined but marked as hidden, see [#column-syntax below]. 
    157180 
    158181=== Custom formatting columns === 
     
    162185 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table. 
    163186 * '''`__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. 
     187{{{ 
     188#!html 
     189<div style="margin-left:7.5em">Defaults:  
     190<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span> 
     191<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span> 
     192<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span> 
     193<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span> 
     194<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span> 
     195</div> 
     196}}} 
    164197 * '''`__style__`''' -- A custom CSS style expression to use for the current row.  
    165198 
     
    179212numeric representation from the ''enum'' table. 
    180213 
    181 === Changing layout of report rows === 
     214=== Changing layout of report rows === #column-syntax 
    182215By default, all columns on each row are display on a single row in the HTML 
    183216report, possibly formatted according to the descriptions above. However, it's 
     
    189222 
    190223 * '''`_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. 
    191225 
    192226'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout'' 
     
    211245=== Reporting on custom fields === 
    212246 
    213 If you have added custom fields to your tickets (experimental feature in 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. 
    214  
    215 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. 
    216  
    217 ---- 
    218 See also: TracTickets, TracQuery, TracGuide"And Howondaland Smith, Balrog Hunter, practic'ly eats the dark for 
    219 his tea." 
    220         -- Gaspode the wonder dog 
    221            (Terry Pratchett, Moving Pictures) 
    222 http://lnx.spmg.it/moodle/user/view.php?id=470&course=1&viagra-cialis 
    223  [http://www.kaboodle.com/buycheapcialis Cialis or generic Cialis] 
    224 [http://compraviagra.style.it/ cialis e viagra] 
    225 [http://www.cittaeducativa.roma.it/moodle/user/view.php?id=2744&compra-viagra-cialis effetti collaterali viagra e levitra] 
    226 [http://www.tomshw.it/forum/members/compra-propecia.html acquisto propecia] 
    227 http://compracialis.it/it/item/generic_propecia.html 
    228 http://www.dogomania.com/forum/showthread.php?p=276144 
    229 http://showhype.com/profile/Buy_Cialis/ 
    230 http://www.xomreviews.com/headachetreatment.net 
    231 http://showhype.com/profile/Buy_Cialis/ 
    232 [http://www.online-casino-gaming.org play online casino] 
    233 RXmfezM [http://lasuperdirectory.altervista.org/single.php?id=352 viagra prezzi] 
    234 [http://www.headachetreatment.net/ fioricet headache treatment] [http://www.mania.com/buycialis/blog.html CIALIS] 
    235 ATF2yri [http://www.folkd.com/user/tramadolonline tramadol cheap order] 
    236   
    237 The phrase 'dead ringer' refers to someone who sits behind Chuck Norris in a movie theater and forgets to turn their cell phone off.  
    238 [http://www.folkd.com/user/buycialisonline cheap Cialis and Cialis] 
    239 [http://buycialis.cc/en/item/viagra.html generic viagra] 
    240 http://microsoftontheissues.com/cs/members/Buy-Generic-Cialis-Online.aspx 
    241 http://www.folkd.com/user/buyviagra1 
    242 [http://subscene.com/members/Buy_2D00_levitra_2D00_online.aspx order levitra online] 
    243 [http://community.tasteofhome.com/members/BuyTramadol/default.aspx tramadol online] 
    244 OGziq8r 
    245 http://www.sims99.com/forum/member.php?u=9418&buy-levitra 
    246 http://microsoftontheissues.com/cs/members/Buy-Tramadol-Online.aspx 
    247 [http://community.icontact.com/users/buyfioricet buy brand fioricet] 
    248 [http://www.cittaeducativa.roma.it/moodle/user/view.php?id=2744&compra-viagra-cialis viagra e cialis] 
    249 http://buycialisonline.tv/product.php?prod=fioricet 
    250 http://www.rattidellasabina.it/forums/index.php?showuser=2181 
     247If 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. 
     248 
     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. 
     250 
     251'''Note that you need to set up permissions in order to see the buttons for adding or editing reports.''' 
     252 
     253---- 
     254See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]