User Guide > Objects > Alphabetical Listing > FileTransfer Attributes

File Transfer Attributes

The following overview includes the attributes of a FileTransfer objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task and describes their functions, allowed values and ways of modification. Attributes for the assigned login objects are described below the loginAn Automation Engine object type that stores account credentials used by agents on target systems. fields.

Predefined variables may be used in scripts, and script variables may be set to attributes retrieved via predefined variablesFixed variables that can be used in the attributes or the script of executable objects. The values refer to the object or the system..

Header Tab

Field

Attribute

Value

Access Via:

Title

OBJECT_TITLE

User-defined,
limited to 255 characters.

GET_ATT,
:PUT_ATT (Pre-Process, Process),
predefined variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type.

Created

USER_CREATED

The name of the User object,
limited to 200 characters.

GET_ATT,
predefined variable

DATE_CREATED

Time stamp in the format "YYYY-MM-DD HH:MM:SS"
If not available: "0000-00-00 00:00:00"

GET_ATT

Modified

USER_MODIFIED

The name of the User object,
limited to 200 characters.

GET_ATT,
predefined variable

DATE_MODIFIED

Time stamp in the format "YYYY-MM-DD HH:MM:SS"
If not available: "0000-00-00 00:00:00"

GET_ATT

MODIFY_COUNT

The number of object modifications.

GET_ATT

Last Used

 

LAST_USER

The name of the User object,
limited to 200 characters.

GET_ATT,
predefined variable

LAST_DATE

The time stamp in the format "YYYY-MM-DD HH:MM:SS"
If not available: "0000-00-00 00:00:00"

GET_ATT,
predefined variable

USAGE_COUNT

Number of object usages

GET_ATT,
predefined variable

Archive key 1

ARCHIVE_KEY1

User-defined,
limited to 60 characters

GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

Archive key 2

ARCHIVE_KEY2

User-defined,
limited to 20 characters

GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

 Sync Tab

Field Description Attribute Access Via:
Assigned Sync objectIt synchronizes executable objects based on defined states and actions. A particular Automation Engine object type. SYNC_OBJECT The name of a Sync object,
a maximum of 20 characters must not be exceeded.
Change Program

 Attributes Tab

Field

Attribute

Value

Access Via

Queue QUEUE Name of a queueA particular Automation Engine (AE) object type. In AE, a queue determines the maximum number of concurrent tasks, their priorities and the order in which tasks should be executed. In ARA, queues are containers for workflow executions that should be executed at a certain time one after another.,
maximum 200 characters
GET_ATT,
:PUT_ATT (process)
Change Program,
predefined variable
Group GROUP Name of a groupAn Automation Engine object type that integrates tasks so that they can be processed together.,
maximum 200 characters
" " - for immediate start
GET_ATT,
:PUT_ATT (process),
Change Program,
predefined variable

Int. account

INT_ACCOUNT, INT_ACC, K

User-defined,
maximum 16 characters

GET_ATT,
:PUT_ATT (process),
Change Program,
predefined variable

Attribute dialog

ATTR_DLG

"Y" - Attribute Dialog displayed
"N" - Attribute Dialog not displayed

GET_ATT

Consumption (resources)

RESOURCE_CONSUMPTION

User-defined,
any value between "0" and "99999".

GET_ATT,
:PUT_ATT (Pre-Process, Process),
Change Program,
predefined variable

Automation Engine priorityAffects the order of task execution within an Automation Engine system.

UC4_PRIORITY

User-defined,
any value between "0" and "255".

GET_ATT,
:PUT_ATT,
predefined variable

TimeZone

TIMEZONE

User-defined
a maximum of 8 characters must not be exceeded.

GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

Attribute dialog

ATTR_DLG

"Y" - Attribute Dialog displayed
"N" - Attribute Dialog not displayed

GET_ATT

Generate at runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start).

GEN_AT_RUNTIME

"Y" - Generation at runtime.
"N" - Generation at activation time.

GET_ATT

Max. number

MAX_PARALLEL_TASKS

User-defined,
any value between "0" and "99999".

