Report Export

Overview

You can access and manually download reports through the Report menu in the user interface. Alternatively, the ReportExportWorkEntryExecutor class creates and exports one or more reports as part of a server job execution. If needed, the generated reports can also be emailed.

Multiple reports can be exported by one Task by specifying the parameters for each file export in a data block.

Parameters

This executable class accepts the following parameters:

Parameter Description
excludeTitle

If set to true, this parameter omits the title from the report.

Default: false
exportFormat

Specifies the format of the exported file.

Note: Currently, only the CSV format is supported.
filePath

Name of the output report file.

This parameter can include any of the Internal variables.

Mandatory: Yes
reportName

Name of the generated report.

Mandatory: Yes
q:<query parameter>

Specifies the query parameters for reports. Each query parameter name should be prefixed with q:. For example, q:runId passes the query parameter runID to the report.

Query parameters can contain embedded Internal variables.

Query parameters can specify sub-queries between (). For example, to select the most recent run id for a job, the following can be specified:

(SELECT nvl((SELECT run_id from ua_run where (job_name, run_seq) in (select job_name, max(run_seq) from ua_run where job_name = ‘MY_VALIDATION_JOB’ group by job_name)),-1) FROM dual)

If specified in a Data Block, a sub-query can have multiple lines.

Report export data blocks

In the Data Blocks of a Task, you can specify the report export parameters for multiple reports. This allows you to generate multiple reports in a single chained task. To execute multiple exports in a single task, create a Data Block for each export with its parameters.

In the Data Blocks, parameters are specified in the following form:

parameterName = value

The parameterName must be one of the supported Parameters. The value can have multiple lines.

Without a Data Block, the Executable uses the parameter definitions for a single export of a report.