Inside Automation Engine > XML Files of Objects > Event > Structure of the Export File

 Export File Structure

The table shown below describes the XML file structure of an Event object and explains the individual elements.


Element

Description

uc-export

Main element of the export file

clientvers = Automation Engine version in which the export file was created

EVNT

Main element of the object

client = The client.
name = The name of the object.
system = The name of the AE system. 

XHEADER

Header tab

XHEADER in executable objects
HEADER = In active, passive and system objects

see object types

The attribute "state" is used system-internally and must not be changed.

Title

Title

User-defined,

max. 255 characters

Created

Time of creation

Format:
First and last name
on: YYYY-MM-DD HH:MM:SS

Modified

Time of last modification

Format:
First and last name on: YYYY-MM-DD HH:MM:SS Total number of modifications x

LastUsed

Time of last use

Format:
First and last name
on: YYYY-MM-DD HH:MM:SS Total number of uses x

ArchiveKey1

Archive key 1

User-defined,
max. 60 characters

Attribute: ARCHIVE_KEY1

ArchiveKey2

Archive key 2

User-defined,
max. 20 characters

Attribute: ARCHIVE_KEY2

ExtRepDef
ExtRepAll
ExtRepNone

Extended reports

ExtRepDef: Default value (UC_CLIENT_SETTINGS)
ExtRepAll: All
ExtRepNone: None

Allowed values: "1" (selected) and "0" (not selected)

Only one of the three options can be selected.

SYNCREF

Sync tab

only for executable objects

The attribute "state" is used system-internally and must not be changed.

Syncs

Sync object settings

Attributes per Sync object definition (row):

Abend = Action when the task is canceled
Else = Else action [allowed values: "A" (cancel), "S" (skip), "W" (wait)]
End = Action when the task ends
Name = Name of the Sync object
Start = Action when the task starts
id = Name of the Sync object

Up to 40 Sync object definitions are allowed.

CALEREF

"Calendar"

For Event objects

The attribute "state" is used system-internally and must not be changed.

Cond

List of Calendar conditions

Attributes per Calendar definition (row):

CaleKeyName = Calendar keyword
CaleName = Calendar object
From = Start time of the period
To = End time of the period
id = Internal number of the Calendar object (OH_Idnr)

ATTR_EVNT

Attributes tab

In all objects except for User, UserGroup, Cockpit, CodeTable, Documentation, Include and Login (ATTR_Object type) objects.

The attribute "state" is used system-internally and must not be changed.

StartType

Start type

Name of a group,
maximal 20 characters,
" " - immediate start

Attribute: START_TYPE

IntAccount

Internal account

User-defined,
maximal 16 characters

Attribute: INT_ACCOUNT, INT_ACC or K

ActAtRun

Generate at runtime

Allowed values: "1" (selected) and "0" (not selected)

Attribute: GEN_AT_RUNTIME

UC4Priority

AE priority

User-defined,
value ranging between "0" and "255"

Attribute: UC4_PRIORITY

MaxParallel2

Maximal number of tasks running parallel

User-defined,
value ranging between "0" and "99999"

Attribute: MAX_PARALLEL_TASKS

MpElse1
MpElse2

Maximal number of tasks running parallel - Else

MpElse1: wait
MpElse2: cancel

Allowed values: "1" (selected) and "0" (not selected)

Attribute: MAX_PARALLEL_ELSE

TZ

TimeZone

Name of a TimeZone object,
maximal 8 characters

Attribute: TIMEZONE

EVNT

Event tab

For Event objects

The attribute "state" is used system-internally and must not be changed.

RepeatTypeR
RepeatTypeS
RepeatTypeF

Execution

RepeatTypeR: Repeated
RepeatTypeS: Once
RepeatTypeF: Until the 1st hit

Allowed values: "1" (selected) and "0" (not selected)

Attribute: EVENT_REPEAT

Only one of the three options can be selected.

EventTypeTT
EventTypeTS
TimePeriodTT
TimePeriodTS

Timer Control

EventTypeTT: Execution in intervals of n minutes
EventTypeTS: Time of execution

Allowed values: "1" (selected) and "0" (not selected)

Only one of the two options can be selected.

 

TimePeriodTT: Minutes
Value ranging between "0" and "9999"

TimePeriodTS: Point in time
Value ranging between "00:00" and "23:59"

TExecTypeT
TExecTypeS

First execution

TExecTypeT: After time is expired
TExecTypeS: Immediately

Allowed values: "1" (selected) and "0" (not selected)

Attribute: EVENT_FIRST_EXEC

Only one of the two options can be selected.

TExecTypeN
TExecTypeE

Start after scheduled time

TExecTypeN: Do not execute
TExecTypeE: Execute

Allowed values: "1" (selected) and "0" (not selected)

Attribute: EVENT_START_AFTER_SCH

Only one of the two options can be selected.

RUNTIME

Runtime tab

only for executable objects

The attribute "state" is used system-internally and must not be changed.

MaxRetCode