GET_ATT,
:PUT_ATT (Pre-Process, Process),
predefined variable

Else (for Max. number)

MAX_PARALLEL_ELSE

"WAIT" - Job waits until processing is possible
"ABEND" - Job is disrupted

GET_ATT,
:PUT_ATT (Pre-Process, Process)

Automatically deactivate when finished

AUTO_DEACT

"NEVER" - Never deactivate automatically.
"ENDED_ERROR_FREE" - In the case of error-free processing, deactivate automatically.
"RESTART_ERROR_FREE" - In the case of an error-free restartA restart refers to the repetition of an object's execution. This action differs from a new start in some parts., deactivate automatically. 
"ALWAYS" - Always deactivate automatically.

GET_ATT,
:PUT_ATT

Error-free statusThis represents the condition of a task (such as active, blocked, generating). (for After an error-free restart)

AUTO_DEACT_DELAY

User-defined,
any value between "0" and "99".

GET_ATT,
:PUT_ATT

Time delay minutes (for Always)

AUTO_DEACT_ERROR_FREE

Task status,
limited to 20 characters

GET_ATT,
:PUT_ATT

File Transfer Tab

Field

Attribute

Value

Access Via

From - Host

FT_SRC_HOST

Name of an agentA program that enables the de-centralized execution of processes (such as deployments) on target systems (computers or business solutions) or a service that provides connectivity to a target system (such as for databases or middleware). An agent is also an object type in the Automation Engine. [Formerly called "Executor."] See also: host,
maximum 32 characters

GET_ATT,
:PUT_ATT (process),
Change Program,
predefined variable

From - Code

FT_SRC_CODE

Name of a code tableAn Automation Engine object type that defines a complete set of characters.,
maximum 200 characters

GET_ATT,
:PUT_ATT (process),
Change Program,
predefined variable

From - Login

FT_SRC_LOGIN

Name of a Login object,
maximum 200 characters

GET_ATT,
:PUT_ATT (process),
Change Program,
predefined variable

Login info

FT_SRC_LOGIN_INFO

Entire login info of the Login object as source of the file transferTransfers files from one computer to another. A particular Automation Engine object type (FileTransfer object).

GET_ATT,
predefined variable

Login info
(BS2000 and MPE only)

FT_SRC_ACCOUNT

Account from the login info of the Login object as source of the file transfer

GET_ATT,
predefined variable

Login info
(NSK and MPE only)

FT_SRC_GROUPNAME

Logon group from the login info of the Login object as source of the file transfer.

GET_ATT,
predefined variable

Login info
(SAP only)

FT_SRC_CLIENT

Client from the login info of the Login object as source of the file transfer

GET_ATT,
predefined variable

Login info
(Windows only)

FT_SRC_DOMAIN

Domain from the login info of the Login object as source of the file transfer

GET_ATT,
predefined variable

User ID from the Login info

FT_SRC_USERID

User ID from the login info of the Login object as source of the file transfer

GET_ATT,
predefined variable

From - Compress

FT_COMPRESS

"NO" - no compression
"NORMAL" - normal compression
"DEFAULT" - default settings

GET_ATT,
:PUT_ATT (process),
Change Program

From - File

FT_SRC_FILE

User-defined,
maximum 512 characters

GET_ATT,
:PUT_ATT (process),
Change Program,
predefined variable

From - File attributes

FT_SRC_FILE_ATTRIBUTES

User-defined,
maximum 255 characters

GET_ATT,
:PUT_ATT (process),
predefined variable

From - Use wildcards

FT_WILDCARDS

"Y" - Yes,
"N" - No

GET_ATT,
:PUT_ATT (process)

From - Max. parallel running transfers

MAX_PARALLEL_TRANSFERS

User-defined,
any value between "0" and "999"

GET_ATT,
:PUT_ATT (process),
predefined variable

From - Include sub directories

FT_INCLUDE_SUB_DIR

"Y" - Yes, "N" - No

GET_ATT,
:PUT_ATT (process)

