Running batch reports

About this task

The \reports\templates directory contains a sample template file for each type of report.

Before running any of these reports make sure that you customize the corresponding template file, named report_name.properties, by specifying:

The information to display in the report header.
How to filter the information to display the expected result.
The format and content of the report output.

Note: For z/OS operating systems only, to edit the report_name.properties file it is required that you copy the file on your local workstation in binary mode, make the required changes, and copy back the file to the


\reports\templates

directory in binary mode. Changes are effective immediately.

For more information about each specific setting, see the explanation provided in the template file beside each field.

If you are using DBCS characters to specify the parameters in the template .properties files, ensure that you save the file in UTF-8 encoding.

After you set up the environment as it is described in Setting up for command line batch reporting, and you configured the report template file, use the following syntax to run the report:

reportcli -p report_name.property
     [-o output_report_dir]
     [-r report_output_name]
     [-k key=value ]
     [-k key=value ]
     .......

Where:

-p report_name.property: Complete path to the report template file.
-o output_report_dir: Output directory for the report output.
-r report_output_name: Name of the report output.
-k key=value: Value of a specific setting. This value override the corresponding value, if defined, in the common.properties file or in the report_name.properties file.