Configuring a FTP File Read for Process Flows Service

Configuration parameters for FTP File Read for Process Flows service

Host Name

In this field, enter the DNS name (or IP address) of the FTP server that you wish to connect to. Use the host port if the standard port is not 21.

Remote Port

The port to connect to on the FTP site. Leave it blank for default port 21.

User Name

Name used as the valid user ID on the FTP server.

Password

The valid password for the FTP server.

Account Name

The valid account for the FTP server.

Use Passive Command

Select from the following:

• true: uses a PASV command.
• false: uses the PORT command.

Timeout

Timeout interval for socket in seconds.

Agent Parameters

Name of File

Name of the tag from the input document in which to find the file name.

Delete After Read

Use this parameter if you wish to delete the file after the read. Select from the following:

• true: delete the file when successfully read.
• false: do not delete the file after reading.

Format

This parameter is the format of the input data. The default setting is flat.

• flat. The data is transferred from the FTP server as a flat unformatted document.
• XML. The data is transferred from the FTP server as a text formatted document. The data that is transmitted is assumed to be a valid XML document and is parsed. If the document is not valid then an error is returned by the service.

Transfer Mode

This is a form of FTP transmission. Select one of the following modes:

• ascii. The file is retrieved as text from the FTP server. The data received by iSM is translated into text, based on the code page configuration of iSM.
• binary. The file is retrieved as a binary block. No text translation is performed by iSM.

Tag

This parameter is the name of the tag that encloses data read. If omitted, no tagging of the data is done. If used, the output is an XML document. If the Transfer Mode is binary and the Enclose Tag is specified, the base64 Encoding should be selected or else the user risks getting an error when the resulting XML document is parsed.

Encoding

This parameter is the character set encoding to be performed on input. Select one of the following options:

• asis. The data from the FTP server is not translated.
• base64. The data from the FTP server is converted into a base 64 XML compatible string.

Embed

Whether to embed the contents of the file that is read into the input document. Select from one of the following:

• true: the file will be embedded into the current input document within the parent tag specified.
• false: the document that is read replaces the input document. The old input document is discarded.

Parent Tag

Where within the input document the file data should be embedded. Needed when Embed is set to true.

Note: When embedding a file that is read into a valid xml document the file that is read must either be a valid XML (structure sans the XML declaration statement; i.e. <?xml …?>), or must be wrapped in a Tag.

Action on Failure

Determines whether the input document or status document is returned on failure. Select one of the following options from the drop-down list:

• status. Creates a status document for the return.
• input. Returns the inbound document.

Retry

Retries the operation at the specified number of times (in seconds).

SSL Parameters

Use SSL

If set to true, the connection is secured using Secure Sockets Layer (SSL).

Security Protocol

This shows the type of security protocol to be used. The following list describes the options of the security protocol.

• SSL. This protocol supports some versions of SSL, and may also support other versions.
• SSLv2. This protocol supports SSL version 2 or higher.
• SSLv3. This protocol supports SSL version 3, and may support other versions.
• TLS. This protocol supports some versions of TLS, and may also support other versions.
• TLSv1. This protocol supports TLS version 1, and may support other versions.

This field is not needed if Keystore is a SSL Provider.

Secure Data Connection

This is used to enable a secure data connection, for example. transfer data securely. It is used in conjunction with Secure Control Connection.

Use 128-bit Encryption

This parameter enforces the use of 128-bit encryption.

SSL Security (required)

This parameter describes the FTP Server connection type. Select one of the following options:

• Unknown. This setting defaults to Explicit Security then fails over to Implicit Security.
• Explicit. In order to establish the SSL link, explicit security requires that the FTP client issue a specific command to the FTP server after establishing a connection. The default FTP server port is used.
• Implicit. Implicit security automatically begins with an SSL connection as soon as the FTP client connects to an FTP server. In implicit security, the FTP server defines a specific port for the client (typically 990) to be used for secure connections.

Keystore File or Keystore Security Provider

In this field, you can:

• Enter the full path to the Keystore file, which provides certificate material to be used for SSL connection.
• Name the Keystore Security Provider.
• Use the configured default Keystore Security Provider by leaving it blank.

Keystore Password

This field is used to enter the password to access Keystore File. This is not required if Keystore File or Keystore Security Provider is the name of a Keystore Security Provider.

Keystore Type

This field shows the type of the Keystore. It is not needed if Keystore File or Keystore Security Provider is the name of a Keystore Security Provider.

success

Operation completed successfully.

fail_parse

Failed to properly parse the input parameters of the service.

fail_connect

Failed to connect to FTP host for any one of the following reasons:

• The host name (IP) is invalid.
• The User ID is invalid.
• The password of the user is invalid.
• The connection failed.

fail_operation

Invalid parameters or other error.