Return code (ENDED_OK)

Value ranging between "0" and "2147483647"

Attribute: MAX_RETCODE

FcstStatus

End status for forecast

Format: "system return code|status text"

see also return codes

Ert

Current ERT

Time in seconds

Value ranging between "0" and "35999999"

ErtMethodDef
ErtMethodFix
ErtMethodDyn

Runtime calculation method

ErtMethodDef: Default value (UC_CLIENT_SETTINGS)
ErtMethodFix: Fixed value
ErtMethodDyn: Dynamic method

Allowed values: "1" (selected) and "0" (not selected)

Only one of the three options can be selected.

ErtFix

Fixed value for ERT calculation

This value is part of the fixed value calculation method (ErtMethodFix).

Time in seconds

Value ranging between "0" and "35999999"

ErtDynMethod
ErtCnt
ErtCorr
ErtIgn
ErtIgnFlg
ErtMinCnt

Settings for ERT calculation

These values are part of the dynamic calculation method.

ErtDynMethod: Method
Allowed values: "2|average", "4|maximal value", "8|linear regression"

ErtCnt: Runs
Value between "0" and "99"

ErtCorr: Percentage of runs
Value between "0" and "999"

ErtIgn: Deviation in percent
Value between "0" and "999"

ErtIgnFlg: Consider deviation
Allowed values: "1" (selected) and "0" (not selected)

ErtMinCnt: Minimum runs
Value between "0" and "99"

MrtMethodNone
MrtMethodFix
MrtMethodErt
MrtMethodDate

Monitoring the maximum runtime (MRT)

MrtMethodNone: None
MrtMethodFix: Fixed value
MrtMethodErt: Ert +
MrtMethodDate: Current date +

Allowed values: "1" (selected) and "0" (not selected)

Only one of the four options can be selected.

MrtFix

Fixed value for MRT monitoring

This value is part of the fixed value monitoring method (MrtMethodFix).

Time in seconds

Value ranging between "0" and "35999999"

MrtErt

Percentage for MRT monitoring

This value is part of the monitoring method Ert + (MrtMethodErt).

Value ranging between "0" and "999"

MrtDays
MrtTime
MrtTZ

Settings for MRT monitoring

These values are part of the monitoring method Curr. Date + (MrtMethodDate).

MrtDays: Days
Value between "0" and "99"

MrtTime: Time
Value between "00:00" and "23:59"

MrtTZ: TimeZone
Name of a TimeZone object

SrtMethodNone
SrtMethodFix
SrtMethodErt

Monitoring the minimum runtime (SRT)

SrtMethodNone: None
SrtMethodFix: Fixed value
SrtMethodErt: Ert -

Allowed values: "1" (selected) and "0" (not selected)

Only one of the three options can be selected.

SrtFix

Fixed value for SRT monitoring

This value is part of the monitoring method fixed value (SrtMethodFix).

Time in seconds

Value ranging between "0" and "35999999"

SrtErt

Percentage for SRT monitoring

This value is part of the monitoring method ERT - (SrtMethodErt).

Value ranging between "0" and "999"

MrtCancel

Else action

Cancel/quit (only for MRT monitoring)

Allowed values: "1" (selected) and "0" (not selected)

MrtExecute
MrtExecuteObj

Else action

MrtExecute:
Execute (for the MRT or SRT monitoring)

Allowed values: "1" (selected) and "0" (not selected)

MrtExecuteObj:
Name of the object to be executed

DYNVALUES

"Variables & Prompts" tab

in all executable object except for the Cockpit (CPIT)

The attribute "state" is used system-internally and must not be changed.

dyntree

List of object variables and PromptSet assignments

Definition (node) of the "Values" area and of each PromptSet assignment with the following attributes:

content = Content available. Allowed values: "0" (no), "1" (yes)
id = "VALUE" (for the" Values" area) or PromptSet object name
Name = "Values" or PromptSet object name
parent = "PRPTS" (for PromptSets)
type = Identification of PromptSet ( "PROMPTSET") or value ("VALUE").

 

Structure of the "Values" area (node id="VALUE")
VALUE (The attributes state is used system internally and must not be changed):

Values: Table with object variables
Attributes per Variable definition (row):
Name = Name of the object variable
Value = Value

Mode: Inherit from parent
Allowed values: "0" (all values), "1" (only defined values) or "2" (no values)

 

Structure of PromptSet assignment definitions (node id="PRPTS"):

PROMPTSET definition with the following attributes:
client = AE client
idnr = Internal number
name = Name of the PromptSet object
ontop = Internal parameter
src = Internal parameter (source)
system = Name of the AE system

PROMPTBOX with the PromptSet element definitions and their values:
integer1: Number
combobox9: Combination field
textfield2: Text field
radiogroup1: Option field
checklist1: Check list
checkgroup1: Check box
date1:Date
timestamp1: Timestamp
time2: Time


PRE_SCRIPT

"Pre Process"

