Overview
The File Transfer task allows you to execute file transfers on remote machines using any of the following protocols:
- FTP
- SFTP
- UDM
- FTPS
To run a File Transfer task, you need Universal Agent for Linux/Unix, z/OS, or Windows to communicate with the File Transfer server. The Agent can, but does not have to be, running on the same machine as the File Transfer server.
The following examples provide sample configurations for executing file transfers using a File Transfer task.
In the first example, the user wants to transfer a file from a remote File Transfer Server on a machine that does not have an Agent running on it. In this case, the File Transfer task definition provides an address and login credentials for the machine where the Agent is running as well as address and login credentials for the machine where the File Transfer server is running.
In the second example, the user wants to transfer a file from a remote File Transfer Server on a z/OS machine that does have an Agent running on it. In this case, the login credentials for the Agent machine and the File Transfer server machine are the same.
Built-In Variables
The following built-in variables can be used in a File Transfer task to pass data where appropriate:
Creating a File Transfer Task
Step 1 | From the Automation Center navigation pane, select Tasks > File Transfer Tasks. The File Transfer Tasks list displays a list of all currently defined File Transfer tasks. |
|---|---|
Step 2 | Enter/select Details for a new File Transfer task, using the field descriptions below as a guide.
|
Step 3 | Click a Save button. The task is added to the database, and all buttons and tabs in the Task Details are enabled. |
Note
To open an existing record on the list, either:
- Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
- Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
- Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).
File Transfer Protocols
When you create a File Transfer task, you select a file transfer protocol: FTP, SFTP, UDM, or FTPS.
The File Transfer Task Exclude Protocols Universal Controller system property permits the exclusion of one or more, but not all, protocols from being selected (see the File Transfer Task#Transfer Protocol field, below.)
The order of precedence for selecting a default File Transfer Task#Transfer Protocol for a File Transfer task is UDM, SFTP, FTPS, FTP. The first of these protocols that is not specified in the File Transfer Task Exclude Protocols system property will be the default.
For example:.
- If File Transfer Task Exclude Protocols = UDM, the default Transfer Protocol will be SFTP.
- If File Transfer Task Exclude Protocols = UDM and SFTP, the default Transfer Protocol will be FTPS.
File Transfer Protocols Details
The Details for FTP, SFTP, and FTPS transfer protocols are the same; the Details for the UDM transfer protocol differs considerably.
Using SFTP requires that you supply a valid credential that specifies the location of the SSL/TLS Private key on your Agent. In the Credentials Details, you supply the location for the private key in the field "Key Location (File Transfer only)". This location must exist on the Agent where you intend to run the SFTP task.
Make sure you have your private/public keys properly set up and working before you configure the Controller to use it. For example, to validate the keys, log into your destination server from your agent server using ssh.
FTP/SFTP/FTPS File Transfer Task Details
The following FTP/SFTP/FTPS File Transfer Task Details is for an existing FTP/SFTP/FTPS File Transfer task.
Depending on the values that you enter / select for these fields, and whether or not the FTP/SFTP/FTPS File Transfer task has ever been launched, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the FTP/SFTP/FTPS File Transfer Task Details.
FTP/SFTP/FTPS File Transfer Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in FTP/SFTP/FTPS File Transfer Task Details.
Field Name | Description |
|---|---|
General | This section contains general information about the task. |
Name | Unable to render {include} The included page could not be found. |
Version | Unable to render {include} The included page could not be found. |
Description | Unable to render {include} The included page could not be found. |
Member of Business Services | Unable to render {include} The included page could not be found. |
Resolve Name Immediately | Unable to render {include} The included page could not be found. |
Time Zone Preference | Unable to render {include} The included page could not be found. |
Hold on Start | Unable to render {include} The included page could not be found. |
Hold Reason | Unable to render {include} The included page could not be found. |
Virtual Resource Priority | Unable to render {include} The included page could not be found. |
Hold Resources on Failure | Unable to render {include} The included page could not be found. |
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
Cluster | Unable to render {include} The included page could not be found. |
Agent | Unable to render {include} The included page could not be found. |
Agent Variable | Unable to render {include} The included page could not be found. |
Agent Cluster | Unable to render {include} The included page could not be found. |
Agent Cluster Variable | Unable to render {include} The included page could not be found. |
Broadcast | Unable to render {include} The included page could not be found. |
Cluster Broadcast | Unable to render {include} The included page could not be found. |
Cluster Broadcast Variable | Unable to render {include} The included page could not be found. |
Credentials | Unable to render {include} The included page could not be found. |
Credentials Variable | Unable to render {include} The included page could not be found. |
File Transfer Details | This section contains assorted detailed information about the task. |
Transfer Protocol | Unable to render {include} The included page could not be found. |
Command | Unable to render {include} The included page could not be found. |
Job Card (z/OS only) | Unable to render {include} The included page could not be found. |
Subcommands (z/OS only) | Unable to render {include} The included page could not be found. |
Transfer Type | Unable to render {include} The included page could not be found. |
Transfer Mode | Unable to render {include} The included page could not be found. |
Remote Server | Required if File Transfer Task#Transfer Protocol = FTP, SFTP or FTPS; name or IP address of the File Transfer server. This machine may or may not be the same as the Agent machine. |
FTP Credentials | Unable to render {include} The included page could not be found. |
FTP Credentials Variable | Unable to render {include} The included page could not be found. |
Local Filename | Unable to render {include} The included page could not be found. |
Use Regular Expression | Enables the use of a regular expression in the File Transfer Task#Local Filename field. |
Remote Filename | Unable to render {include} The included page could not be found. |
Move | Unable to render {include} The included page could not be found. |
Retry Options | This section contains specifications for retrying the task. |
Maximum Retries | Unable to render {include} The included page could not be found. |
Retry Indefinitely | Unable to render {include} The included page could not be found. |
Retry Interval (Seconds) | Unable to render {include} The included page could not be found. |
Suppress Intermediate Failures | Unable to render {include} The included page could not be found. |
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. |
Wait To Start | Unable to render {include} The included page could not be found. |
Wait Time | Unable to render {include} The included page could not be found. |
Wait Day Constraint | Unable to render {include} The included page could not be found. |
Wait Duration | Unable to render {include} The included page could not be found. |
Wait Duration In Seconds | Unable to render {include} The included page could not be found. |
Delay On Start | Unable to render {include} The included page could not be found. |
Delay Duration | Unable to render {include} The included page could not be found. |
Delay Duration In Seconds | Unable to render {include} The included page could not be found. |
Workflow Only | Unable to render {include} The included page could not be found. |
Time Options | This section contains time-related specifications for the task. |
Late Start | Unable to render {include} The included page could not be found. |
Late Start Type | Unable to render {include} The included page could not be found. |
Late Start Time | Unable to render {include} The included page could not be found. |
Late Start Day Constraint | Unable to render {include} The included page could not be found. |
Late Start Nth Amount | Unable to render {include} The included page could not be found. |
Late Start Duration | Unable to render {include} The included page could not be found. |
Late Finish | Unable to render {include} The included page could not be found. |
Late Finish Type | Unable to render {include} The included page could not be found. |
Late Finish Offset Type | Unable to render {include} The included page could not be found. |
Late Finish Percentage Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Late Finish Time | Unable to render {include} The included page could not be found. |
Late Finish Day Constraint | Unable to render {include} The included page could not be found. |
Late Finish Nth Amount | Unable to render {include} The included page could not be found. |
Late Finish Duration | Unable to render {include} The included page could not be found. |
Early Finish | Unable to render {include} The included page could not be found. |
Early Finish Type | Unable to render {include} The included page could not be found. |
Early Finish Offset Type | Unable to render {include} The included page could not be found. |
Early Finish Percentage Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Early Finish Time | Unable to render {include} The included page could not be found. |
Early Finish Day Constraint | Unable to render {include} The included page could not be found. |
Early Finish Nth Amount | Unable to render {include} The included page could not be found. |
Early Finish Duration | Unable to render {include} The included page could not be found. |
User Estimated Duration | Unable to render {include} The included page could not be found. |
Critical Path Options | This section contains Critical Path-related specifications for the task. |
CP Duration | Unable to render {include} The included page could not be found. |
CP Duration (Resolved) | Unable to render {include} The included page could not be found. |
CP Duration Unit | Unable to render {include} The included page could not be found. |
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. |
Execution Restriction | Unable to render {include} The included page could not be found. |
Restriction Period | Unable to render {include} The included page could not be found. |
Before Date | Unable to render {include} The included page could not be found. |
Before Time | Unable to render {include} The included page could not be found. |
After Date | Unable to render {include} The included page could not be found. |
After Time | Unable to render {include} The included page could not be found. |
Date List | Unable to render {include} The included page could not be found. |
Statistics | This section contains time-related statistics for task instances of the task. |
| First Execution | Unable to render {include} The included page could not be found. |
Last Execution | Unable to render {include} The included page could not be found. |
Last Instance Duration | Unable to render {include} The included page could not be found. |
Lowest Instance Time | Unable to render {include} The included page could not be found. |
Average Instance Time | Unable to render {include} The included page could not be found. |
Highest Instance Time | Unable to render {include} The included page could not be found. |
Number of Instances | Unable to render {include} The included page could not be found. |
Metadata | This section contains Metadata information about this record. |
UUID | Universally Unique Identifier of this record. |
Updated By | Name of the user that last updated this record. |
Updated | Date and time that this record was last updated. |
Created By | Name of the user that created this record. |
Created | Date and time that this record was created. |
Buttons | This section identifies the buttons displayed above and below the Task Details that let you perform various actions. |
Save | Saves a new task record in the Controller database. |
Save & New | Saves a new record in the Controller database and redisplays empty Details so that you can create another new record. |
Save & View | Saves a new record in the Controller database and continues to display that record. |
New | Displays empty (except for default values) Details for creating a new task. |
Update | Unable to render {include} The included page could not be found. |
Launch Task | Unable to render {include} The included page could not be found. |
View Parents | Unable to render {include} The included page could not be found. |
Copy | Creates a copy of this task, which you are prompted to rename. |
Delete | Unable to render {include} The included page could not be found. Note You cannot delete a task if it is either:
|
Refresh | Refreshes any dynamic data displayed in the Details. |
Close | For pop-up view only; closes the pop-up view of this task. |
Tabs | This section identifies the tabs across the top of the Task Details that provide access to additional information about the task. |
Variables | Unable to render {include} The included page could not be found. |
Actions | Unable to render {include} The included page could not be found. |
Virtual Resources | Unable to render {include} The included page could not be found. |
Mutually Exclusive | Unable to render {include} The included page could not be found. |
Instances | Lists all instances of the task. |
Triggers | Unable to render {include} The included page could not be found. |
Notes | Unable to render {include} The included page could not be found. |
Versions | Unable to render {include} The included page could not be found. |
UDM File Transfer Task Details
The following UDM File Transfer Task Details is for an existing UDM File Transfer task.
Depending on the values that you enter / select for these fields, and whether or not the UDM File Transfer task has ever been launched, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the UDM File Transfer Task Details.
UDM File Transfer Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in UDM File Transfer Task Details.
Field Name | Description |
|---|---|
General | This section contains general information about the task. |
Name | Unable to render {include} The included page could not be found. |
Version | Unable to render {include} The included page could not be found. |
Description | Unable to render {include} The included page could not be found. |
Member of Business Services | Unable to render {include} The included page could not be found. |
Resolve Name Immediately | Unable to render {include} The included page could not be found. |
Time Zone Preference | Unable to render {include} The included page could not be found. |
Hold on Start | Unable to render {include} The included page could not be found. |
Hold Reason | Unable to render {include} The included page could not be found. |
Virtual Resource Priority | Unable to render {include} The included page could not be found. |
Hold Resources on Failure | Unable to render {include} The included page could not be found. |
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
Cluster | Unable to render {include} The included page could not be found. |
Utility Agent | Unable to render {include} The included page could not be found. |
Utility Agent Variable | Unable to render {include} The included page could not be found. |
Utility Agent Cluster | Unable to render {include} The included page could not be found. |
Utility Agent Cluster Variable | Unable to render {include} The included page could not be found. |
Broadcast | Unable to render {include} The included page could not be found. |
Utility Cluster Broadcast | Unable to render {include} The included page could not be found. |
Utility Cluster Broadcast Variable | Unable to render {include} The included page could not be found. |
Utility Credentials | Unable to render {include} The included page could not be found. |
Utility Credentials Variable | Unable to render {include} The included page could not be found. |
File Transfer Details | This section contains assorted detailed information about the task. |
Transfer Protocol | Unable to render {include} The included page could not be found. |
Primary UDM Agent Option | Unable to render {include} The included page could not be found. |
Secondary UDM Agent Option | Unable to render {include} The included page could not be found. |
Primary UDM Agent | Unable to render {include} The included page could not be found. |
Secondary UDM Agent | Unable to render {include} The included page could not be found. |
Primary UDM Agent Variable | Unable to render {include} The included page could not be found. |
Secondary UDM Agent Variable | Unable to render {include} The included page could not be found. |
Primary UDM Agent Cluster | Unable to render {include} The included page could not be found. |
Primary UDM Agent Cluster Variable | Unable to render {include} The included page could not be found. |
Secondary UDM Agent Cluster | Unable to render {include} The included page could not be found. |
Secondary UDM Agent Cluster Variable | Unable to render {include} The included page could not be found. |
Primary Credentials | Unable to render {include} The included page could not be found. |
Secondary Credentials | Unable to render {include} The included page could not be found. |
Primary Credentials Variable | Unable to render {include} The included page could not be found. |
Secondary Credentials Variable | Unable to render {include} The included page could not be found. |
Form or Script | Unable to render {include} The included page could not be found. |
Transfer Type | Unable to render {include} The included page could not be found. |
UDM Operation | Unable to render {include} The included page could not be found. |
Transfer Direction | Unable to render {include} The included page could not be found. |
Primary File(s) | Unable to render {include} The included page could not be found. |
Secondary File(s) | Unable to render {include} The included page could not be found. |
Use Regular Expression | Unable to render {include} The included page could not be found. |
Codepage | Options: |
Compress | Unable to render {include} The included page could not be found. |
Encrypt | Unable to render {include} The included page could not be found. |
Destination File Creation Option | Unable to render {include} The included page could not be found. |
Runtime Directory | Unable to render {include} The included page could not be found. |
| Advanced UDM Options | Unable to render {include} The included page could not be found. |
Trim Trailing Spaces | Unable to render {include} The included page could not be found. |
Network Fault Tolerant | Unable to render {include} The included page could not be found. |
Show Progress | Unable to render {include} The included page could not be found. |
Primary File System | Unable to render {include} The included page could not be found. |
Secondary File System | Unable to render {include} The included page could not be found. |
Append Primary Open Options | Unable to render {include} The included page could not be found. |
Append Secondary Open Option | Unable to render {include} The included page could not be found. |
Append UDM Options | Unable to render {include} The included page could not be found. |
| Result Processing Details | This section contains assorted detailed information about result processing for this task. |
Exit Code Processing | Unable to render {include} The included page could not be found. |
Output Type-Exit Code | Unable to render {include} The included page could not be found. |
Exit Codes | Unable to render {include} The included page could not be found. |
Scan Output For | Unable to render {include} The included page could not be found. |
Output File-Exit Codes | Unable to render {include} The included page could not be found. |
Retry Options | This section contains specifications for retrying the task. |
Retry Exit Codes | Unable to render {include} The included page could not be found. |
Maximum Retries | Unable to render {include} The included page could not be found. |
Retry Indefinitely | Unable to render {include} The included page could not be found. |
Retry Interval (Seconds) | Unable to render {include} The included page could not be found. |
Suppress Intermediate Failures | Unable to render {include} The included page could not be found. |
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. |
Wait To Start | Unable to render {include} The included page could not be found. |
Wait Time | Unable to render {include} The included page could not be found. |
Wait Day Constraint | Unable to render {include} The included page could not be found. |
Wait Duration | Unable to render {include} The included page could not be found. |
Wait Duration In Seconds | Unable to render {include} The included page could not be found. |
Delay On Start | Unable to render {include} The included page could not be found. |
Delay Duration | Unable to render {include} The included page could not be found. |
Delay Duration In Seconds | Unable to render {include} The included page could not be found. |
Workflow Only | Unable to render {include} The included page could not be found. |
Time Options | This section contains time-related specifications for the task. |
Late Start | Unable to render {include} The included page could not be found. |
Late Start Type | Unable to render {include} The included page could not be found. |
Late Start Time | Unable to render {include} The included page could not be found. |
Late Start Day Constraint | Unable to render {include} The included page could not be found. |
Late Start Nth Amount | Unable to render {include} The included page could not be found. |
Late Start Duration | Unable to render {include} The included page could not be found. |
Late Finish | Unable to render {include} The included page could not be found. |
Late Finish Type | Unable to render {include} The included page could not be found. |
Late Finish Offset Type | Unable to render {include} The included page could not be found. |
Late Finish Percentage Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Late Finish Time | Unable to render {include} The included page could not be found. |
Late Finish Day Constraint | Unable to render {include} The included page could not be found. |
Late Finish Nth Amount | Unable to render {include} The included page could not be found. |
Late Finish Duration | Unable to render {include} The included page could not be found. |
Early Finish | Unable to render {include} The included page could not be found. |
Early Finish Type | Unable to render {include} The included page could not be found. |
Early Finish Offset Type | Unable to render {include} The included page could not be found. |
Early Finish Percentage Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Early Finish Time | Unable to render {include} The included page could not be found. |
Early Finish Day Constraint | Unable to render {include} The included page could not be found. |
Early Finish Nth Amount | Unable to render {include} The included page could not be found. |
Early Finish Duration | Unable to render {include} The included page could not be found. |
User Estimated Duration | Unable to render {include} The included page could not be found. |
Critical Path Options | This section contains Critical Path-related specifications for the task. |
CP Duration | Unable to render {include} The included page could not be found. |
CP Duration (Resolved) | Unable to render {include} The included page could not be found. |
CP Duration Unit | Unable to render {include} The included page could not be found. |
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. |
Execution Restriction | Unable to render {include} The included page could not be found. |
Restriction Period | Unable to render {include} The included page could not be found. |
Before Date | Unable to render {include} The included page could not be found. |
Before Time | Unable to render {include} The included page could not be found. |
After Date | Unable to render {include} The included page could not be found. |
After Time | Unable to render {include} The included page could not be found. |
Date List | Unable to render {include} The included page could not be found. |
Statistics | This section contains time-related statistics for task instances of the task. |
| First Execution | Unable to render {include} The included page could not be found. |
Last Execution | Unable to render {include} The included page could not be found. |
Last Instance Duration | Unable to render {include} The included page could not be found. |
Lowest Instance Time | Unable to render {include} The included page could not be found. |
Average Instance Time | Unable to render {include} The included page could not be found. |
Highest Instance Time | Unable to render {include} The included page could not be found. |
Number of Instances | Unable to render {include} The included page could not be found. |
Metadata | This section contains Metadata information about this record. |
UUID | Universally Unique Identifier of this record. |
Updated By | Name of the user that last updated this record. |
Updated | Date and time that this record was last updated. |
Created By | Name of the user that created this record. |
Created | Date and time that this record was created. |
Status History | History of all statuses that the task instance has gone through. |
Buttons | This section identifies the buttons displayed above and below the Task Details that let you perform various actions. |
Save | Saves a new task record in the Controller database. |
Save & New | Saves a new record in the Controller database and redisplays empty Details so that you can create another new record. |
Save & View | Saves a new record in the Controller database and continues to display that record. |
New | Displays empty (except for default values) Details for creating a new task. |
Update | Unable to render {include} The included page could not be found. |
Launch Task | Unable to render {include} The included page could not be found. |
View Parents | Unable to render {include} The included page could not be found. |
Copy | Creates a copy of this task, which you are prompted to rename. |
Delete | Unable to render {include} The included page could not be found. Note You cannot delete a task if it is either:
|
Refresh | Refreshes any dynamic data displayed in the Details. |
Close | For pop-up view only; closes the pop-up view of this task. |
Tabs | This section identifies the tabs across the top of the Task Details that provide access to additional information about the task. |
Variables | Unable to render {include} The included page could not be found. |
Actions | Unable to render {include} The included page could not be found. |
Virtual Resources | Unable to render {include} The included page could not be found. |
Mutually Exclusive | Unable to render {include} The included page could not be found. |
Instances | Lists all instances of the task. |
Triggers | Unable to render {include} The included page could not be found. |
Notes | Unable to render {include} The included page could not be found. |
Versions | Unable to render {include} The included page could not be found. |
Viewing a File Transfer Task Instance
When a File Transfer task is launched, the Controller creates a task instance record of that task.
A task instance contains detailed information about a single execution of that task.
You can access a task instance from:
- Instances tab on the FTP/SFTP/FTPS or UDM File Transfer Task Details for that task
- Activity Monitor
- Task Instances list
FTP/SFTP/FTPS File Transfer Task Instance Details
The following FTP/SFTP/FTPS File Transfer Task Instance Details contains information on the execution of the task shown in the File Transfer Task#FTP/SFTP/FTPS File Transfer Task Details.
FTP/SFTP/FTPS File Transfer Task Instance Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in FTP/SFTP/FTPS File Transfer Task Instance Details.
Field Name | Description |
|---|---|
General | This section contains general information about the task instance. |
Instance Name | Name of this task instance. |
Instance Number | Unable to render {include} The included page could not be found. |
Description | Unable to render {include} The included page could not be found. |
Member of Business Services | Unable to render {include} The included page could not be found. |
Task | Unable to render {include} The included page could not be found. |
| Source Version | Unable to render {include} The included page could not be found. |
Launch Source | Unable to render {include} The included page could not be found. |
Source Instance | Unable to render {include} The included page could not be found. |
Invoked by | Unable to render {include} The included page could not be found. |
Execution User | Unable to render {include} The included page could not be found. |
Calendar | Unable to render {include} The included page could not be found. |
Time Zone Preference | Unable to render {include} The included page could not be found. |
Virtual Resource Priority | Unable to render {include} The included page could not be found. |
Hold Resources on Failure | Unable to render {include} The included page could not be found. |
Status | This section contains information about the current status of the task instance. |
Status | Unable to render {include} The included page could not be found. |
Exit Code | Unable to render {include} The included page could not be found. |
Status Description | Unable to render {include} The included page could not be found. |
Operational Memo | Unable to render {include} The included page could not be found. |
Evaluation Time | Unable to render {include} The included page could not be found. |
Critical | Unable to render {include} The included page could not be found. |
Wait Until Time | Unable to render {include} The included page could not be found. |
Queued Time | Unable to render {include} The included page could not be found. |
Trigger Time | Unable to render {include} The included page could not be found. |
Launch Time | Unable to render {include} The included page could not be found. |
Start Time | Unable to render {include} The included page could not be found. |
End Time | Unable to render {include} The included page could not be found. |
Duration | Unable to render {include} The included page could not be found. |
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
Cluster | Unable to render {include} The included page could not be found. |
Agent | Unable to render {include} The included page could not be found. |
Agent Variable | Unable to render {include} The included page could not be found. |
Agent Cluster | Unable to render {include} The included page could not be found. |
Agent Cluster Variable | Unable to render {include} The included page could not be found. |
Credentials | Unable to render {include} The included page could not be found. |
Credentials Variable | Unable to render {include} The included page could not be found. |
File Transfer Details | This section contains assorted detailed information about the task instance. |
Transfer Protocol | Unable to render {include} The included page could not be found. |
Command | Unable to render {include} The included page could not be found. |
Job Card (z/OS only) | Unable to render {include} The included page could not be found. |
Subcommands (z/OS only) | Unable to render {include} The included page could not be found. |
Transfer Type | Unable to render {include} The included page could not be found. |
Transfer Mode | Unable to render {include} The included page could not be found. |
Remote Server | Required if File Transfer Task#Transfer Protocol = FTP, SFTP or FTPS; name or IP address of the File Transfer server. This machine may or may not be the same as the Agent machine. |
FTP Credentials | Unable to render {include} The included page could not be found. |
FTP Credentials Variable | Unable to render {include} The included page could not be found. |
Local Filename | Unable to render {include} The included page could not be found. |
Use Regular Expression | Enables the use of a regular expression in the File Transfer Task#Local Filename field. |
Remote Filename | Unable to render {include} The included page could not be found. |
Move | Unable to render {include} The included page could not be found. |
Retry Options | This section contains specifications for retrying the task. |
Maximum Retries | Unable to render {include} The included page could not be found. |
Retry Indefinitely | Unable to render {include} The included page could not be found. |
Retry Interval (Seconds) | Unable to render {include} The included page could not be found. |
Current Retry Count | Unable to render {include} The included page could not be found. |
Suppress Intermediate Failures | Unable to render {include} The included page could not be found. |
Next Retry Time | Unable to render {include} The included page could not be found. |
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. |
Wait To Start | Unable to render {include} The included page could not be found. |
Wait Time | Unable to render {include} The included page could not be found. |
Wait Day Constraint | Unable to render {include} The included page could not be found. |
Wait Duration | Unable to render {include} The included page could not be found. |
Wait Duration In Seconds | Unable to render {include} The included page could not be found. |
Delay On Start | Unable to render {include} The included page could not be found. |
Delay Duration | Unable to render {include} The included page could not be found. |
Delay Duration In Seconds | Unable to render {include} The included page could not be found. |
Time Options | This section contains time-related statistics for the task instance. |
Late Start | Unable to render {include} The included page could not be found. |
Started Late | Unable to render {include} The included page could not be found. |
Late Start Type | Unable to render {include} The included page could not be found. |
Late Start Time | Unable to render {include} The included page could not be found. |
Late Start Day Constraint | Unable to render {include} The included page could not be found. |
Late Start Nth Amount | Unable to render {include} The included page could not be found. |
Late Start Duration | Unable to render {include} The included page could not be found. |
Computed Late Start Time | Unable to render {include} The included page could not be found. |
Late Finish | Unable to render {include} The included page could not be found. |
Finished Late | Unable to render {include} The included page could not be found. |
Late Finish Type | Unable to render {include} The included page could not be found. |
Late Finish Offset Type | Unable to render {include} The included page could not be found. |
Late Finish Percentage Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Late Finish Time | Unable to render {include} The included page could not be found. |
Late Finish Day Constraint | Unable to render {include} The included page could not be found. |
Late Finish Nth Amount | Unable to render {include} The included page could not be found. |
Late Finish Duration | Unable to render {include} The included page could not be found. |
Computed Late Finish Time | Unable to render {include} The included page could not be found. |
Early Finish | Unable to render {include} The included page could not be found. |
Finished Early | Unable to render {include} The included page could not be found. |
Early Finish Type | Unable to render {include} The included page could not be found. |
Early Finish Offset Type | Unable to render {include} The included page could not be found. |
Early Finish Percentage Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Early Finish Time | Unable to render {include} The included page could not be found. |
Early Finish Day Constraint | Unable to render {include} The included page could not be found. |
Early Finish Nth Amount | Unable to render {include} The included page could not be found. |
Early Finish Duration | Unable to render {include} The included page could not be found. |
Projected Late | Unable to render {include} The included page could not be found. |
Critical Path Options | This section contains Critical Path-related specifications for the task. |
CP Duration | Unable to render {include} The included page could not be found. |
CP Duration (Resolved) | Unable to render {include} The included page could not be found. |
CP Duration Unit | Unable to render {include} The included page could not be found. |
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. |
Execution Restriction | Unable to render {include} The included page could not be found. |
Restriction Period | Unable to render {include} The included page could not be found. |
Before Date | Unable to render {include} The included page could not be found. |
Before Time | Unable to render {include} The included page could not be found. |
After Date | Unable to render {include} The included page could not be found. |
After Time | Unable to render {include} The included page could not be found. |
Date List | Unable to render {include} The included page could not be found. |
Statistics | This section contains time-related statistics for the task instance. |
User Estimated End Time | Unable to render {include} The included page could not be found. |
Lowest Estimated End Time | Unable to render {include} The included page could not be found. |
Average Estimated End Time | Unable to render {include} The included page could not be found. |
Highest Estimated End Time | Unable to render {include} The included page could not be found. |
Projected End Time | System-supplied; projected end time of the task instance, calculated by the Controller based on the projected end time of its predecessor (or the maximum projected end time of all its predecessors, if more than one path exists to that task instance) plus its estimated critical path duration. |
Metadata | This section contains Metadata information about this record. |
UUID | Universally Unique Identifier of this record. |
Updated By | Name of the user that last updated this record. |
Updated | Date and time that this record was last updated. |
Created By | Name of the user that created this record. |
Created | Date and time that this record was created. |
Status History | History of all statuses that the task instance has gone through. |
Buttons | This section identifies the buttons displayed above and below the Task Instance Details that let you perform various actions. |
Update | Unable to render {include} The included page could not be found. |
Force Finish | Unable to render {include} The included page could not be found. |
Hold | Unable to render {include} The included page could not be found. |
Skip | Unable to render {include} The included page could not be found. |
Re-run | Unable to render {include} The included page could not be found. |
View Parent | Unable to render {include} The included page could not be found. |
Delete | Unable to render {include} The included page could not be found. |
Refresh | Refreshes any dynamic data displayed in the Details. |
Close | For pop-up view only; closes the pop-up view of this task instance. |
Tabs | This section identifies the tabs across the top of the Task Instance Details that provide access to additional information about the task instance. |
Virtual Resources | Unable to render {include} The included page could not be found. |
Exclusive Requests | Unable to render {include} The included page could not be found. |
Output | Displays output generated from the process. Note For File Transfer task instances, output always is automatically retrieved and is available from the Output tab. |
Notes | Unable to render {include} The included page could not be found. |
UDM File Transfer Task Instance Details
The following UDM File Transfer Task Instance Details contains information on the execution of the task shown in the File Transfer Task#UDM File Transfer Task Details.
UDM File Transfer Task Instance Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in UDM File Transfer Task Instance Details.
Field Name | Description |
|---|---|
General | This section contains general information about the task instance. |
Instance Name | Name of this task instance. |
Instance Number | Unable to render {include} The included page could not be found. |
Description | Unable to render {include} The included page could not be found. |
Member of Business Services | Unable to render {include} The included page could not be found. |
Task | Unable to render {include} The included page could not be found. |
| Source Version | Unable to render {include} The included page could not be found. |
Launch Source | Unable to render {include} The included page could not be found. |
Source Instance | Unable to render {include} The included page could not be found. |
Invoked by | Unable to render {include} The included page could not be found. |
Execution User | Unable to render {include} The included page could not be found. |
Calendar | Unable to render {include} The included page could not be found. |
Time Zone Preference | Unable to render {include} The included page could not be found. |
Virtual Resource Priority | Unable to render {include} The included page could not be found. |
Hold Resources on Failure | Unable to render {include} The included page could not be found. |
Status | This section contains information about the current status of the task instance. |
Status | Unable to render {include} The included page could not be found. |
Exit Code | Unable to render {include} The included page could not be found. |
Status Description | Unable to render {include} The included page could not be found. |
Operational Memo | Unable to render {include} The included page could not be found. |
Evaluation Time | Unable to render {include} The included page could not be found. |
Critical | Unable to render {include} The included page could not be found. |
Wait Until Time | Unable to render {include} The included page could not be found. |
Queued Time | Unable to render {include} The included page could not be found. |
Trigger Time | Unable to render {include} The included page could not be found. |
Launch Time | Unable to render {include} The included page could not be found. |
Start Time | Unable to render {include} The included page could not be found. |
End Time | Unable to render {include} The included page could not be found. |
Duration | Unable to render {include} The included page could not be found. |
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
Cluster | Unable to render {include} The included page could not be found. |
Utility Agent | Unable to render {include} The included page could not be found. |
Utility Agent Variable | Unable to render {include} The included page could not be found. |
Utility Agent Cluster | Unable to render {include} The included page could not be found. |
Utility Agent Cluster Variable | Unable to render {include} The included page could not be found. |
Utility Credentials | Unable to render {include} The included page could not be found. |
Utility Credentials Variable | Unable to render {include} The included page could not be found. |
File Transfer Details | This section contains assorted detailed information about the task instance. |
Transfer Protocol | Unable to render {include} The included page could not be found. |
| Primary UDM Agent Option | Unable to render {include} The included page could not be found. |
| Secondary UDM Agent Option | Unable to render {include} The included page could not be found. |
| Primary UDM Agent | Unable to render {include} The included page could not be found. |
| Secondary UDM Agent | Unable to render {include} The included page could not be found. |
| Primary UDM Agent Variable | Unable to render {include} The included page could not be found. |
| Secondary UDM Agent Variable | Unable to render {include} The included page could not be found. |
| Primary UDM Agent Cluster | Unable to render {include} The included page could not be found. |
| Primary UDM Agent Cluster Variable | Unable to render {include} The included page could not be found. |
| Secondary UDM Agent Cluster | Unable to render {include} The included page could not be found. |
| Secondary UDM Agent Cluster Variable | Unable to render {include} The included page could not be found. |
| Primary Credentials | Unable to render {include} The included page could not be found. |
| Secondary Credentials | Unable to render {include} The included page could not be found. |
| Primary Credentials Variable | Unable to render {include} The included page could not be found. |
| Secondary Credentials Variable | Unable to render {include} The included page could not be found. |
Form or Script | Unable to render {include} The included page could not be found. |
Transfer Type | Unable to render {include} The included page could not be found. |
UDM Operation | Unable to render {include} The included page could not be found. |
Transfer Direction | Unable to render {include} The included page could not be found. |
Primary File(s) | Unable to render {include} The included page could not be found. |
Secondary File(s) | Unable to render {include} The included page could not be found. |
Use Regular Expression | Unable to render {include} The included page could not be found. |
Codepage | Options: |
Compress | Unable to render {include} The included page could not be found. |
Encrypt | Unable to render {include} The included page could not be found. |
Destination File Creation Option | Unable to render {include} The included page could not be found. |
Runtime Directory | Unable to render {include} The included page could not be found. |
| Advanced UDM Options | Unable to render {include} The included page could not be found. |
Trim Trailing Spaces | Unable to render {include} The included page could not be found. |
Network Fault Tolerant | Unable to render {include} The included page could not be found. |
Show Progress | Unable to render {include} The included page could not be found. |
Primary File System | Unable to render {include} The included page could not be found. |
Secondary File System | Unable to render {include} The included page could not be found. |
Append Primary Open Options | Unable to render {include} The included page could not be found. |
Append Secondary Open Option | Unable to render {include} The included page could not be found. |
Append UDM Options | Unable to render {include} The included page could not be found. |
| Result Processing Details | This section contains assorted detailed information about result processing for this task. |
Exit Code Processing | Unable to render {include} The included page could not be found. |
Output Type-Exit Code | Unable to render {include} The included page could not be found. |
Exit Codes | Unable to render {include} The included page could not be found. |
Scan Output For | Unable to render {include} The included page could not be found. |
Output File-Exit Codes | Unable to render {include} The included page could not be found. |
Retry Options | This section contains specifications for retrying the task. |
Maximum Retries | Unable to render {include} The included page could not be found. |
Retry Indefinitely | Unable to render {include} The included page could not be found. |
Retry Interval (Seconds) | Unable to render {include} The included page could not be found. |
Current Retry Count | Unable to render {include} The included page could not be found. |
Suppress Intermediate Failures | Unable to render {include} The included page could not be found. |
Next Retry Time | Unable to render {include} The included page could not be found. |
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. |
Wait To Start | Unable to render {include} The included page could not be found. |
Wait Time | Unable to render {include} The included page could not be found. |
Wait Day Constraint | Unable to render {include} The included page could not be found. |
Wait Duration | Unable to render {include} The included page could not be found. |
Wait Duration In Seconds | Unable to render {include} The included page could not be found. |
Delay On Start | Unable to render {include} The included page could not be found. |
Delay Duration | Unable to render {include} The included page could not be found. |
Delay Duration In Seconds | Unable to render {include} The included page could not be found. |
Time Options | This section contains time-related specifications for the task instance. |
Late Start | Unable to render {include} The included page could not be found. |
Started Late | Unable to render {include} The included page could not be found. |
Late Start Type | Unable to render {include} The included page could not be found. |
Late Start Time | Unable to render {include} The included page could not be found. |
Late Start Day Constraint | Unable to render {include} The included page could not be found. |
Late Start Nth Amount | Unable to render {include} The included page could not be found. |
Late Start Duration | Unable to render {include} The included page could not be found. |
Computed Late Start Time | Unable to render {include} The included page could not be found. |
Late Finish | Unable to render {include} The included page could not be found. |
Finished Late | Unable to render {include} The included page could not be found. |
Late Finish Type | Unable to render {include} The included page could not be found. |
Late Finish Offset Type | Unable to render {include} The included page could not be found. |
Late Finish Percentage Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Late Finish Time | Unable to render {include} The included page could not be found. |
Late Finish Day Constraint | Unable to render {include} The included page could not be found. |
Late Finish Nth Amount | Unable to render {include} The included page could not be found. |
Late Finish Duration | Unable to render {include} The included page could not be found. |
Computed Late Finish Time | Unable to render {include} The included page could not be found. |
Early Finish | Unable to render {include} The included page could not be found. |
Finished Early | Unable to render {include} The included page could not be found. |
Early Finish Type | Unable to render {include} The included page could not be found. |
Early Finish Offset Type | Unable to render {include} The included page could not be found. |
Early Finish Percentage Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Early Finish Time | Unable to render {include} The included page could not be found. |
Early Finish Day Constraint | Unable to render {include} The included page could not be found. |
Early Finish Nth Amount | Unable to render {include} The included page could not be found. |
Early Finish Duration | Unable to render {include} The included page could not be found. |
Projected Late | Unable to render {include} The included page could not be found. |
Critical Path Options | This section contains Critical Path-related specifications for the task. |
CP Duration | Unable to render {include} The included page could not be found. |
CP Duration (Resolved) | Unable to render {include} The included page could not be found. |
CP Duration Unit | Unable to render {include} The included page could not be found. |
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. |
Execution Restriction | Unable to render {include} The included page could not be found. |
Restriction Period | Unable to render {include} The included page could not be found. |
Before Date | Unable to render {include} The included page could not be found. |
Before Time | Unable to render {include} The included page could not be found. |
After Date | Unable to render {include} The included page could not be found. |
After Time | Unable to render {include} The included page could not be found. |
Date List | Unable to render {include} The included page could not be found. |
Statistics | This section contains time-related statistics for the task instances of this task. |
User Estimated End Time | Unable to render {include} The included page could not be found. |
Lowest Estimated End Time | Unable to render {include} The included page could not be found. |
Average Estimated End Time | Unable to render {include} The included page could not be found. |
Highest Estimated End Time | Unable to render {include} The included page could not be found. |
Projected End Time | System-supplied; projected end time of the task instance, calculated by the Controller based on the projected end time of its predecessor (or the maximum projected end time of all its predecessors, if more than one path exists to that task instance) plus its estimated critical path duration. |
Metadata | This section contains Metadata information about this record. |
UUID | Universally Unique Identifier of this record. |
Updated By | Name of the user that last updated this record. |
Updated | Date and time that this record was last updated. |
Created By | Name of the user that created this record. |
Created | Date and time that this record was created. |
Status History | History of all statuses that the task instance has gone through. |
Buttons | This section identifies the buttons displayed above and below the Task Instance Details that let you perform various actions. |
Update | Unable to render {include} The included page could not be found. |
Force Finish | Unable to render {include} The included page could not be found. |
Hold | Unable to render {include} The included page could not be found. |
Skip | Unable to render {include} The included page could not be found. |
Re-run | Unable to render {include} The included page could not be found. |
View Parent | Unable to render {include} The included page could not be found. |
Delete | Unable to render {include} The included page could not be found. |
Refresh | Refreshes any dynamic data displayed in the Details. |
Close | For pop-up view only; closes the pop-up view of this task instance. |
Tabs | This section identifies the tabs across the top of the Task Instance Details that provide access to additional information about the task instance. |
Virtual Resources | Unable to render {include} The included page could not be found. |
Exclusive Requests | Unable to render {include} The included page could not be found. |
Output | Displays output generated from the process. Note For File Transfer task instances, output always is automatically retrieved and is available from the Output tab. |
Notes | Unable to render {include} The included page could not be found. |
Output Redirection
An Agent processes File Transfer (UDM), Universal Command, and SAP tasks differently than Windows and Linux/Unix tasks. File Transfer (UDM), Universal Command, and SAP command lines are sent to the user process via standard input, so any redirection operators entered as task command input are not processed as expected.
If you want to direct output from a File Transfer (UDM ) task to your file system, the -uagstdio command option lets you specify the same output redirection commands that are available for Windows and Linux/Unix tasks. UAG will apply the user-specified value for -uagstdio directly to the command image.
The I/O redirection commands that you can use with -uagstdio are dependent on the OS/command shell. You should be able to set up any redirection that the OS/command shell supports (just as with Windows and Linux/Unix tasks).
The syntax of -uagstdio is similar to Universal Data Mover, Universal Command, and Universal Connector command line options; option followed by value.
For a File Transfer (UDM ) task, you can specify uagstdio in the following field:
-uagstdio Examples
If the -uagstdio value contains spaces, it must be enclose in double quotation marks ( " ):
If the quoted value itself requires double quotation marks, they must be doubled ( "" ):
Specifying When a Task Runs
You can run the task as part of a workflow, specify triggers that run the task automatically based on times or events, or run the task manually.
Running a File Transfer Task
You can run a File Transfer task:
- Manually, by clicking the Launch Task or Launch Task with Variables button in the File Transfer tasks list or File Transfer Task Details Action menu.
- As part of a workflow.
- Specify triggers that run the task automatically based on times or events.
Monitoring Task Execution
You can monitor all system activity from the Activity Monitor and can view activity history from the History list.
Code Pages
The following table identifies all supported code pages for a UDM File Transfer task.
ISO8859-1 | op437 | IBM Portugal 037 |
ISO8859-2 | op737 | IBM German 273 |
ISO8859-3 | op775 | IBM Danish and Norwegian 277 |
ISO8859-4 | op850 | IBM Sweden and Finland 278 |
ISO8859-5 | op852 | IBM Italian 280 |
ISO8859-6 | op855 | IBM Spanish 284 |
ISO8859-7 | op857 | IBM International 500 |
ISO8859-8 | op860 | IBM Greek 875 |
ISO8859-9 | op861 | IBM Latin-1 1047 |
ISO8859-10 | cp862 | IBM Portugal 1140 |
ISO8859-13 | cp863 | IBM German 1141 |
ISO8859-14 | cp864 | IBM Danish 1142 |
ISO8859-15 | cp865 | IBM Finish 1143 |
cp866 | IBM Italian 1144 | |
cp869 | IBM Spanish 1145 | |
cp874 | IBM UK 1146 | |
cp1250 | IBM Swiss 1148 | |
cp1251 | IBM Greek 4971 | |
cp1252 | ||
cp1253 | ||
cp1254 | ||
cp1255 | ||
cp1256 | ||
cp1257 | ||
cp1258 |