Open Interface to Output Management Systems

To use execution information and reports of jobs and file transfers in an output management system, this data must be provided in a structured way. Administrators can use the Automation Engine to extract the entries that are written for each execution either by using the AE DB Archive utility or directly in the XRO database table which supports your self-developed programs.

Important!

• To access the XRO database table, you must activate the parameter XRO_REPORTS in the UC_CLIENT_SETTINGS variable, see XRO_REPORTS.
• Remove XRO entries regularly from the database tables to reduce the increasing amount of data in the database.

List Reports

To list all executions not archived up to now, start the AE DB Archive utility from the command line using the syntax shown below. The result is shown in a CSV file:

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

• If you do not specify a path, the uc_XROlist.csv file is created in the folder where the utility is stored. The file content is the same as the content of the XRO database table. The utility aborts if a file of the same name already exists.
• To show only table entries of a certain status, use the start -Y parameter . In this case, only the lines that have the specified status are exported (XRO_CusStatus column). You can define this value (a number) and set it when you unload the report.

Unload Reports

To export reports to text files, start the AE DB Archive utility from the command line using the following syntax:

UCYBDBAR -B -Xunload -Sclient/-Dclient -RRunID of the task [-TYReport type] [-Opath and file name] [-Ystatus]

• To unload a specific report, define the task's RunID and the report type.
• To unload all the reports of a specific execution, only define the RunID.
• To unload reports from a specific client, the Windows account user has to exist under exact same name in the Automation Engine.
• If you do not define a path, the uc_XROreport.txt file will be created in the folder where the utility is stored. This text file contains the report data content. The utility aborts if a file of the same name already exists.
• To set a report status, use the -Y start parameter. Define any number of your choice and enter it in the XRO_CusStatus column. You can filter your report list by using this value.

Notes:

• Unloading a report does not remove report entries in the XRO table.
• You cannot unload reports from specific users through the command line.

Remove Table Entries

Start the AE DB Archive utility from the command line using the following syntax in order to flag the reports as archived. In doing so, you remove their entries from the XRO database table:

UCYBDBAR -B Xmark -Sclient/-Dclient -RRunID of the task [-TYReport type]

(Optional) Use the AE DB Reorg utility. When reports are reorganized, the XRO table is automatically included in this process. For more information, see AE DB Reorg.

Structure of the XRO Database Table

The exported CSV file contains the content and structure of the XRO database table. Both, the CSV file and the database table, include the same columns:

• XRO_Client
  Client
• XRO_AH_Idnr
  Run number (RunID) of the task execution
• XRO_RType
  Report type
• XRO_System
  Name of the AE system
• XRO_OType
  Object type (JOBS, JOBF)
• XRO_Object
  Name of the object
• XRO_HostDst
  Name of the agent on the target host
• XRO_LoginDst
  User name under which the object is processed
• XRO_HostScr
  Name of the agent on the source host (only for file transfers)
• XRO_LoginSrc
• User name for the source host (only for file transfers)
• XRO_TimeStamp1
  Start time of the execution
• XRO_TimeStamp4
  End time of the execution
• XRO_RetCode
  Return code of the task
• XRO_Status
  Status of the task
• XRO_RRetCode
  Return code of the report transfer
  • 0 - Report was successfully transferred
  • 4 - Report is incomplete
  • 8 - Report transfer failed
• XRO_ReportSize
  Report size in bytes. File transfers will always show "0" here.
• XRO_UserTime
  Consumed user time
• XRO_KernelTime
  Consumed Kernel time
• XRO_CpuTime
  Consumed CPU time
• XRO_Archive1
  First archive key of the object
• XRO_Archive2
  Second archive key of the object
• XRO_CusStatus
  User-defined number for filter usage

See also:

• Reports
• Start Parameters - Utilities
• UC_CLIENT_SETTINGS - Various Client Settings