The File Transfer task allows you to execute file transfers on remote machines using any of the following protocols:
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.
The following built-in variables can be used in a File Transfer task to pass data where appropriate:
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.
To display more of the Details fields on the screen, you can either:
|
Step 3 | Click a |
To open an existing record on the list, either:
|
When you create a File Transfer task, you select a file transfer protocol: FTP, SFTP, UDM, FTPS or FTPES.
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 Transfer Protocol field, below.)
The order of precedence for selecting a default Transfer Protocol for a File Transfer task is UDM, SFTP, FTPS, FTP, FTPES. The first of these protocols that is not specified in the File Transfer Task Exclude Protocols system property will be the default.
For example:.
The Details for FTP, SFTP, FTPS, and FTPES 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.
The following FTP/SFTP/FTPS/FTPES File Transfer Task Details is for an existing FTP/SFTP/FTPS/FTPES File Transfer task.
Depending on the values that you enter / select for these fields, and whether or not the FTP/SFTP/FTPS/FTPES 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/FTPES File Transfer Task Details.
The following table describes the fields, buttons, and tabs that display in FTP/SFTP/FTPS/FTPES File Transfer Task Details.
Field Name | Description | |
|---|---|---|
General | This section contains general information about the task. | |
Name | ||
Version | ||
Description | ||
Member of Business Services | ||
Resolve Name Immediately | ||
Time Zone Preference | ||
Hold on Start | ||
Hold Reason | ||
Virtual Resource Priority | ||
| ||
| Mutually Exclusive With Self | ||
| Simulate | ||
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
File Transfer Details | This section contains assorted detailed information about the task. | |
| ||
| ||
Job Card (z/OS only) | ||
Subcommands (z/OS only) | ||
| Verify Host Name | ||
| Authenticate Peer | ||
Transfer Type | ||
Transfer Mode | ||
Remote Server | Required if Transfer Protocol = FTP, SFTP, FTPS, or FTPES; name or IP address of the File Transfer server. This machine may or may not be the same as the Agent machine. | |
FTP Credentials | ||
FTP Credentials Variable | ||
| ||
| Enables the use of a regular expression in the Local Filename field. | |
Remote Filename | ||
Move | ||
Retry Options | This section contains specifications for retrying the task. | |
| ||
Retry Indefinitely | ||
Retry Interval (Seconds) | ||
Suppress Intermediate Failures | ||
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Time Options | This section contains time-related specifications for the task. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Critical Path Options | This section contains Critical Path-related specifications for the task. | |
| ||
| ||
| ||
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| Self-Service Options | This section contains Self-Service specifications for the task. | |
| Enforce Variables | ||
| Lock Variables | ||
Statistics | This section contains time-related statistics for task instances of the task. | |
| First Execution | ||
Last Execution | ||
Last Instance Duration | ||
Lowest Instance Time | ||
Average Instance Time | ||
Highest Instance Time | ||
Number of Instances | ||
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 | ||
Launch | ||
View Parents | ||
Copy | Creates a copy of this task, which you are prompted to rename. | |
Delete |
| |
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 | ||
Actions | ||
Virtual Resources | ||
Mutually Exclusive | ||
| Lists all instances of the task. | |
Triggers | ||
Notes | ||
|
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.
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 | ||
Version | ||
Description | ||
Member of Business Services | ||
Resolve Name Immediately | ||
Time Zone Preference | ||
Hold on Start | ||
Hold Reason | ||
Virtual Resource Priority | ||
| ||
| Mutually Exclusive With Self | ||
| Simulate | ||
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. | |
| ||
| ||
| ||
| ||
Utility Agent Cluster Variable | ||
| ||
| ||
Utility Cluster Broadcast Variable | ||
| ||
Utility Credentials Variable | ||
File Transfer Details | This section contains assorted detailed information about the task. | |
Transfer Protocol | ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Use Regular Expression | ||
| Options: | |
Compress | ||
Encrypt | ||
Destination File Creation Option | ||
| ||
Trim Trailing Spaces | ||
Network Fault Tolerant | ||
| ||
Primary File System | ||
Secondary File System | ||
Append Primary Open Options | ||
Append Secondary Open Option | ||
| ||
| Result Processing Details | This section contains assorted detailed information about result processing for this task. | |
| ||
Output Type-Exit Code | ||
| ||
| ||
Output File-Exit Codes | ||
Retry Options | This section contains specifications for retrying the task. | |
| ||
| ||
Retry Indefinitely | ||
Retry Interval (Seconds) | ||
Suppress Intermediate Failures | ||
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Time Options | This section contains time-related specifications for the task. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Critical Path Options | This section contains Critical Path-related specifications for the task. | |
| ||
| ||
| ||
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Statistics | This section contains time-related statistics for task instances of the task. | |
| First Execution | ||
Last Execution | ||
Last Instance Duration | ||
Lowest Instance Time | ||
Average Instance Time | ||
Highest Instance Time | ||
Number of Instances | ||
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. | |
Operational Memo History | History of all Operational Memos for the task. | |
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 | ||
Launch | ||
View Parents | ||
Copy | Creates a copy of this task, which you are prompted to rename. | |
Delete |
| |
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 | ||
Actions | ||
Virtual Resources | ||
Mutually Exclusive | ||
| Lists all instances of the task. | |
Triggers | ||
Notes | ||
|
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:
The following FTP/SFTP/FTPS/FTPES File Transfer Task Instance Details contains information on the execution of the task shown in the FTP/SFTP/FTPS/FTPES File Transfer Task Details.
The following table describes the fields, buttons, and tabs that display in FTP/SFTP/FTPS/FTPES File Transfer Task Instance Details.
Field Name | Description | |
|---|---|---|
General | This section contains general information about the task instance. | |
| Name of this task instance. | |
Instance Number | ||
Description | ||
Member of Business Services | ||
Task | ||
| Source Version | ||
Launch Source | ||
Source Instance | ||
Invoked by | ||
| ||
Calendar | ||
Time Zone Preference | ||
Virtual Resource Priority | ||
| ||
| Mutually Exclusive With Self | ||
| Simulate | ||
| Previous Instance Wait Resolved | ||
Status | This section contains information about the current status of the task instance. | |
Status | ||
Exit Code | ||
Status Description | ||
Operational Memo | ||
Evaluation Time | ||
Critical | ||
| Critical Endpoint | ||
Wait Until Time | ||
Queued Time | ||
| ||
| ||
| ||
End Time | ||
Duration | ||
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
File Transfer Details | This section contains assorted detailed information about the task instance. | |
| ||
| ||
Job Card (z/OS only) | ||
Subcommands (z/OS only) | ||
| Verify Host Name | ||
| Authenticate Peer | ||
Transfer Type | ||
Transfer Mode | ||
Remote Server | Required if Transfer Protocol = FTP, SFTP, FTPS, or FTPES; name or IP address of the File Transfer server. This machine may or may not be the same as the Agent machine. | |
FTP Credentials | ||
FTP Credentials Variable | ||
| ||
| Enables the use of a regular expression in the Local Filename field. | |
Remote Filename | ||
Move | ||
Retry Options | This section contains specifications for retrying the task. | |
| ||
Retry Indefinitely | ||
Retry Interval (Seconds) | ||
Current Retry Count | ||
Suppress Intermediate Failures | ||
Next Retry Time | ||
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Time Options | This section contains time-related statistics for the task instance. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Critical Path Options | This section contains Critical Path-related specifications for the task. | |
| ||
| ||
| ||
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Statistics | This section contains time-related statistics for the task instance. | |
| ||
Lowest Estimated End Time | ||
Average Estimated End Time | ||
Highest Estimated End Time | ||
| Projected Start Time | ||
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 | ||
Force Finish | ||
Hold | ||
Skip | ||
Re-run | ||
View Parent | ||
Delete | ||
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. | |
| Actions | ||
Virtual Resources | ||
Exclusive Requests | ||
Output | Displays output generated from the process.
| |
Notes |
The following UDM File Transfer Task Instance Details contains information on the execution of the task shown in the UDM File Transfer Task Details.
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. | |
| Name of this task instance. | |
Instance Number | ||
Description | ||
Member of Business Services | ||
Task | ||
| Source Version | ||
Launch Source | ||
Source Instance | ||
Invoked by | ||
| ||
Calendar | ||
Time Zone Preference | ||
Virtual Resource Priority | ||
| ||
| Mutually Exclusive With Self | ||
| Simulate | ||
| Previous Instance Wait Resolved | ||
Status | This section contains information about the current status of the task instance. | |
Status | ||
Exit Code | ||
Status Description | ||
Operational Memo | ||
Evaluation Time | ||
Critical | ||
| Critical Endpoint | ||
Wait Until Time | ||
Queued Time | ||
| ||
| ||
| ||
End Time | ||
Duration | ||
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. | |
| ||
| ||
| ||
| ||
Utility Agent Cluster Variable | ||
| ||
Utility Credentials Variable | ||
File Transfer Details | This section contains assorted detailed information about the task instance. | |
Transfer Protocol | ||
| Primary UDM Agent Option | ||
| Secondary UDM Agent Option | ||
| Primary UDM Agent | ||
| Secondary UDM Agent | ||
| Primary UDM Agent Variable | ||
| Secondary UDM Agent Variable | ||
| Primary UDM Agent Cluster | ||
| Primary UDM Agent Cluster Variable | ||
| Secondary UDM Agent Cluster | ||
| Secondary UDM Agent Cluster Variable | ||
| Primary Credentials | ||
| Secondary Credentials | ||
| Primary Credentials Variable | ||
| Secondary Credentials Variable | ||
| ||
| ||
| ||
| ||
| ||
| ||
Use Regular Expression | ||
| Options: | |
Compress | ||
Encrypt | ||
Destination File Creation Option | ||
| ||
| Advanced UDM Options | ||
Trim Trailing Spaces | ||
Network Fault Tolerant | ||
| ||
Primary File System | ||
Secondary File System | ||
Append Primary Open Options | ||
Append Secondary Open Option | ||
| ||
| Result Processing Details | This section contains assorted detailed information about result processing for this task. | |
| ||
Output Type-Exit Code | ||
| ||
| ||
Output File-Exit Codes | ||
Retry Options | This section contains specifications for retrying the task. | |
| ||
Retry Indefinitely | ||
Retry Interval (Seconds) | ||
Current Retry Count | ||
Suppress Intermediate Failures | ||
Next Retry Time | ||
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Time Options | This section contains time-related specifications for the task instance. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Critical Path Options | This section contains Critical Path-related specifications for the task. | |
| ||
| ||
| ||
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Statistics | This section contains time-related statistics for the task instances of this task. | |
| ||
Lowest Estimated End Time | ||
Average Estimated End Time | ||
Highest Estimated End Time | ||
| Projected Start Time | ||
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 | ||
Force Finish | ||
Hold | ||
Skip | ||
Re-run | ||
View Parent | ||
Delete | ||
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. | |
| Actions | ||
Virtual Resources | ||
Exclusive Requests | ||
Output | Displays output generated from the process.
| |
Notes |
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:
|
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 ( "" ):
|
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.
You can run a File Transfer task:
You can monitor all system activity from the Activity Monitor and can view activity history from the History list.
The following table identifies all supported code pages for a UDM File Transfer task (see CODE_PAGE - UDM Manager configuration option for more information)..
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 |
button above the list to display a pop-up version of the Details.
button. The task is added to the database, and all buttons and tabs in the Task Details are enabled.