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

 Export File Structure

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

VARA

Main element of the object

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

HEADER

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

ATTR_VARA

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.

Type

Data type

Allowed values:

"C|String"
"F|Number"
"T|Timestamp"
"TI|Time"
"D|Date"

VRName

Scope

Allowed values:

"*|No scope"
"FREI|Freely selected"
"HON|Host - each host name"
"JBN|Task - each task name"
"JPN|Workflow name - each workflow name"
"JPS|Workflow session - each workflow activation"
"USN|User - each user nameName of the Automation Engine user."
"USS|User session - each user session"

NotFoundErr
NotFoundDef

Not found

NotFoundErr: Error
NotFoundDef: Initial values

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

Only one of the two options can be selected.

ShareN
ShareL
ShareR

Variable type

ShareN: Not shareable
ShareL: Read only
ShareR: Referenceable

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

Only one of the two options can be selected. All options are set to "0" if the variable cannot be found in the system client 0000.

VARA

Variable tab

in Variable objects

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

Variables

List of Variable contents

Attributes per content definition (row):

Name = Key
Value = Value 1
Value1 = Value 2
Value2 = Value 3
Value3 = Value 4
Value4 = Value 5

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.

Source: EXEC

Element

Description

EXEC

"Variable" tab

in Variable objects using the setting "Source" - "EXEC" ("Attributes" tab).

ExecObject

Executable Object

Name of the executabe object

VaraResult

Result variable

The variable name defined in the executable object.

Parameters

Parameters

The names of the script variables used in the executable object that returns the values.

Source: SQL

Element

Description

SQL

"Variable" tab

in Variable objects using the setting "Source" - "SQL" ("Attributes" tab).

Conn

Connection

Name of a CONN object of type "Database".

Login

Login

Name of a Login object for accessing the external databaseA database is an organized collection of data including relevant data structures..

prefUserConn

Apply User's Connection

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

With this option being selected, the connection data will be retrieved from the CONN object which has been selected in the User object.

prefUserLogin

Apply User's Login 

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

With this option being activated, the Login object which is available in the User object is used for accessing the database.

sql

SQL statement

SQL commands to be processed on the destination database.

resultformat

Result Format

Formatting of the Result column in dynamic variables (SQL, SQL internal, Multi).
The following placeholders can be used for the content of the value column: {Column number}

Source: SQL Internal

Element

Description

SQL_INTERN

SQL statement

SQL commands to be processed on the AE database. Commands are specified by database type.

command.sql
command.ora
command.db2
command.db2zos

SQL statement

SQL commands to be processed on the AE database. Commands are specified by database type.

resultformat

Result Format

Formatting of the Result column in dynamic variables (SQL, SQL internal, Multi).
The following placeholders can be used for the content of the value column: {Column number}

Source: Multi

Element

Description

SQL_MULTI

"Variable" tab

in Variable objects using the setting "Source" - "Multi"

Vara1
Vara2

Variable 1 and 2

Names of the Variable objects which serve as value source.

resultformat

Result Format

Formatting of the Result column in dynamic variables (SQL, SQL internal, Multi).
The following placeholders can be used for the content of the value column: {Column number}

union
intersection
minus

Operation

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

You can only select one of the provided three options.

Source: Filelist

Element

Description

SQL_FILELIST

 

 Variable tab

Variable objects using the setting "Source" - "Filelist"

directory

Directory

Path and file filter for retrieving the file names.

HostDst

Host

Name of an OS agent.

Login

Login

Name of the Login object which includes the host's login data.

preferUserHost

Apply task's host

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

With this option being activated, the agent of the task is used which accesses the Variable object.

preferUserLogin

Apply task's Login

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

With this option being activated, the Login object of the task is used which accesses the Variable.

Source: XML

Element

Description

XML

"Variable" tab

in Variable objects using the setting "Source" - "XML" ("Attributes" tab).

Parameters Name = The key that has been entered for the XML data structure in the static Variable object XML.
Value = The value(s) of the XML data entered in the value column of the VARA.XML

 

See also:

Export File of a Variable
XML File Structure for Imports and Exports