File Transfer Attributes

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

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

General Page

Field

Attribute

Value

Access Via:

Title

OBJECT_TITLE

User-defined,
limited to 255 characters.

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

Created

USER_CREATED

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

GET_ATT,
predefined variable

DATE_CREATED

Timestamp 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

Timestamp 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 Executed

 

LAST_USER

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

GET_ATT,
predefined variable

LAST_DATE

The timestamp 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

Int. Account

INT_ACCOUNT, INT_ACC, K

User-defined,
limited to 16 characters.

GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

Sync Page

Field Description Attribute Access Via:
Assigned Sync object SYNC_OBJECT The name of a Sync object,
a maximum of 20 characters must not be exceeded.		 Change Program

Attributes Page

Field

Attribute

Value

Access Via
Queue QUEUE Name of a queue, maximum 200 characters GET_ATT,
:PUT_ATT (process)
Change Program,
predefined variable
Group GROUP Name of a group, 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 Consume <x> resources

RESOURCE_CONSUMPTION

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

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

Automation Engine priority

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 runtime

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 restart, deactivate automatically. 
"ALWAYS" - Always deactivate automatically.

GET_ATT,
:PUT_ATT

Error-free status (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

For more information, see System Return Codes of Executable Objects.

GET_ATT,
:PUT_ATT

File Transfer Page

Field

Attribute

Value

Access Via

From - Agent

FT_SRC_HOST

Name of an agent,
maximum 32 characters

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

From - Code

FT_SRC_CODE

Name of a code table,
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 transfer

GET_ATT,
predefined variable

Login info
(BS2000 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 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 - Include sub directories

FT_INCLUDE_SUB_DIR

"Y" - Yes, "N" - No

GET_ATT,
:PUT_ATT (process)
From - Transfer complete folder 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 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 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 Page

Field

Attribute

Value

Access Via:

Return code <=

MAX_RETCODE

User-defined,
limited to 11 numbers.

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

Field

Attribute

Value

Access Via:
The string in the Process tab of the job should be changed.

SCRIPT

Change Program

Output Scan Page

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 host 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 Page

Field

Attribute

Value

Access Via:

Object name

OBJECT_NAME

User-defined,
limited to 200 characters.

Change Program

Automic Web Interface Mode

DCMODUS

"Y" - The Automic Web Interface is active
"N" - No Automic Web Interface is active

GET_ATT

See also: