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

 Export-File Structure

The table shown below describes the XML-file structure of a Notification objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task and explains the individual elements.


Element

Description

uc-export

Main element of the export file

clientvers = Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. version in which the export file was created

CALL

Main element of the object

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. = 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 "stateThe state a package or a task currently is in." 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 objectIt synchronizes executable objects based on defined states and actions. A particular Automation Engine object type. definition (row):

Abend = Action when the taskAn executable object that is running. Tasks are also referred to as activities. is canceled
Else = Else actionActions are predefined building blocks for recurring activities. They are commonly used for managing third party systems or in deployment scenarios. [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.

ATTR_CALL

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 groupAn Automation Engine object type that integrates tasks so that they can be processed together.,
maximal 20 characters,
" " - immediate start

Attribute: START_TYPE

IntAccount

Internal account

User-defined,
maximal 16 characters

Attribute: INT_ACCOUNT, INT_ACC or K

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

UC4Priority

AE priority

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

Attribute: UC4_PRIORITY

Priority

Notification priority

Allowed values: "1|high", "2|normal", "3|low"

Attribute: CO_PRIORITY

Type

Notification type

Allowed values: "0|request", "1|message", "2|alert", 3|E-Mail

Attribute: CO_TYPE

ActAtRun

Generate at runtime

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

Attribute: GEN_AT_RUNTIME

TZ

TimeZone

Name of a TimeZone object,
maximal 8 characters

Attribute: TIMEZONE

EscTime

Escalation after n minutes

Time in minutes
Value ranging between "0" and "9999"

Attribute: CO_RISING_TIME

Object

Notification in escalation

Name of a Notification object

Attribute: CO_RISING_NAME

AutoDeact

Quit automatically

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

External1

SNMP connection

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

Attribute: CO_SNMP

External2

Send email

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

Attribute: CO_EMAIL

NOTIFICATION

Notification tab 

in all Notification objects

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

Subject

Message subject

User defined,
max. 255 characters

Text

Message text

User-defined,
maximal 1024 characters

Attribute: CALL_TEXT

AttachReports

Attach reports to email

RunIDShort 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 an object or name of an object variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. which contains a RunID,
max. 32 characters

AttachFile

Attach file to email

Path and file name of the file to be sent,
max. 255 characters

CALL

Recipients tab

in Notification objects

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

Cond

List of operators

Attributes per operator definition (row):

CaleKeyName = Calendar keyword
CaleName = Calendar object
USR_Idnr = User object or User-group object
id = Internal number of the Calendar object (OH_Idnr)

Attribute: OPERATOR

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 codeThe value that represents the result of tasks and script functions.|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
parentThere are different ways of activating objects. The originator of an activation is referred to as the superordinate task (parent). See also: Child; Children = "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 variablesPlaceholder for values that are stored in an object's "Variables & Prompts" tab/section.
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 elementFields/control elements that are used to query User values. They are the content of a PromptSet input mask. definitions and their values:
integer1: Number
combobox9: Combination field
textfield2: Text field
radiogroup1: Option field
checklist1: Check listShows entities in a grid view
checkgroup1: Check box
date1:Date
timestamp1: Timestamp
time2: Time


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.

 

See also:

Export file of a Notification
XML-File Structure for Imports and Exports

 


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

Copyright © 2016 Automic Software GmbH