Administration Guide > Utilities > AE DB Archive > Open Interface to Output Management Systems

Open Interface to Output Management Systems

With AE, information about the execution of tasks can also be exported to files so that objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task names, states and return codes are available. The execution reportA report provides more detailed information about a task's execution or a component. is additionally available in form of a text file. Structured data allows for quick and easy report analyses.

You can access information about jobAn Automation Engine object type for a process that runs on a target system. executions, reports and file transfers.

Report data can either be edited with the utility AE DB ArchiveThe utility AE DB Archive can be used to remove the increasing amounts of data from the Automation Engine database. or directly by accessing the databaseA database is an organized collection of data including relevant data structures. 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 clientA closed environment within an Automation Engine system where you can create and run objects. A client name consists of a 4-digit number that must be indicated when a user logs on to the Automation Engine system. Users and their rights are also defined in clients. A particular Automation Engine object type.. Do so with the key XRO_REPORTS in the variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. 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 transferTransfers files from one computer to another. A particular Automation Engine object type (FileTransfer object). 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".

Listing Reports

Start AE DB Archive in batch mode with the syntax shown below. As a result, a CSV file listing all non-archived taskAn executable object that is running. Tasks are also referred to as activities. executions is supplied:

UCYBDBAR -B -Xlist -Sclient/-Dclient [-Opath and file name] [-YstatusThis represents the condition of a task (such as active, blocked, generating).]

If no path is indicated, the file "uc_XROlist.csv" is created in the folderTop level entities such as Environment, Deployment Target, Activity, … are stored in folders. The permissions a user has on an entity depend on the permissions that are set on the folder for the entities. 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.

Unloading Reports

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

UCYBDBAR -B -Xunload -Sclient/-Dclient -RRunIDShort for "run number". It is a number that provides unique information about a task's execution. The RunID can include 7 to 10 digits. It is assigned by the Automation Engine component . 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 listShows entities in a grid view.

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

Removing Table Entries

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 -S
    client/-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:

Column name

Description

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 agentA program that enables the de-centralized execution of processes (such as deployments) on target systems (computers or business solutions) or a service that provides connectivity to a target system (such as for databases or middleware). An agent is also an object type in the Automation Engine. [Formerly called "Executor."] See also: host on the target hostComputer, target system.

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

Note that file transfers always contain "0" in this column.

XRO_UserTime

Consumed userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. 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:

About Reports
Start Parameters

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH