Open Interface to Output Management Systems

With AE, information about the execution of tasks can also be exported to files so that object names, states and return codes are available. The execution report is additionally available in form of a text file. Structured data allows for quick and easy report analyses.

You can access information about job executions, reports and file transfers.

ReportBericht, der nähere Informationen über die Durchführung einer Aufgabe oder einer Komponente enthält. data can either be edited with the utility AE DB ArchiveDas Dienstprogramm AE DB Archive dient dazu, den stetig wachsenden Bestand an Daten aus der Automation Engine-Datenbank auszulagern. or directly by accessing the database table "XRO" which supports your self-developed programs.

This special form of report editing is by default not active and must be activated for each client. Do so with the key XRO_REPORTS in the variable UC_CLIENT_SETTINGS.

An entry containing the object names, time of execution and a reference to the report is written for each job runs or file transfer that takes place. This data can be edited with the utility AE DB Archive

Note that XRO entries should regularly be removed from the tables in order to reduce the ever growing amount of data in the database. Details are described in the section "Removing Table Entries".

Start AE DB Archive in batch mode with the syntax shown below. As a result, a CSV file listing all non-archived task executions is supplied:

UCYBDBAR -B -Xlist -Sclient/-Dclient [-Opath and file name] [-Ystatus]

If no path is indicated, the file "uc_XROlist.csv" is created in the folder of this utility.

The file content is exactly the same as the content of the database table "XRO". Its structure is described at the end of this document.

The utility cancels the procedure if a file of the same name already exists.

If the result file should not contain all table entries, the start parameter _Y can be used. Hence, only the lines with the indicated status (Column "XRO_CusStatus") are selected. Any value (a number) of your choice can be used and specified when the report is unloaded.

AE DB Archive creates an empty file if there is no report data.

Call AE DB Archive in batch mode using the following syntax to export reports to text files:

UCYBDBAR -B -Xunload -Sclient/-Dclient -RRunID"Kurzform für ""laufende Nummer"". Hierbei handelt es sich genauer um eine Zahl, welche die Durchführung einer Aufgabe eindeutig kennzeichnet. Die RunID kann zwischen 7 und 10 Stellen aufweisen. Sie wird von der Komponente Automation Engine vergeben." of the task [-TYReport type] [-Opath and file name] [-Ystatus]

Specify a task's RunID and the report type to unload a particular report. Only specifying the RunID and no report type has the effect that all reports of the particular execution are supplied.

If no path is specified, the file "uc_XROreport.txt" is created in the folder of this utility. This text file contains the report data content.

The utility cancels the procedure if a file of the same name already exists.

The start parameter -Y can be used to set a report status. Specify any number of your choice and enter it in the column XRO_CusStatus. This value can then be used to filter the report list.

Unloading a report does not delete the report entries in the table "XRO". This is done in the next step.

There are two ways of reorganizing table entries:

1. Start AE DB Archive with the syntax shown below in order to flag the reports as being archived, thus removing their entries from the database table "XRO":
   
   UCYBDBAR -B Xmark -Sclient/-Dclient -RRunID of the task [-TYReport type]
2. Use the utility AE DB Reorg. When reports are reorganized, the table XRO is automatically included in this process.

Structure of the Database Table XRO

The exported CSV file contains the content and structure of the database table "XRO". Both have the following columns:

See also:

About Reports
Start Parameters