File Transfer Attributes

The following overview includes the attributes of File Transfer objects and describes their functions, allowed values and ways of modification.

Predefined variables may be used in scripts, and script variables may be set to attributes retrieved via predefined variables.

This page includes the following:

General Page

Title

OBJECT_TITLE

Value: User-defined

Length: 255 characters

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

Active

OH_Inactive

Access through: Change Program

Created by

USER_CREATED

Value: Name of the User object

Length: Max. 200 characters

Access through: GET_ATT, predefined variable

DATE_CREATED

Value: Timestamp

Format: YYYY-MM-DD HH:MM:SS. If not available, 0000-00-00 00:00:00

Access through: GET_ATT

Modified by

USER_MODIFIED

Value: Name of the User object

Length: 200 characters

Access through: GET_ATT, predefined variable

DATE_MODIFIED

Value: Timestamp

Format: YYYY-MM-DD HH:MM:SS. If not available, 0000-00-00 00:00:00

Access through: GET_ATT

MODIFY_COUNT

Value: Number of object modifications

Access through:GET_ATT

Last Executed

LAST_USER

Value: Name of the User object

Length: 200 characters

Access through: GET_ATT, predefined variable

LAST_DATE

Value: Timestamp

Format: YYYY-MM-DD HH:MM:SS. If not available, 0000-00-00 00:00:00

Access through: GET_ATT, predefined variable

USAGE_COUNT

Value: Number of object usages

Access through: GET_ATT, predefined variable

Archive Key 1

ARCHIVE_KEY1

Value: User-defined

Length: 60 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Archive Key 2

ARCHIVE_KEY2

Value: User-defined

Length: 20 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Int. Account

INT_ACCOUNT, INT_ACC, K

Value: User-defined

Length:16 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Sync Page

Sync Object

SYNC_OBJECT

Value: Name of the Sync object

Length: 20 characters

Access via: Change Program

Attributes Page

Queue

QUEUE

Value: Name of a Queue

Length: Max. 200 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Group

GROUP

Value: Name of a Group

Length: Max. 200 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Int. Account

INT_ACCOUNT, INT_ACC, K

Value: User-defined

Length: Max. 16 characters

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

Consume <x> resources

RESOURCE_CONSUMPTION

Value: User-defined

Length: A value between 0 and 99999

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

Automation Engine priority

UC4_PRIORITY

Value: User-defined

Length: A value betwen 0 and 255

Access through: GET_ATT, :PUT_ATT, predefined variable

TimeZone

TIMEZONE

Value: Nmae of a Time Zone object

Length: Max. 8 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Attribute Dialog

ATTR_DLG

Value: Y (dialog is displayed) / N

Access through: GET_ATT

Generate Task at: Runtime

GEN_AT_RUNTIME

Value: Y / N

Access through: GET_ATT

Allow <x> simultaneous executions

MAX_PARALLEL_TASKS

Value: User-defined

Length: Any value between 0 and 99999

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

Remaining Tasks (for simultaneous executions)

MAX_PARALLEL_ELSE

Value: WAIT (Script waits until processing is possible) / ABEND

Access through: GET_ATT, :PUT_ATT (Pre-Process, Process)

Automatically deactivate when finished

AUTO_DEACT

Value:

NEVER:
ENDED_ERROR_FREE
RESTART_ERROR_FREE
ALWAYS

Access through: GET_ATT, :PUT_ATT

Time delay minutes (for Always)

AUTO_DEACT_DELAY

Value: User-defined

Length: Any value between 0 and 99

Access through: GET_ATT, :PUT_ATT

Error-free status (for After an error-free restart)

AUTO_DEACT_ERROR_FREE

Value: Task status (System Return Codes of Executable Objects)

Length: Max. 20 characters

Access through: GET_ATT, :PUT_ATT

File Transfer Page

Source Settings - Agent

FT_SRC_HOST

Value: Name of an Agent

Length: Max. 32 characters

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

Source Settings - Login

FT_SRC_LOGIN

Value: Name of a Login object

Length: Max. 200 characters

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

Source Settings - Code

FT_SRC_CODE

Value: Name of a Code Table object

Length: Max. 200 characters

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

Source Settings - Login Info

FT_SRC_LOGIN_INFO

Value: Entire login information of the Login object as source of the file transfer

Access through: GET_ATT, predefined variable

Source Settings - Login Info (BS2000 only)

FT_SRC_ACCOUNT

Value: Account from the Login information (Login object) as source of the file transfer

Access through: GET_ATT, predefined variable

Source Settings - Login Info (NSK only)

FT_SRC_GROUPNAME

Value: Logon group from the login information (Login object) as source of the file transfer

Access through: GET_ATT, predefined variable

Source Settings - Login Info (SAP only)

FT_SRC_CLIENT

Value: Client from the login information (Login object) as source of the file transfer

