The Report Tool generates reports over the contents of a certain project. The report can be generated as MS Word™, HTML, OpenDocument Text or DocBook file. The report wizard assists you in customizing the report. A report is always generated on the basis of a report template. This report template defines the content of the report. The appearance of the report is defined separately in a format template.
The report wizard for generating reports is started in the project navigator via the entry Generate report... in the context menu of the project, the Report Templates node in the project tree or the report template to be used.
In order to generate a report please choose the desired report template, the output format, a suitable format template and specify the target file name for the generated report. Furthermore you can define the contents of the report from the report wizard by using filters to determine which data is to be included.
ARCWAY provides a number of default report and format templates, which can be found on the ARCWAY Website. Beyond that it is possible to create custom report and format templates according to your personal or company's needs. How to do this is described in more detail in the sub chapters.
In order to use report and format templates for generating reports, they have to be loaded into the project, beforehand.
Report templates are stored in particular report template folders. These folders can be hierarchically structured. For every report template folder there is a sub-folder for format templates. The visibility of format templates is restricted to report templates which are contained in the same report template folder or in any of its sub-folders.
New folders for report templates can be created in the context menu of the entry Report Templates or of a report template folder via New-->Folder for Report Templates.
To load a report template into a Cockpit project, select New-->Report Template... in the context menu of a report template directory. In the wizard, which is opened, you have to specify the underlying script file and the modules for which filters should be provided in the report wizard when creating a report using this report template.
In order to load a format template into a Cockpit project, choose New-->Format Template... in the context menu of a format template folder. In the wizard, which is opened, you have to select the output type and the appropriate format template file. This may be a *.dot file for MS Word™ or a *.css file for HTML reports, e.g..
