Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
|---|
| Anchor |
|---|
| authenticatePeer - FT |
|---|
| authenticatePeer - FT |
|---|
|
authenticatePeer | Authenticate Peer | If serverType = FTPES; Indication of whether to use a CA certificate configured in the agent to authenticate the FTP server's certificate. | Boolean; Valid Values: true/false. Default is false. | N |
|
| Anchor |
|---|
| codepage - FT |
|---|
| codepage - FT |
|---|
|
codepage | Codepage | If serverType = UDM; Supported code pages for a File Transfer task. | Valid Values: | Html bobswift |
|---|
<ul>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
</ul>Default is - - None - - (0). | N |
|
| Command | If serverType = FTP, SFTP, FTPS, or FTPES; File Transfer command being executed. | Valid Values: | Html bobswift |
|---|
<ul>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
</ul>Default is GET (1). | N |
|
| Anchor |
|---|
| compress - FT |
|---|
| compress - FT |
|---|
|
compress | Compress | If serverType = UDM; Type of data compression used in the transfer, if any. | Valid Values: | Html bobswift |
|---|
<ul>
<li> As String = YES, As Value = 1
<li> As String = NO, As Value = 2
<li> As String = ZLIB, As Value = 3
<li> As String = HASP, As Value = 4
</ul>: - As String = YES, As Value = 1
- As String = NO, As Value = 2
- As String = ZLIB, As Value = 3
- As String = HASP, As Value = 4
Default is NO (2). | N |
|
| Anchor |
|---|
| createop - FT |
|---|
| createop - FT |
|---|
|
createop | File Creation Option | If serverType = UDM, formOrScript = Form, and udmOperation = Copy, Move, or Copy Directory; Specification for whether the transferred file should be created (new), appended, or should replace any existing file. | Valid Values: | Html bobswift |
|---|
<ul>
<li>
<li>
<li>
<li>
</ul>Default is - - None - - (0). | N |
|
| Encrypt | If serverType = UDM; Method of encryption that the Controller will use in the transfer. | Valid Values: | Html bobswift |
|---|
<ul>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
</ul>Default is NO (2). | N |
|
| Anchor |
|---|
| exitCodeOutput - FT |
|---|
| exitCodeOutput - FT |
|---|
|
exitCodeOutput | Output File | If outputType = FILE (3); Path and file name containing the output that you want automatically retrieved and attached to the task instance. |
| Y |
|
| Anchor |
|---|
| exitCodeProcessing - FT |
|---|
| exitCodeProcessing - FT |
|---|
|
exitCodeProcessing | Exit Code Processing | If serverType = UDM; Specification for how the Controller should determine whether the executed command failed or completed successfully. | Valid Values: | Html bobswift |
|---|
<ul>
<li>
<li>
<li>
<li>
<li>
</ul>Default is Success Exitcode Range (1). | N |
|
| Anchor |
|---|
| exitCodes - FT |
|---|
| exitCodes - FT |
|---|
|
exitCodes | Exit Codes | If exitCodeProcessing = Success Exitcode Range (1) or Failure Exitcode Range (2); Range of exit codes. | Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. For example: 1,5, 22-30. | Y |
|
| Anchor |
|---|
| exitCodeText - FT |
|---|
| exitCodeText - FT |
|---|
|
exitCodeText | Scan Output For | If exitCodeProcessing = Success Exitcode Range (1) or Failure Exitcode Range (2); Text for which the Controller should scan the output file. The Controller will process this field as a regular expression. |
| Y |
|
| Transfer Type | If serverType = FTP, SFTP, FTPS, or FTPES; Type of data transfer. | Valid Values: | Html bobswift |
|---|
<ul>
<li>
<li>
</ul>Default is Binary (1). | N |
|
| Anchor |
|---|
| formOrScript - FT |
|---|
| formOrScript - FT |
|---|
|
formOrScript | Form or Script | If serverType = UDM; Form or Script for this UDM File Transfer to use. | Valid Values: html-bobswift<ul>
<li>
<li>
</ul>Default is Form (1). | N |
|
| Anchor |
|---|
| ftpSubcommands - FT |
|---|
| ftpSubcommands - FT |
|---|
|
ftpSubcommands | Subcommands (z/OS only) | If serverType = FTP, SFTP, FTPS, or FTPES; Any subcommands used in the JCL statement. |
| N |
|
| Job Card (zOS only)] | If serverType = FTP, SFTP, FTPS, or FTPES; Job card information for the JCL statement. |
| N |
|
| Anchor |
|---|
| localFilename - FT |
|---|
| localFilename - FT |
|---|
|
localFilename | Local Filename | If serverType = FTP, SFTP, FTPS, or FTPES; Path and file name on the local server (that is, the "transfer from" file name). |
| Y |
|
| Primary File(s) | If serverType = UDM; Specifies the File(s) on the Primary UDM Agent. |
| Y - If
formOrScript = Form and udmOperation = Copy or Move. - If
formOrScript = Form, udmOperation = Copy Directory, and transferDirection = PUT.
|
|
| Move | If transferProtocol = FTP, SFTP, FTPS, or FTPES, and command = GET, MGET, PUT, or MPUT; Modifies the behavior of GET/MGET and PUT/MPUT by deleting the primary file(s) after being transferred to the destination.
GET/MGET with Move enabled will delete the files from the remote FTP server; PUT/MPUT with Move enabled will delete the files from the local FTP client.. |
| Y |
|
| Network Fault Tolerant | If serverType = UDM and formOrScript = form; Enable if the session is network fault tolerant. | Boolean; Valid Values: true/false. Default is false. | N |
|
| Anchor |
|---|
| outputType - FT |
|---|
| outputType - FT |
|---|
|
outputType | Output Type | If exitCodeProcessing = Success Output Contains (3) or Failure Output Contains (4); Type of output. | Valid Values: | Html bobswift |
|---|
<ul>
<li> As String = STDOUT, As Value = 1
<li> As String = STDERR, As Value = 2
<li> As String = FILE, As Value = 3
</ul>: - As String = STDOUT, As Value = 1
- As String = STDERR, As Value = 2
- As String = FILE, As Value = 3
Default is STDOUT (1). | N |
|
| Anchor |
|---|
| primaryBroker - FT |
|---|
| primaryBroker - FT |
|---|
|
primaryBroker | Primary UDM Agent | If serverType = UDM; Name of the Agent resource defined in the Controller that describes the Primary UDM Agent machine (primary transfer server). |
| - Y
If formOrScript = Form, and primaryBrokerChoice = Hostname or Agent Variable.
or
If formOrScript = Form, primaryBrokerChoice = Agent, and primaryBrokerChoice is not specified.
| primaryBrokerRef
|
| Anchor |
|---|
| primaryBrokerChoice - FT |
|---|
| primaryBrokerChoice - FT |
|---|
|
primaryBrokerChoice | Primary UDM Agent Option | If serverType = UDM; Specification for how you will specify the Primary UDM Agent. | Note |
|---|
| The Agent Variable value is valid for PUT/POST. GET will no longer support the Agent Variable (2) option. |
| Valid Values: - As String = None, As Value = 0
- As String = Agent, As Value = 1
- As String = Agent Variable, As Value = 2
- As String = Agent Hostname, As Value = 3
- As String = Utility Agent, As Value =4
- As String = Agent Cluster, As Value = 5
Default is Agent (1). | N |
|
| Anchor |
|---|
| primaryBrokerRef - FT |
|---|
| primaryBrokerRef - FT |
|---|
|
primaryBrokerRef | Primary UDM Agent | If serverType = UDM; Name of the Agent resource defined in the Controller that describes the Primary UDM Agent machine (primary transfer server). |
| - Y
If formOrScript = Form, primaryBrokerChoice = Agent and primaryBroker is not specified.
| primaryBroker
|
| Anchor |
|---|
| primaryCluster - FT |
|---|
| primaryCluster - FT |
|---|
|
primaryCluster | Primary UDM Agent Cluster | If primaryBrokerChoice = Cluster: Agent Cluster to use for the Primary UDM Agent.
|
| Y (unless primaryClusterRef is specified) | primaryClusterRef |
| Anchor |
|---|
| primaryClusterRef - FT |
|---|
| primaryClusterRef - FT |
|---|
|
primaryClusterRef | Primary UDM Agent Cluster | If primaryBrokerChoice = Cluster: Name of a variable that will be resolved at run time to the name of the Primary UDM Agent Cluster to use.
|
| Y (unless primaryCluster is specified) | primaryCluster |
| Anchor |
|---|
| primaryCred - FT |
|---|
| primaryCred - FT |
|---|
|
primaryCred | Primary Credentials | If serverType = UDM; Primary user ID and password (local to the host on which the server is running) under which the transfer operation is being carried out. |
| N |
|
| Anchor |
|---|
| primaryCredVar - FT |
|---|
| primaryCredVar - FT |
|---|
|
primaryCredVar | Primary Credentials Variable | If serverType = UDM; Name of a variable that will be resolved at run time to the name of the Primary Credentials to use. |
| N |
|
| Anchor |
|---|
| primaryFilesys - FT |
|---|
| primaryFilesys - FT |
|---|
|
primaryFilesys | Primary File System | If serverType = UDM and formOrScript = Form; Type of file system on the Primary server. | Valid Values: html-bobswift<ul>
<li>
<li>
<li>
<li>
</ul>Default is - - None - - (0). | N |
|
| Anchor |
|---|
| primaryOpenOptions - FT |
|---|
| primaryOpenOptions - FT |
|---|
|
primaryOpenOptions | Append Primary Open Options | If serverType = UDM and formOrScript = Form; Any additional free form open command options for the Primary transfer server. |
| N |
|
| Anchor |
|---|
| remoteCredentials - FT |
|---|
| remoteCredentials - FT |
|---|
|
remoteCredentials | FTP Credentials | If serverType = FTP, SFTP, FTPS, or FTPES; Login credentials that the Agent will use to access the FTP or SFTP server machine. | If the File Transfer server and Agent are running on the same machine, enter the same credentials as those you entered in the Credentials field. | Y (unless remoteCredVar is specified)
| remoteCredVar
|
| Anchor |
|---|
| remoteCredVar - FT |
|---|
| remoteCredVar - FT |
|---|
|
remoteCredVar | FTP Credentials Variable | If serverType = FTP, SFTP, FTPS, or FTPES; Name of a variable that will be resolved at run time to the name of the FTP Credentials to use. |
| Y (unless remoteCredentials is specified) | remoteCredentials
|
| Anchor |
|---|
| remoteFilename - FT |
|---|
| remoteFilename - FT |
|---|
|
remoteFilename | Remote Filename | If serverType = FTP, SFTP, FTPS, or FTPES; Path and file name on the remote server (that is, the "transfer to" file name).
|
| Y |
|
| Secondary File(s) | If serverType = UMD; Specifies the File(s) on the Secondary UDM Agent. |
| Y - If
formOrScript = Form and udmOperation = Copy or Move. - If
formOrScript = Form, udmOperation = Copy Directory, and transferDirection = GET.
|
|
| Anchor |
|---|
| remoteServer - FT |
|---|
| remoteServer - FT |
|---|
|
remoteServer | Remote Server | If serverType = 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. You also can specify a non-standard FTP or SFTP port: - For FTP, specify the port number separated from the host name with a space: "some.server.com 2222".
- For SFTP, specify the port number separated from the host name with a colon: "some.server.com:2222".
| N |
|
| Anchor |
|---|
| retryExitCodes - FT |
|---|
| retryExitCodes - FT |
|---|
|
retryExitCodes | Retry Exit Codes | Exit code range for which an auto-retry of tasks in FAILED status will occur. | Range must be in the same format as exitCodes. | N |
|
| Anchor |
|---|
| retryIndefinitely - FT |
|---|
| retryIndefinitely - FT |
|---|
|
retryIndefinitely | Retry Indefinitely | Specification for whether or not the Controller should continue trying indefinitely to run this task. If you enable this field, it overrides any value placed in retryMaximum. | Boolean; Valid values: true/false. Default is false. | N |
|
| Anchor |
|---|
| retryInterval - FT |
|---|
| retryInterval - FT |
|---|
|
retryInterval | Retry Interval (Seconds) | Number of seconds between each retry. | Integer; Default is 60. | N |
|
| Anchor |
|---|
| retryMaximum - FT |
|---|
| retryMaximum - FT |
|---|
|
retryMaximum | Maximum Retries | Maximum number of times that the Controller should retry this task after it has started and gone to a FAILED state. | Integer; Default is 0. | N |
|
| Anchor |
|---|
| retrySuppressFailure - FT |
|---|
| retrySuppressFailure - FT |
|---|
|
retrySuppressFailure | Suppress Intermediate Failures | Specification for whether or not the following will be suppressed until all scheduled retry attempts have been made: - All Actions (Abort, Email Notification, Set Variable, SNMP Notification, and System Operation) to be made against the task instance.
- Workflow conditional path processing; any Successors waiting on a failure path will not be released.
- Task Monitors will not be notified of the Failed status. Also, any Task Monitor task that has a Time Scope in the past will disqualify any matching task instance in the past with a Failed status if the task instance is scheduled for automatic retry and for which Suppress Intermediate Failures has been enabled.
- Any Workflow containing the Failed task instance will not transition to the Running/Problems status.
| Boolean; Valid values: true/false. Default is false. | N |
|
| Anchor |
|---|
| runtimeDir - FT |
|---|
| runtimeDir - FT |
|---|
|
runtimeDir | Runtime Directory | If serverType = UDM; Directory from which the application should be executed. | Variables are supported. | N |
|
| Script | If serverType = UDM and formOrScript = Script; Name of a script to execute for this File Transfer task. |
| N |
|
| Anchor |
|---|
| secondaryBroker - FT |
|---|
| secondaryBroker - FT |
|---|
|
secondaryBroker | Secondary UDM Agent | If serverType = UDM; Name of the Agent resource defined in the Controller that provides details about the Secondary UDM Agent machine (secondary transfer server). |
| - Y
If secondaryBrokerChoice = Hostname or Agent Variable and formOrScript = Form
or
secondaryBrokerChoice = Agent, formOrScript = Form, and secondaryBrokerRef is not specified.
| secondaryBrokerRef
|
| Anchor |
|---|
| secondaryBrokerChoice - FT |
|---|
| secondaryBrokerChoice - FT |
|---|
|
secondaryBrokerChoice | Secondary UDM Agent Option | If serverType = UDM; Specification for how you will specify the Secondary UDM Agent. | Note |
|---|
| The Agent Variable value is valid for PUT/POST. GET will no longer support the Agent Variable (2) option. |
| Valid Values: - As String = None, As Value = 0
- As String = Agent, As Value = 1
- As String = Agent Variable, As Value = 2
- As String = Agent Hostname, As Value = 3
- As String = Agent Cluster, As Value 5
Default is Agent (1). | N |
|
| Anchor |
|---|
| secondaryBrokerRef - FT |
|---|
| secondaryBrokerRef - FT |
|---|
|
secondaryBrokerRef | Secondary UDM Agent | If serverType = UDM; Name of the Agent resource defined in the Controller that provides details about the Secondary UDM Agent machine (secondary transfer server). |
| - Y
If secondaryBrokerChoice = Agent, formOrScript = Form, and secondaryBroker is not specified.
| secondaryBroker
|
| Anchor |
|---|
| secondaryCluster - FT |
|---|
| secondaryCluster - FT |
|---|
|
secondaryCluster | Secondary UDM Agent Cluster | If secondaryBrokerChoice = Cluster: Agent Cluster to use for the Secondary UDM Agent.
|
| Y (unless secondaryClusterRef is specified) | secondaryClusterRef |
| Anchor |
|---|
| secondaryClusterRef - FT |
|---|
| secondaryClusterRef - FT |
|---|
|
secondaryClusterRef | Secondary UDM Agent Cluster | If secondaryBrokerChoice = Cluster: Name of a variable that will be resolved at run time to the name of the Secondary UDM Agent Cluster to use.
|
| Y (unless secondaryCluster is specified) | secondaryCluster |
| Anchor |
|---|
| secondaryCred - FT |
|---|
| secondaryCred - FT |
|---|
|
secondaryCred | Secondary Credentials | If serverType = UDM; Secondary user ID and password (local to the host on which the server is running) under which the transfer operation is being carried out. |
| N | secondaryCredVar
|
| Anchor |
|---|
| secondaryCredVar - FT |
|---|
| secondaryCredVar - FT |
|---|
|
secondaryCredVar | Secondary Credentials Variable | If serverType = UDM; Name of a variable that will be resolved at run time to the name of the Secondary Credentials to use. |
| N | secondaryCred
|
| Anchor |
|---|
| secondaryFilesys - FT |
|---|
| secondaryFilesys - FT |
|---|
|
secondaryFilesys | Secondary File System | If serverType = UDM and formOrScript = Form; Type of file system on the Secondary server. | Valid Values: | Html bobswift |
|---|
<ul>
<li>
<li>
<li>
<li>
</ul>Default is - - None - - (0). | N |
|
| Anchor |
|---|
| secondaryOpenOptions - FT |
|---|
| secondaryOpenOptions - FT |
|---|
|
secondaryOpenOptions | Append Secondary Open Options | If serverType = UDM and formOrScript = Form; Any additional free form open command options for the Secondary transfer server. |
| N |
|
| Anchor |
|---|
| serverType - FT |
|---|
| serverType - FT |
|---|
|
serverType | Transfer Protocol | Type of File Transfer server.
|
Valid Values: - As String = FTP, As Value = 1
- As String = SFTP, As Value = 2
- As String = UDM, As Value = 3
- As String = FTPS, As Value = 4
- As String = FTPES, As Value = 5
Default is FTP (1).
| N |
|
| Anchor |
|---|
| showProgress - FT |
|---|
| showProgress - FT |
|---|
|
showProgress | Show Progress | If serverType = UDM, formOrScript = form, and udmOperation = Copy, Move, or Copy Directory; Shows periodic file transfer progress messages in the UDM transfer output. | Boolean; Valid values: true/false. Default is false. | N |
|
| Anchor |
|---|
| transferDirection - FT |
|---|
| transferDirection - FT |
|---|
|
transferDirection | Transfer Direction | If serverType = UDM, formOrScript = form, and udmOperation = Copy, Move, or Copy Directory; Direction of the transfer between the Primary and Secondary UDM Agents. | Valid Values: As String = PUT, As Value = 1 As String = GET, As Value = 2
Default is PUT (1). | N |
|
| Anchor |
|---|
| transferMode - FT |
|---|
| transferMode - FT |
|---|
|
transferMode | Transfer Mode | If serverType = FTP, FTPS, or FTPES; Mode of transfer to use. | Valid Values: - As String = Active, As Value = 1
- As String = Passive, As Value = 2
- As String = Extended Passive, As Value = 3
Default is Passive (2). | N |
|
| Anchor |
|---|
| trimSpace - FT |
|---|
| trimSpace - FT |
|---|
|
trimSpace | Trim Trailing Spaces | If serverType = UDM and formOrScript = form; Specification for whether or the Controller should trim trailing spaces from lines on a text transfer. | Boolean; Valid Values: true/false. Default is false. | N |
|
| Anchor |
|---|
| udmOperation - FT |
|---|
| udmOperation - FT |
|---|
|
udmOperation | UDM Operation | If serverType = UDM; UDM Operation for this UDM File Transfer to use. | Valid Values:- As String = Copy, As Value = 1
- As String = Move, As Value = 2
- As String = Delete, As Value = 3
- As String = Rename, As Value = 4
- As String = List, As Value = 5
- As String = Copy Directory, As Value = 6
- As String = Create Directory, As Value = 7
- As String = Delete Directory, As Value = 8
Default is Copy (1). | N |
|
| Anchor |
|---|
| udmOptions - FT |
|---|
| udmOptions - FT |
|---|
|
udmOptions | Append UDM Options | If serverType = UDM; Any additional free-form Universal Data Mover command options. |
| N |
|
| Anchor |
|---|
| useRegex - FT |
|---|
| useRegex - FT |
|---|
|
useRegex | User Regular Expression | Specification for whether or not to enable the use of a regular expression. If serverType = FTP/SFTP/FTPS/FTPES, the use of regular expression is in localFilename. If serverType = UDM; - If
udmOperation = Copy or Move and transferDirection = PUT; the use of regular expression is in localFilename. - If
udmOperation = Copy or Move and transferDirection = GET; the use of regular expression is in remoteFilename. - If
udmOperation = Delete or List and localFilename is specified; the use of regular expression is in localFilename. - If
udmOperation = Delete or List and remoteFilename is specified; the use of regular expression is in remoteFilename.
| Boolean; Valid Values: true/false. Default is false. | N |
|
| Anchor |
|---|
| verifyHostName - FT |
|---|
| verifyHostName - FT |
|---|
|
verifyHostName | Verify Host Name | If serverType = FTPS or FTPES; Indication of whether to verify the DNS name or IP address of the FTP server's certificate against the host system. | Boolean; Valid Values: true/false. Default is false. | N |
|