only in jobs and events (Process tab" in events)

The attribute "state" is used system-internally and must not be changed.

PSCRI

Content of the Process tab

(Process, Pre Process, Post Process)

SCRIPT

Process tab

only in executable objects

Exception: In Event objects, it is the "!Process" tab.

The attribute "state" is used system-internally and must not be changed.

MSCRI

Content of the Process tab

(Process, Pre Process, Post Process)

DOCU_Title

Documentation tab

in all objects (DOCU_Title)

The attribute "state" is used system-internally and must not be changed.

The attribute "type" shows the type of documentation:

text = normal documentation
xml = structured documentation

DOC

Content of the Documentation tab

Depending on the documentation type, the CDATA section contains the text or the XML structure.

File-System Event

Element

Description

EVNT_FILE

File System tab

in File-System Events

The attribute "state" is used system-internally and must not be changed.

HostDst
Path
FileType
Operator
Value
Unit

Attributes

HostDst: Name of an agent
Attribute: HOST

Path: Path in the file system
maximal 255 characters
Attribute: EVENT_FILE_PATH

FileType: Type of monitoring
Allowed values: "PC|PATH_FILE_COUNT", "FF|FILESYSTEM_SPACE_FREE", "PD|PATH_SPACE_USED" and "PU|PATH_SPACE_UNUSED"
Attribute: EVENT_SUB_TYPE

Operator: Comparison operand
Allowed values: "G|&gt;" (for >), "L|&lt;" (for <), "E|=" (for =), "N|&lt;&gt;" (for <>), "F|&gt;=" (for >=) and "K|&lt;=" (for <=)
Attribute: EVENT_COMP_TYPE

Value: Comparison value
Value ranging between "0" and "99999999"
EVENT_COMP_VALUE

Unit: Unit
Allowed values: "0|host specific", "1|Byte", "2|KB", "3|MB", "4|GB" and "5|TB"
Attribute: EVENT_COMP_UNIT

Console Event

BS2000

Element

Description

EVNT_CONS

"Console" Event

in Console Events

The attribute "state" is used system-internally and must not be changed.

HostDst
Std_Filter

Attributes for BS2000

HostDst: Name of the agent

STD_Filter: Message filter

z/OS

Element

Description

EVNT_CONS

"Console" Event

in Console Events

The attribute "state" is used system-internally and must not be changed.

HostDst
MVS_SysName
MVS_OSName
MVS_Filter

Attributes for z/OS

HostDst: Name of the agent

MVS_SysName: System name
maximal 8 characters

MVS_OSName: OS name
maximal 8 characters

MVS_Filter: Message filter

OS/400

Element

Description

EVNT_CONS

Attributes for OS/400

HostDst: Name of the agent

OS400_MsgType: Type of message
value ranging between "1" and "25"

OS400_Severity: Valuation
Maximal 2 characters

OS400_Filter: message filter

HostDst
OS400_MsgType
OS400_Severity
OS400_Filter

Attributes for OS/400

HostDst: Name of the agent

OS400_MsgType: Type of message
value ranging between "1" and "25"

OS400_Severity: Valuation
Maximal 2 characters

OS400_Filter: message filter

SAP

Element

Description

EVNT_CONS

"Console" Event

in Console Events

The attribute "state" is used system-internally and must not be changed.

HostDst
R3_EventSubType
R3_Filter

Attributes for SAP

HostDst: Name of the agent

R3_EventSubType: Data source

R3_Filter: event filter

Windows

Element

Description

EVNT_CONS

"Console" Event

in Console Events

The attribute "state" is used system-internally and must not be changed.

HostDst
WINDOWS_EventSubType
WINDOWS_Source
WINDOWS_Category
WINDOWS_Filter

Attributes for Windows

HostDst: Name of the agent

WINDOWS_EventSubType: Type

WINDOWS_Source: Source
maximal 32 characters

WINDOWS_Category: Category
Value ranging between "0" and "99"

WINDOWS_Filter: Message filter

Database Event

Element

Description

EVNT_DB

"Database" tab

In Database Events

Op1_type
Op2_type

Source

Source selection for value 1 and value 2.

Op1_* - Value 1
Op2_* - Value 2

Allowed values:
"STATIC" (statistical value), "VARA" (Variable) or "SQL" (SQL query)

Op1_sql
Op1_host
Op1_server
Op1_login
Op1_db
Op1_file
Op2_sql
Op2_host
Op2_server
Op2_login
Op2_db
Op2_file

Source: SQL query

Op1_* - Value 1
Op2_* - Value 2

sql - SQL
host - Host
server - Server
login - Login
db - Database
file - File name (only Microsoft Access)

Op1_keyword
Op1_vara
Op2_keyword
Op2_vara

Source: Variable

Op1_* - Value 1
Op2_* - Value 2

vara - VARA - Variable object
keyword - Key

Op1_static
Op2_static

Source: Statistical value 

Op1_static - Statistical value for value 1
Op2_static - Statistical value for value 2

 

See also:

Export File of an Event
XML File Structure for Imports and Exports

Event Types