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

 Export-File Structure

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

JOBF

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_JOBF

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).

AttDialog

Attribute dialog

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

Attribute: ATTR_DLG

ActAtRun

Generate at runtime

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

Attribute: GEN_AT_RUNTIME

Consumption

Consumption (Resources)

User-defined,
Value between "0" and "99999"

Attribute: RESOURCE_CONSUMPTION

UC4Priority

Consumption (Resources)

User-defined,
Value between "0" and "99999"

Attribute: RESOURCE_CONSUMPTION

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

JOBF

FileTransfer tab

in FileTransfer objects

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

HostSrc
CodeNameSrc
LoginSrc
FileNameSrc
FileAttrSrc

Settings for the source host

HostSrc: Name of the agent
Attribute: FT_SRC_HOST

CodeNameSrc: Name of the CodeTable object
Attribute: FT_SRC_CODE

LoginSrc: Name of the Login object
Attributes: FT_SRC_LOGIN, FT_SRC_USERID, FT_SRC_LOGIN_INFO, FT_SRC_GROUPNAME, FT_SRC_DOMAIN, FT_SRC_CLIENT, FT_SRC_ACCOUNT,

FileNameSrc: Path and name of the file(s)
maximal 512 characters
Attribute: FT_SRC_FILE

FileAttrScr: File attributes
maximal 255 characters
Attribute: FT_SRC_FILE_ATTRIBUTES

KeepSrcAttr

Keep the original file attributes

Allowed values:
"0" - No
"1" - Yes

Compress

 

Compression

Allowed values:
"0" - No compression
"1" - Normal compression

With <Compress/>, the default value is applied.

Attribute: FT_COMPRESS

HostDst
CodeNameDst
LoginDst
FileNameDst
FileAttrDst

Settings for the target host

HostDst: Name of the agent
Attribute: FT_DST_HOST

CodeNameDst: Name of the CodeTable object
Attribute: FT_DST_CODE

LoginDst: Name of the Login object
Attributes: FT_DST_LOGIN, FT_DST_USERID, FT_DST_LOGIN_INFO, FT_DST_GROUPNAME, FT_DST_DOMAIN, FT_DST_CLIENT, FT_DST_ACCOUNT,

FileNameDst: File path(s) and name(s)
maximal 512 characters
Attribute: FT_DST_FILE

FileAttrDst: File attributes
maximal 255 characters
Attribute: FT_DST_FILE_ATTRIBUTES

WildCard
MaxParallel
RepeatType

FileTransfer with wildcard characters

WildCard: Use wildcards
Allowed values: "0" (not selected) and "1" (selected)
Attribute: FT_WILDCARDS

The following two values are only relevant if "use wildcards" was selected.

MaxParallel: Max. parallel running transfers
Value ranging between "1" and "999"
Attribute: MAX_PARALLEL_TRANSFERS

RepeatType: Include sub-directories
Allowed values: "0" (not selected) and "1" (selected)
Attribute: FT_INCLUDE_SUB_DIR

Erase

Erase source file

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

Attribute: FT_ERASE_SRC_FILE

TextTypeText
TextTypeBin

Format of the file(s)

TextTypeText: Text
TextTypeBin: Binary

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

Attribute: FT_FILE_TYPE

Only one of the two options can be selected.

OvCancel
OvOverwrite
OvAppend

Handling existing files

OvCancel: Cancel
OvOverwrite: Overwrite
OvAppend: Extend

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

Attribute: FT_EXISTING_DST_FILE

Only one of the three 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


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