### The TaskJuggler User Manual

Project Management beyond Gantt Chart Drawing

<< tooltip (column) << | Table Of Contents | >> trackingscenario >>

Keyword | tracereport

Purpose

The trace report works noticeably different than all other TaskJuggler reports. It uses a CSV file to track the values of the selected attributes. Each time `tj3` is run with the `--add-trace` option, a new set of values is appended to the CSV file. The first column of the CSV file holds the date when the snapshot was taken. This is either the current date or the `now` date if provided. There is no need to specify CSV as output format for the report. You can either use these tracked values directly by specifying other report formats or by importing the CSV file into another program.

The first column always contains the current date when that table row was added. All subsequent columns can be defined by the user with the columns attribute. This column set is then repeated for all properties that are not hidden by hideaccount, hideresource and hidetask. By default, all properties are excluded. You must provide at least one of the `hide...` attributes to select the properties you want to have included in the report. Please be aware that the total number of columns is the product of attributes defined with columns times the number of included properties. Select your values carefully or you will end up with very large reports.

The column headers can be customized by using the title attribute. When you include multiple properties, these headers are not unique unless you include mini-queries to modify them based on the property the column is representing. You can use the queries `<-id->`, `<-name->`, `<-scenario->` and `<-attribute->`. `<-id->` is replaced with the ID of the property, `<-name->` with the name and so on.

You can change the set of tracked values over time. Old values will be preserved and the corresponding columns will be the last ones in the CSV file.

When other formats are requested, the CSV file is read in and a report that shows the tracked values over time will be generated. The CSV file may contain all kinds of values that are being tracked. Report formats that don't support a mix of different values will just show the values of the second column.

The values in the CSV files are fixed units and cannot be formatted. Effort values are always in resource-days. This allows other software to interpret the file without any need for additional context information.

The HTML version generates SVG graphs that are embedded in the HTML page. These graphs are only visible if the web browser supports HTML5. This is true for the latest generation of browsers, but older browsers may not support this format.

Syntax | `tracereport [<id>] <name> [{ <attributes> }]`
Arguments | id [ID] | An optional ID. If you ever want to reference this property, you must specify your own unique ID. If no ID is specified, one will be automatically generated. These IDs may become visible in reports, but may change at any time. You may never rely on automatically generated IDs.

name [STRING]

The name of the report. This will be the base name for generated output files. The suffix will depend on the specified formats. It will also be used in navigation bars.

By default, report definitions do not generate any files. With more complex projects, most report definitions will be used to describe elements of composed reports. If you want to generate a file from this report, you must specify the list of formats that you want to generate. The report name will then be used as a base name to create the file. The suffix will be appended based on the generated format.

Reports have a local name space. All IDs and file names must be unique within the reports that belong to the same enclosing report. To reference a report for inclusion into another report, you need to specify the full report ID. This is composed of the report ID, prefixed by a dot-separated list of all parent report IDs.

Context | accountreport, export, properties, resourcereport, taskreport, textreport, tracereport

Attributes | Name | Scen. spec. | Inh. fm. Global | Inh. fm. Parent
accountreport |  |  |
accountroot |  |  | x
auxdir (report) |  | x | x
balance |  |  |
caption |  |  | x
center |  |  | x
columns |  |  | x
currencyformat |  |  |
end (report) |  | x | x
epilog |  |  | x
export |  |  |
flags (report) |  |  | x
footer |  |  | x
formats |  |  | x
header |  |  | x
headline |  |  | x
height |  |  |
hideaccount |  |  |
hidejournalentry |  |  |
hideresource |  |  |
hidetask |  |  |
journalattributes |  |  |
journalmode |  |  |
left |  |  | x
loadunit |  |  |
numberformat |  |  |
opennodes |  |  |
period (report) |  |  |
prolog |  |  | x
purge |  |  |
rawhtmlhead |  |  |
resourcereport |  |  |
resourceroot |  |  | x
right |  |  | x
rollupaccount |  |  |
rollupresource |  |  |
rolluptask |  |  |
scenarios |  |  | x
selfcontained |  |  | x
sortaccounts |  |  |
sortjournalentries |  |  |
sortresources |  |  |
sorttasks |  |  |
start (report) |  | x | x
taskreport |  |  |
taskroot |  |  | x
textreport |  |  |
timeformat |  |  |
timezone (report) |  | x | x
title |  |  | x
tracereport |  |  |
width |  |  | x

    project "Trace Reports" 2012-01-14 +2m

    task "Foo"
    task "Bar"
    task "FooBar"

    tracereport "TraceReport" {
      columns end { title "<-name->" }
      hidetask 0
    }

<< tooltip (column) << | Table Of Contents | >> trackingscenario >>

Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 by Chris Schlaeger <cs@taskjuggler.org>.TaskJuggler is a trademark of Chris Schlaeger.