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

 Export-File Structure

The table shown below describes the XML-file structure of a Workflow 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

JOBP

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.

ATTR_JOBP

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

AutoDeactNo
AutoDeact1ErrorFree
AutoDeactErrorFree
AutoDeactAlways

Deactivate automatically when finished

AutoDeactNo: No
AutoDeact1ErrorFree: After error-free end of program
AutoDeactErrorFree: After an error-free restart
AutoDeactAlways: Always

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

Attribute: AUTO_DEACT

Only one of the four options can be selected.

DeactWhen
DeactDelay

Settings for automatic deactivation

DeactWhen: Error-free status
Name of a status, maximal 20 characters (see also return codes)

This value belongs to the options error-free execution and restart (AutoDeact1ErrorFree, AutoDeactErrorFree).

Attribute: AUTO_DEACT_ERROR_FREE

 

DeactDelay: Time delay in days
Value ranging between "0" and "99"

Attribute: AUTO_DEACT_DELAY

This value belongs to the options always, error-free execution and restart (AutoDeactAlways, AutoDeact1ErrorFree, AutoDeactErrorFree).

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

ReuseHG

Re-using agent group calculation

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

Only one of these both options can be selected.

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

RWhen
RExecute

Result evaluation of the individual tasks

in Workflow and Schedule objects

Rwhen: OK status
Type of the status

RExecute: Else
Name of an executable object

JOBP

Workflow tab

in Workflow objects

The attribute "state" is used system-internally and must not be changed.
The same is true for the attribute "mode" in "JobpStruct."

task

Individual workflow tasks

Attributes per task:

Col = Column in which the task is found
Idnr =Internal number of the object (OH_IDNR)
Lnr = Run number of the task in the workflow
OType = Short form of the object type or "<START>" or "<END>"
Object = Name of the object
Row = Line in which the task is found
State = Not used
Text1 = Not used
Text2 = Short form for the legal conditions separated by "|" (P,A,W,C,S,T,R)
Text3 = Short for of the object type
Text4 = Not used
Text5 = Earliest start time or checkpoint in the format DD/HH:MM
Text6 = Not used

checkpoint

General tab

TcpADays: If start until n days is not possible
Value ranging between "0" and "99"

TcpATime: Time
Value ranging between "00:00" and "23:59"

TcpATimeTZ: TimeZone
Name of a TimeZone object

TcpExecute: Execute
Name of an executable object

TcpOn: Time checkpoint
Allowed values: "1" (checkpoint was set) and "0" (checkpoint is not used)

after

Earliest tab

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

AtimOn: Earliest start time
Allowed values: "1" (earliest start time was set) and "0" (earliest start time is not used)

ErlstStDays: Current date + n days
Value ranging between "0" and "99"

ErlstStTime: Time
Value ranging between "00:00" and "23:59"

ErlstStTimeTZ: TimeZone
Name of a TimeZone object

HoldFlg: Set breakpoint
Allowed values: "1" (selected) and "0" (not selected)

when

Dependencies tab

Settings for At the latest

WtimOn: At the latest
Allowed values: "1" (selected) and "0" (not selected)

LtstEnd: Latest end
LtstSt: Latest start

Allowed values: "1" (selected) and "0" (not selected)
Only one of the two above listed options can be selected.

LtstEndDays: End current date +  n days
Value ranging between "0" and "99"

LtstEndTime: End time
Value ranging between "00:00" and "23:59"

LtstStDays: Start current date + n days
Value ranging between "0" and "99"

LtstStTime: Start time
Value ranging between "00:00" and "23:59"

LtstTimeTZ: TimeZone
Name of a TimeZone object

Else settings

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

WElseA: Cancel
WElseH: Block
WElseS: Skip
WElseX: Block + cancel signal

Allowed values: "1" (selected) and "0" (not selected)
Only one of the four options listed above can be selected.

WhenExecute: Execute
Name of an executable object

preconditions Preconditions tab

PreCon: Condition and action definitions with the following attributes:

active = Block is activated ("1") or deactivated ("0")
id = Name of the condition or action (for example: STATUS)
once = Block is only executed once. Allowed values: "1" (once) or "0" (always)
type = Condition ("C") or action ("A")
uiinfo = Internal parameter

 

