Reference: |
The FTP Read Document service is used to read files from a FTP server.
To configure a FTP Read Document service:
For a complete description of the configuration parameters that are available for the FTP Read Document service, see FTP Read Service Parameters.
For a complete description of the edges that are returned by the FTP Read Document service, see FTP Read Service Edges.
The following table lists and describes parameters for the FTP Read Document 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 |
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. |
Service Parameters |
|
File Name Tag |
Name of the tag from the input document in which to find the file name. |
Enclose 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. |
Base Path |
Optional directory to be used if the incoming name is not absolute. The user can use this parameter to specify a directory entry that will be combined with the File Name, obtained from the File Name Tag, to create a path to the file on the FTP server. |
Input Data Format |
This parameter is the format of the input data. The default setting is flat.
|
Transfer Mode |
This is a form of FTP transmission. Select one of the following modes:
|
Encoding |
This parameter is the character set encoding to be performed on input. Select one of the following options:
|
Delete After Read |
Use this parameter if you wish to delete the file after the read. |
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.
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:
|
Keystore File or Keystore Security Provider |
In this field, you can:
|
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. |
The following table lists and describes the edges that are returned by the FTP Read Document 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:
|
fail_operation |
Invalid parameters or other error. |