Access through: GET_ATT, predefined variable

Source Settings - Login Info (Windows only)

FT_SRC_DOMAIN

Value: Domain from the login information (Login object) as source of the file transfer

Access through: GET_ATT, predefined variable

Source Settings - User ID from the Login info

FT_SRC_USERID

Value: User ID from the login information (Login object) as source of the file transfer

Access through: GET_ATT, predefined variable

Source Settings - File

FT_SRC_FILE

Value: User-defined

Length: Max. 512 characters

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

Source Settings - File Attributes

FT_SRC_FILE_ATTRIBUTES

Value: User-defined

Length: 255 characters

Access through: GET_ATT, :PUT_ATT (process), predefined variable

Transfer Settings - File Format

FT_FILE_TYPE

Value: T (text) / B (binary)

Access through: GET_ATT, :PUT_ATT (process)

Transfer Settings - Compression

FT_COMPRESS

Value:

N (No compression)
Y
Default value

Access through: GET_ATT, :PUT_ATT (process), Change Program

Transfer Settings - Use wildcards

FT_WILDCARDS

Value: Y / N

Access through: GET_ATT, :PUT_ATT (process)

Transfer Settings - Include Sub Directories

FT_INCLUDE_SUB_DIR

Value: Y / N

Access through: GET_ATT, :PUT_ATT (process)

Transfer Settings - Transfer Complete Folder Structure

FT_TRANSFER_FOLDERS

Value: Y / N

Access through: GET_ATT, :PUT_ATT (process)

Transfer Settings - Erase source file

FT_ERASE_SRC_FILE

Value: Y (GET_ATT supplies J) / N

Access through: GET_ATT, :PUT_ATT (process)

Destination Settings - Agent

FT_DST_HOST

Value: Name of an Agent

Length: Max. 32 characters

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

Destination Settings - Login

FT_DST_LOGIN

Value: Name of a Login object

Length: Max. 200 characters

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

Destination Settings - Code

FT_DST_CODE

Value: Name of a Code Table object

Length: Max. 200 characters

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

Destination Settings - Login Info

FT_DST_LOGIN_INFO

Value: Entire login information of the Login object as target of the file transfer

Access through: GET_ATT, predefined variable

Destination Login Info (BS2000 only)

FT_DST_ACCOUNT

Value: Account information from the Login object as target of the file transfer

Access through: GET_ATT, predefined variable

Destination Settings - Login Info (NSK only)

FT_DST_GROUPNAME

Value: Logon group information from the Login object as target of the file transfer

Access through: GET_ATT, predefined variable

Destination Settings - Login Info (SAP only)

FT_DST_CLIENT

Value: Client information from the Login object as target of the file transfer

Access through: GET_ATT, predefined variable

Destination Settings - Login Info (Windows only)

FT_DST_DOMAIN

Value: Domain information from the Login object as target of the file transfer

Access through: GET_ATT, predefined variable

Destination Settings - User ID from the Login info

FT_DST_USERID

Value: User ID from the Login object as target of the file transfer

Access through: GET_ATT, predefined variable

Destination Settings - File

FT_DST_FILE

Value: User-defined

Length: Max. 512 characters

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

Destination Settings - File Attributes

FT_DST_FILE_ATTRIBUTES

Value: User-defined

Length: Max. 255 characters

Access through: GET_ATT, :PUT_ATT (process), predefined variable

Note. If the destination Agent is a VMS agent, you can use the attributes that are listed in VMS Agent - File Transfer Support.

Destination Settings - File Exists

FT_EXISTING_DST_FILE

Value:

A (Cancel transfer)
O (Overwrite file)
E (Append to file)

Access through: GET_ATT, :PUT_ATT (process)

Runtime Page

Return code <=

MAX_RETCODE

Value: User-defined

Length: 10 characters

Access via: GET_ATT, :PUT_ATT (Pre-Process, Process)

Note: The status of the file transfer does not affect its return code. If, for any reason, a file transfer fails, the return code is still 0.

Process Page

Code on the Process Page

SCRIPT

Changes the code on the Process page

Access through: Change Program

Post Process Page

Code on the Post Process Page

Changes the code on the Post Process page

OSCRIPT

Access through: Change Program

Output-Scan Page

Filter Object

PPF_FILTER

Value: Name of the Filter object

Length: 200 characters

Access through: Change Program

Action - Execute

PPF_EXECUTE

Value: Name of an executable object

Length: 200 characters

Access through: Change Program

PPF_INHERITANCE

Inherit to dynamic child tasks

Values:

Y - Yes
N - No
C - Children only

Access through: Change Program

Override Agent for File Scan: Agent

FSC_HOST

Value: Name of the Agent

Length: 32 characters

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

Override Agent for File Scan: Login

FSC_LOGIN

Value: Name of the Login object

Length: 200 characters

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