Structure of a condition and action definition:

when, else (only for conditions): Contains the definitions of conditions and actions which are executed if the condition is met or no. The same attributes are available as for "condition" and "action".

Params: Parameter of a condition or action.
Attributes per paramete definition (param):
altview = Internal parameter
name = Internal parameter name that indicates the order
type = "V" (for parameter)
value = Parameter value

predecessor

Dependencies tab

Attributes per predecessor definition (pre):

PreLnr = The run number of the predecessor.
When = The status description,

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

runtime

Runtime tab

in Workflow and Schedule objects

MrtOn: Use MRT/SRT settings of the task
Allowed values: "1" (selected) and "0" (not selected)

 

Monitoring the maximum runtime (MRT)

in Workflow and Schedule objects

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

Allowed values: "1" (selected) and "0" (not selected)
Only one of the four options listed above can be selected.

MrtFix: Time in seconds for the fixed value
Value ranging between "0" and "35999999"

MrtErt: Percentage for Ert+
Value ranging between "0" and "999"

MrtDys: Current date + n days
Value ranging between "0" and "99"

MrtTime: Current date + time
Value ranging between "00:00" and "23:59"

MrtTZ: TimeZone for the current date
Name of a TimeZone object

 

Monitoring the minimum runtime (SRT)

in Workflow and Schedule objects

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: Time in seconds for the fixed value
Value ranging between "0" and "35999999"

SrtErt: Percentage for Ert-
Value ranging between "0" and "999"

 

Else action

in Workflow and Schedule objects

MrtCancel: Cancel/end (only for MRT monitoring)
Allowed values: "1" (selected) and "0" (not selected)

MrtExecute: Execute (for 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 Workflow and Schedule objects

dyntree: Definition (node) for the four areas "Values", "Parent Values", "PromptSets", "Parent PromptSets" and each assigned PromptSet object with the attributes:

content = Content available. Allowed values: "0" (no), "1" (yes)
id = Internal name for the areas ("VALUE", "PVALUES", "PRPTS", "PPRPTS"), PromptSet object name
Name = Displayed name, PromptSet object name
parent = id of the area to which the PromptSet has been assigned. Allowed values: "PRPTS" (PromptSets) or "PPRPTS" (Parent PromptSets)
type = Identification of PromptSet ( "PROMPTSET") or value ("TASKVALUE").

 

Structure of values of parent value definitions (node id="VALUE" or "PVALUES")
VALUE (The attribute state is used system internally and must not be changed):

Values: Table with object variables
Attributes per Variable definition (row):
Mod = Variable value has been modified. Allowed values: "1" (yes) or "0" (no)
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" or "PPRPTS"):

PROMPTSET definitions with the 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

It includes the PROMPTBOX element 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

calendars

Calendar tab

in Workflow and Schedule objects

CCTypeAll: Execute if all conditions match
Allowed values: "1" (selected) and "0" (not selected)

CCTypeNone: Execute if no condition matches
Allowed values: "1" (selected) and "0" (not selected)

CCTypeOne: Execute if one condition matches
Allowed values: "1" (selected) and "0" (not selected)

Only one of the three options listed above can be selected.

CaleOn: Calendar
Allowed values: "1" (Calendar conditions are set) and "0" (Calendar is not used)

Attributes per Calendar definition (cale):

CaleKeyName = Calendar keyword
CaleName = Name of the Calendar object
id = Internal number of the Calendar object (OH_Idnr)

postconditions "Postconditions"

PostCon: Condition and action definitions with the following attributes:

active = Block is activated ("1") or deactivated ("0")
id = Name of the condition or action (for example: STATUS)
once = The block is only executed once. Allowed values: "1" (once) or "0" (always)
type =Condition ("C") or action ("A")
uiinfo = Internal parameter

 

Structure of a condition and action definition:

when, else (only for conditions): Contains the definitions of conditions and actions that are executed if the condition is met or not met. The same attributes are available as for "condition" and "action".

params: Parameters of a condition or action.
Attributes per parameter definition (param):
altview = Internal parameter
name = Internal parameter name which indicates the order.
type = "V" (for parameter)
value = Parameter value

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


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 the Workflow
XML-File Structure for Imports and Exports