### The TaskJuggler User Manual

Project Management beyond Gantt Chart Drawing

<< taskprefix << | Table Of Contents | >> taskroot >>

Keyword | taskreport

Purpose

The report lists tasks and their respective values in a table. To reduce the list of included tasks, you can use the hidetask, rolluptask or taskroot attributes. The order of the task can be controlled with sorttasks. If the first sorting criteria is tree sorting, the parent tasks will always be included to form the tree. Tree sorting is the default. You need to change it if you do not want certain parent tasks to be included in the report.

By default, all the resources that are allocated to each task are hidden, but they can be listed as well. Use the hideresource attribute to select which resources should be included.

Syntax | `taskreport [<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 |  |  | 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 "Simple Project" 2005-06-06 - 2005-06-26 {
      timezone "America/Denver"
    }

    copyright "Bucks Beavis Inc."

    resource tux "Tux"

    task items "Project breakdown" {
      start 2005-06-06

      task plan "Plan work" {
        length 3d
      }

      task implementation "Implement work" {
        effort 5d
        allocate tux
        depends !plan
      }

      task acceptance "Customer acceptance" {
        duration 5d
        depends !implementation
      }
    }

    taskreport breakdown "ProjectBreakdown.html" {
      formats html
      caption "This is the project breakdown"
      headline "Project Breakdown"
      columns name, start, end, daily
      # Don't hide any resource, meaning show them all.
      hideresource 0
    }

<< taskprefix << | Table Of Contents | >> taskroot >>

Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012 by Chris Schlaeger <chris@linux.com>.TaskJuggler is a trademark of Chris Schlaeger.