seriesReport (element)

Description

The seriesReport element, which must be nested within the instantiations.audit (or codepro.audit) task, is used to generate a report based on the results of a series of audits.

Note: In order to make use of this element you must include the storageLocation attribute in the enclosing instantiations.audit task. The specified location should be the location in which the audit series and individual audit result sets are stored. Further, the audit series should be configured to automatically include all of the result sets in the directory.

Attributes

The following attributes are used to control the report generation process:

Attribute Description Required
seriesFile

The name of the audit series file within the storage location specified in the enclosing instantiations.audit task.

Yes
file

The absolute or relative path to the file to which the audit series report will be written. If this attribute is not specified then the report will not be saved to a file. Omitting the file path makes sense only if the mail sub-element is specified.

No

Nested Elements

The following elements can be nested within the seriesReport element.

<mail>

The mail element is used to send the generated report as an attachment in an e-mail message.

Examples

The following seriesReport element will generate an HTML report to the file named "audit_series.html" based on the audit series defined in the file "series.aser".

<seriesReport
      file="audit_series.html"
      seriesFile="series.aser"/>