Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
|---|
| Anchor |
|---|
| authenticatePeer - FTP |
|---|
| authenticatePeer - FTP |
|---|
|
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 |
|---|
| ftpFmtype - FTP |
|---|
| ftpFmtype - FTP |
|---|
|
ftpFmtype | Monitor Type | Type of file event being monitored for. | Valid values: - As String = Exist, As Value = 1
- As String = Missing, As Value = 2
Default is Exist (1). | N |
|
| Anchor |
|---|
| jobcard - FTP |
|---|
| jobcard - FTP |
|---|
|
jobcard | Job Card (z/OS only) | For z/OS; Job card information for the JCL statement. |
| N |
|
| Anchor |
|---|
| listOptions - FTP |
|---|
| listOptions - FTP |
|---|
|
listOptions | Additional FTP Commands | If servertype = FTP, FTPS, or FTPES; Allows you to add statements to the FTP script that control the format of the file list returned by the task. | (See Additional FTP Commands in Remote File Monitor task.) | N |
|
| Anchor |
|---|
| minFileScale - FTP |
|---|
| minFileScale - FTP |
|---|
|
minFileScale | Minimum File Scale | If ftpFtype = Exist(1); Scale for the minimum file size. | Valid values: - As String = Bytes, As Value = 0
- As String = KB, As Value = 1
- As String = MB, As Value = 2
Default is KB (1). | N |
| Anchor |
|---|
| minFileSize - FTP |
|---|
| minFileSize - FTP |
|---|
|
minFileSize | Minimum File Size | If ftpFmtype = Exist (1); Minimum file size. |
| N |
outputFailureOnly
| Failure Only | If outputReturnType = STDOUT (2), STDERR (3), or OUTERR (6), and waitForOutput is false; Indication for whether output should be retrieved on task failure only. | Boolean; Valid values: true/false. Default is false. | N |
outputReturnNline
| Number of Lines | If outputReturnType is STDOUT (2), STDERR (3), or OUTERR (6); Allows you to limit the retrieved data to the number of lines specified. | Integer; Default is the value of the Retrieve Output Default Number Of Lines Universal Controller system property. | N |
outputReturnSline
| Starting Line | If outputReturnType is STDOUT (2), STDERR (3), or OUTERR (6); Allows you to instruct the Controller to retrieve data beginning at this line. | Integer; Default is 1. | N |
outputReturnText
| Scan Text | If outputReturnType is STDOUT (2), STDERR (3), or OUTERR (6); Instructs the Controller to scan the data for the text specified and retrieve only that. | The Controller will process this field as a regular expression. | N |
outputReturnType
| Automatic Output Retrieval | Specification for whether you want the Controller to automatically retrieve any output from the job and attach it to the task instance record. | Valid values: As String = NONE, As Value = 1 As String = STDOUT, As Value = 2 As String = STDERR, As Value = 3 As String = OUTERR, As Value = 6
Default is NONE (1). | Note |
|---|
If outputReturnType is not NONE (1), the web service will fail with Start Failure if outputProhibited is true for the specified agent. |
| N |
| Anchor |
|---|
| pollInterval - FTP |
|---|
| pollInterval - FTP |
|---|
|
pollInterval | Poll Interval (Seconds) | If wait = true; Frequency, in seconds, in which the Remote File Monitor will check to see if the file exists or is missing. | Integer; Default is 30. | N |
|
| Anchor |
|---|
| pollMaximum - FTP |
|---|
| pollMaximum - FTP |
|---|
|
pollMaximum | Maximum Polls | If wait = true; Maximum number of times that the Remote File Monitor will check to see if the file exists or is missing. | Integer. | N |
|
| Anchor |
|---|
| remoteCredentials - FTP |
|---|
| remoteCredentials - FTP |
|---|
|
remoteCredentials | FTP Credentials | 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. | N | remoteCredVar
|
| Anchor |
|---|
| remoteCredVar - FTP |
|---|
| remoteCredVar - FTP |
|---|
|
remoteCredVar | FTP Credentials Variable | Name of a variable that will be resolved at run time to the name of the FTP Credentials to use. |
| N | remoteCredentials
|
| Anchor |
|---|
| remoteFilename - FTP |
|---|
| remoteFilename - FTP |
|---|
|
remoteFilename | Remote Filename (FTP) | Path and file name on the remote server. |
| N |
|
| Anchor |
|---|
| remoteServer - FTP |
|---|
| remoteServer - FTP |
|---|
|
remoteServer | Remote Server (FTP) | Name or IP address of the remote server. | This machine may or may not be the same as the Universal 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 |
|---|
| servertype - FTP |
|---|
| servertype - FTP |
|---|
|
servertype | Server Type | | Valid values: - As String = FTP, As Value = 1
- As String = SFTP, As Value = 2
- As String = FTPS, As Value = 4
- As String = FTPES, As Value = 5
Default is FTP (1). | N |
|
| Anchor |
|---|
| stableSeconds - FTP |
|---|
| stableSeconds - FTP |
|---|
|
stableSeconds | Stable (Seconds) | If wait is true; Period of time, in seconds, during which the file has not changed. | Integer. | N |
|
| Anchor |
|---|
| TransferMode - FTP |
|---|
| TransferMode - FTP |
|---|
|
transferMode | Transfer Mode | Transfer mode to use. | Valid values: - As String = Active, As Value = 1
- As String = Passive, As Value = 2
- As String = Extended Passive, As Value = 3
| N |
|
| Anchor |
|---|
| useRegex - FTP |
|---|
| useRegex - FTP |
|---|
|
useRegex | Use Regular Expression | Enables the use of a regular expression in remoteFilename. | Boolean; Valid values: true/false. Default is false. | N |
|
| Anchor |
|---|
| verifyHostName - FTP |
|---|
| verifyHostName - FTP |
|---|
|
verifyHostName | Authenticate Peer | 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 |
|
| Wait until Satisfied | If true, the task instance starts and continues to run until one of the following events occurs: - If
ftpFmtype = Exist and the specified file exists or appears, the task instance completes with a status of SUCCESS. - If
ftpFmtype = Missing and the specified file does not exist or exists then disappears, the task instance completes with a status of SUCCESS.
If false, the task instance: - Starts.
- Checks for the existence of the file.
- Takes one of the following actions:
- If
ftpFmtype = Exist and if the file exists, the task instance completes with a status of SUCCESS. - If
ftpFmtype = Exist and if the file does not exist, the task instance completes with a status of FAILURE. - If
ftpFmtype = Missing and if the file exists, the task instance completes with a status of FAILURE. - If
ftpFmtype = Missing and if the file does not exist, the task instance completes with a status of SUCCESS.
| Boolean; Valid values: true/false. Default is false. | N |
|
