Configuring a FTP File Emit Service

Host Parameters

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

This is 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

If set to true, the service uses a PASV command. Otherwise, it uses the PORT command.

Timeout

Timeout interval for socket in seconds.

Retry Interval

Retry interval in seconds (allows xxhxxmxxs format). You can omit or use 0 for no retry.

Connection Retry

This shows the number of attempted failed connections to the FTP server.

Agent Parameters

Input Source

Allows you to configure the source of the input. Select one of the following input source values from the drop-down list:

• Document. Input source is from the document, which is passed on the edge of the process flow. This input source (Document) is also the default value.
• External File. Input source is from an external source (MFT use). If selected, then you must configure the Input Expression parameter to specify an external source.
• Stream. Uses the stream from the configuration of the listener as the input source. If the listener can be configured to pass the document as a stream (or uses a preparser that results in a stream being passed), then this value allows that stream to be emitted.

Input Expression

If the input source is external, specify the file name here.

Remote Site Folder

Folder or directory on the FTP site that you want to use as a starting location when you connect. If you leave it blank, the login directory is used.

File Pattern

This shows the output file pattern (* = timestamp). For example, (*.xml, *.txt, and so on).

Note: *.* is unsupported.

Behavior When Target File Exists

The action to be performed if the file exists on the FTP server. Select one of the following options:

• overwrite. The existing file on the server will be replaced with input.
• append. Input will be added to the end of the existing file.
• resume. If server supports REST and SIZE commands, iSM will determine the size of the file on the server using the SIZE command, and then send the REST command with the current file size. The input data is then sent starting at this position. The resume option is only supported for binary mode transfers.
• fail. Generate a failure document and exit.

Quote Command

The entered command is sent as typed, before any data transfer.

Transfer Mode*

This mode is a form of FTP Transmission. Choose one of the following options:

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

Put File Protection

Determines whether the PUT parameter is protected by a rename of a temporary file name. Choose one of the following options:

• true. If set to true, the file is written to a temporary file name. When the transfer of data is complete, the temporary file on the server is renamed to the final file name
• false. If set to false, the existing file contents (if applicable) are directly replaced with the input data.

Emit Zero Bytes

Allow the Emitter to transmit zero bytes to the server. This flag will be ignored if the document to be emitted is a stream.

Return

Select what the service returns when execution completes:

• status. A status document will be the out document. This document reflects the status of the transfer to the FTP server.
• input. The input document becomes the out document.

Proxy Settings

Proxy Type

Select one of the following proxy protocol values to use fromthe drop-down list:

• NONE
• HTTP
• SOCKS4
• SOCKS5

Proxy Host Name

DNS name (or IP address) of the Proxy server that you wantto connect to.

Proxy Port

Port to connect to on the Proxy site.

Proxy User ID

User ID on the Proxy server.

Password

The password of the proxy user on the Proxy server.

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, such as transferring 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

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.

SITE Parameters

Starting SITE command

The SITE command to issue before the transfer of data.

Successful SITE command

The SITE command to issue after the successful transfer of data.

Error SITE Command

The SITE command to issue if the transfer of data fails.

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.

fail_duplicate

Failed to duplicate the message.