Overview

The File Transfer task allows you to execute file transfers on remote machines using any of the following protocols:

• FTP

• SFTP

• UDM

• FTPS

• FTPES

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:

• Task Instance variables

• Agent-Based Task Instance variables

• File Transfer Task variables

Creating a File Transfer Task

File Transfer Protocols

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:. 

• 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, 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.

FTP/SFTP/FTPS/FTPES File Transfer Task Details

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.
 

Open

FTP/SFTP/FTPS/FTPES File Transfer Task Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in FTP/SFTP/FTPS/FTPES File Transfer Task Details.