From - Transfer complete folderTop level entities such as Environment, Deployment Target, Activity, … are stored in folders. The permissions a user has on an entity depend on the permissions that are set on the folder for the entities. structure FT_TRANSFER_FOLDERS "Y" - Yes,
"N" - No
GET_ATT,
:PUT_ATT (process)

From - Format

FT_FILE_TYPE

"T" - text file
"B" - binary file

GET_ATT,
:PUT_ATT (process)

From - Erase source file

FT_ERASE_SRC_FILE

"Y" - Yes (GET_ATT supplies "J"),
"N" - No

GET_ATT,
:PUT_ATT (process)

To - Host

FT_DST_HOST

Name of an agent,
maximum 32 characters

GET_ATT,
:PUT_ATT (process),
Change Program,
predefined variable

To - Code

FT_DST_CODE

Name of a code table,
maximum 200 characters

GET_ATT,
:PUT_ATT (process),
Change Program,
predefined variable

To - Login

FT_DST_LOGIN

Name of a Login object,
maximum 200 characters

GET_ATT,
:PUT_ATT (process),
Change Program,
predefined variable

Login info

FT_DST_LOGIN_INFO

All the login info of the Login object as target of the file transfer

GET_ATT,
predefined variable

Login info
(BS2000 and MPE only)

FT_DST_ACCOUNT

Account information from the login info of the Login object as target of the file transfer

GET_ATT,
predefined variable

Login info
(NSK and MPE only)

FT_DST_GROUPNAME

Logon group from the login info of the Login object as target of the file transfer

GET_ATT,
predefined variable

Login info
(SAP only)

FT_DST_CLIENT

Client from the login info of the Login object as target of the file transfer

GET_ATT,
predefined variable

Login info
(Windows only)

FT_DST_DOMAIN

Domain from the login info of the Login object  as target of the file transfer

GET_ATT,
predefined variable

User ID from the Login info

FT_DST_USERID

User ID from the login info of the Login object as target of the file transfer

GET_ATT,
predefined variable

To - File

FT_DST_FILE

User-defined,
maximum 512 characters

GET_ATT,
:PUT_ATT (process),
Change Program,
predefined variable

To - File attributes

FT_DST_FILE_ATTRIBUTES

User-defined,
maximum 255 characters

GET_ATT,
:PUT_ATT (process),
predefined variable

To - File exists

FT_EXISTING_DST_FILE

"A" - cancel file transfer,
"O" - overwrite file,
"E" - append to file

GET_ATT,
:PUT_ATT (process)

Runtime Tab

Field

Attribute

Value

Access Via:

Return code <=

MAX_RETCODE

User-defined,
limited to 11 numbers.

GET_ATT,
:PUT_ATT (Pre-Process, Process)

Process Tab

Field

Attribute

Value

Access Via:

The string in the Process tab of the jobAn Automation Engine object type for a process that runs on a target system. should be changed.

SCRIPT

 

Change Program

Output Scan Tab

Field

Attribute

Value

Access Via:

Action - Output filter PPF_FILTER The name of a Filter object,
limited to 200 characters.
Change Program
Action - Execute PPF_EXECUTE The name of an executable object,
limited to 200 characters.
Change Program
Pass down to dynamic children PPF_INHERITANCE "Y" - Yes
"N" - No
"C" - Children only
Change Program
Override hostComputer, target system. for FileScan (optional) - Host FSC_HOST The name of an agent,
limited to 32 characters.
GET_ATT,
:PUT_ATT (Pre-Process, Process),
Change Program,
predefined variable
Override host for FileScan (optional) - Login FSC_LOGIN The name of a Login object,
limited to 200 characters
GET_ATT,
:PUT_ATT (Pre-Process, Process),
Change Program,
predefined variable

File Transfer Attributes Not on a Tab

Field

Attribute

Value

Access Via:

Object name

OBJECT_NAME

User-defined,
limited to 200 characters.

Change Program

Mode UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."]

DCMODUS

"Y" - UserInterface is active
"N" - No UserInterface is active

GET_ATT

 

Also see:

FileTransfer
Attributes

:PUT_ATT

GET_ATT
function

AE DB Change

 


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

Copyright © 2016 Automic Software GmbH