Put multiple documents operation

Uploads one or more document values to the FTP server. The document values must be stored in a list or map value.

For information about the General and Route Evaluation property groups, see Common operation properties.

File Options properties

Properties that identify the documents to upload to the FTP server.

Documents

A list or map value that holds one or more document values that you want to upload to the FTP server.

If you specify a map value, the keys are used as the file names for the documents.

If you use a list value, the file names are based on the properties of the document values in the list.

Remote Directory Path

A string value that represents the directory on the FTP server where you want to save the uploaded files. The path must contain a closing slash, for example, /temp/input/.

File Transfer Mode

A TransferModeEnum value that represents the format of the file data that is transferred. Valid values are Binary and ASCII.

You should use binary transfer mode only if you are certain that the computer that runs the LiveCycle Server and the FTP server interpret ASCII characters in the same way. For example, different types of computer systems interpret the end-of-file character differently. Transferring text files from one computer type to another can result in nonsensical characters being inserted at the end of the file.

However, transferring files in ASCII mode is marginally faster than transferring in binary mode.

Connection Settings properties

Use the Connection Settings properties to specify information required for connecting to the FTP server.

Use Configuration Options

A boolean value that specifies whether to use the settings in the service configuration instead of the settings specified in the properties of the operation. A value of True means to use the default connection settings configured for the FTP service. A value of False means to use the settings configured in the properties for the operation.

If you use a literal value to configure this property, selecting the Use Configuration Options check box means to use the default connection properties that are set for the FTP service. If you want to use the connection settings specified in the operation, deselect the Use Configuration Options check box

Host

A string value that represents the IP address or URI. For example, you can use the name of the computer that is resolved by Domain Naming Scheme (DNS).

Port Number

An int that represents the port number for transferring files. The default port number is 21.

User

A string value that represents the user name to connect to the FTP server. No default is provided.

Password

A string value that represents the password to use for authenticating with the FTP server. No default is provided.

Result properties

Properties that specify where to save the operation results.

Result

The location to save the operation result. The data type is boolean. A value of True indicates that the file was transferred. A value of False indicates that the file could not be transferred.

Exceptions

The exception event attached to this operation can receive FTPConnectionException, FTPFileUnavailableException, IllegalArgumentException, and IOExceptionexceptions.