Configuring a FTP SREG Service

Reference:

The FTP SREG service sets Special Registers (SREGs) on the FTP Server. This service is used only with the iWay FTP Server extension and FTP Server channel. The identified special registers are sent to the server using a SITE command. This facility is used when programming process flows for the Managed File Transfer capability of iWay Service Manager.

Note: This service has no meaning with non-iWay FTP servers and should not be used with non-iWay FTP servers.

To configure a FTP SREG service:

  1. Perform the steps as described in Configuring Services.
  2. Ensure that you select FTP SREG Agent {com.ibi.agents.XDFTPSREGAgent} as the service type you are configuring.

    For a complete description of the configuration parameters that are available for the FTP SREG service, see FTP SREG Service Parameters.

    For a complete description of the edges that are returned by the FTP SREG service, see FTP SREG Service Edges.

Reference: FTP SREG Service Parameters

The following table lists and describes parameters for the FTP SREG service.

Parameter

Description

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

The 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

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

SREGs

Type of variable

This parameter shows the type of variable to be used (headers appear in emitted documents as header values).

  • user. Temporary variable definition for general use.
  • doc. Temporary variable definition associated with a document.
  • hdr. Temporary variable to be included in message headers.

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

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.

Reference: FTP SREG Service Edges

The following table lists and describes the edges that are returned by the FTP SREG service.

Edge

Description

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.