File Transfer Attributes
The following overview includes the attributes of a File Transfer object 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.
General Page
Field |
Attribute |
Value |
Access Via: |
---|---|---|---|
Title |
OBJECT_TITLE |
User-defined, |
GET_ATT, |
Created |
USER_CREATED |
The name of the User object, |
GET_ATT, |
DATE_CREATED |
Time stamp in the format "YYYY-MM-DD HH:MM:SS" |
GET_ATT |
|
Modified |
USER_MODIFIED |
The name of the User object, |
GET_ATT, |
DATE_MODIFIED |
Time stamp in the format "YYYY-MM-DD HH:MM:SS" |
GET_ATT |
|
MODIFY_COUNT |
The number of object modifications. |
GET_ATT |
|
Last Used
|
LAST_USER |
The name of the User object, |
GET_ATT, |
LAST_DATE |
The time stamp in the format "YYYY-MM-DD HH:MM:SS" |
GET_ATT, |
|
USAGE_COUNT |
Number of object usages |
GET_ATT, |
|
Archive key 1 |
ARCHIVE_KEY1 |
User-defined, |
GET_ATT, |
Archive key 2 |
ARCHIVE_KEY2 |
User-defined, |
GET_ATT, |
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, |
GET_ATT, |
Attribute dialog |
ATTR_DLG |
"Y" - Attribute Dialog displayed |
GET_ATT |
Consumption (resources) |
RESOURCE_CONSUMPTION |
User-defined, |
GET_ATT, |
Automation Engine priority |
UC4_PRIORITY |
User-defined, |
GET_ATT, |
TimeZone |
TIMEZONE |
User-defined |
GET_ATT, |
Attribute dialog |
ATTR_DLG |
"Y" - Attribute Dialog displayed |
GET_ATT |
Generate at runtime |
GEN_AT_RUNTIME |
"Y" - Generation at runtime. |
GET_ATT |
Max. number |
MAX_PARALLEL_TASKS |
User-defined, |
GET_ATT, |
Else (for Max. number) |
MAX_PARALLEL_ELSE |
"WAIT" - Job waits until processing is possible |
GET_ATT, |
Automatically deactivate when finished |
AUTO_DEACT |
"NEVER" - Never deactivate automatically. |
GET_ATT, |
Error-free status (for After an error-free restart) |
AUTO_DEACT_DELAY |
User-defined, |
GET_ATT, |
Time delay minutes (for Always) |
AUTO_DEACT_ERROR_FREE |
Task status - limited to 20 characters |
GET_ATT, |
File Transfer Page
Field |
Attribute |
Value |
Access Via |
---|---|---|---|
From - Agent |
FT_SRC_HOST |
Name of an agent, |
GET_ATT, |
From - Code |
FT_SRC_CODE |
Name of a code table, |
GET_ATT, |
From - Login |
FT_SRC_LOGIN |
Name of a Login object, |
GET_ATT, |
Login info |
FT_SRC_LOGIN_INFO |
Entire login info of the Login object as source of the file transfer |
GET_ATT, |
Login info |
FT_SRC_ACCOUNT |
Account from the login info of the Login object as source of the file transfer |
GET_ATT, |
Login info |
FT_SRC_GROUPNAME |
Logon group from the login info of the Login object as source of the file transfer. |
GET_ATT, |
Login info |
FT_SRC_CLIENT |
Client from the login info of the Login object as source of the file transfer |
GET_ATT, |
Login info |
FT_SRC_DOMAIN |
Domain from the login info of the Login object as source of the file transfer |
GET_ATT, |
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, |
From - Compress |
FT_COMPRESS |
"NO" - no compression |
GET_ATT, |
From - File |
FT_SRC_FILE |
User-defined, |
GET_ATT, |
From - File attributes |
FT_SRC_FILE_ATTRIBUTES |
User-defined, |
GET_ATT, |
From - Use wildcards |
FT_WILDCARDS |
"Y" - Yes, |
GET_ATT, |
From - Max. parallel running transfers |
MAX_PARALLEL_TRANSFERS |
User-defined, |
GET_ATT, |
From - Include sub directories |
FT_INCLUDE_SUB_DIR |
"Y" - Yes, "N" - No |
GET_ATT, |
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 |
GET_ATT, |
From - Erase source file |
FT_ERASE_SRC_FILE |
"Y" - Yes (GET_ATT supplies "J"), |
GET_ATT, |
To - Host |
FT_DST_HOST |
Name of an agent, |
GET_ATT, |
To - Code |
FT_DST_CODE |
Name of a code table, |
GET_ATT, |
To - Login |
FT_DST_LOGIN |
Name of a Login object, |
GET_ATT, |
Login info |
FT_DST_LOGIN_INFO |
All the login info of the Login object as target of the file transfer |
GET_ATT, |
Login info |
FT_DST_ACCOUNT |
Account information from the login info of the Login object as target of the file transfer |
GET_ATT, |
Login info |
FT_DST_GROUPNAME |
Logon group from the login info of the Login object as target of the file transfer |
GET_ATT, |
Login info |
FT_DST_CLIENT |
Client from the login info of the Login object as target of the file transfer |
GET_ATT, |
Login info |
FT_DST_DOMAIN |
Domain from the login info of the Login object as target of the file transfer |
GET_ATT, |
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, |
To - File |
FT_DST_FILE |
User-defined, |
GET_ATT, |
To - File attributes |
FT_DST_FILE_ATTRIBUTES |
User-defined, |
GET_ATT, |
To - File exists |
FT_EXISTING_DST_FILE |
"A" - cancel file transfer, |
GET_ATT, |
Runtime Page
Field |
Attribute |
Value |
Access Via: |
---|---|---|---|
Return code <= |
MAX_RETCODE |
User-defined, |
GET_ATT, |
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, |
Change Program |
Mode UserInterface |
DCMODUS |
"Y" - UserInterface is active |
GET_ATT |
See also: