SFTP Put

The SFTP Put activity issues an SFTP put or mput command to the specified server.

General

The General tab has the following fields.

Field Literal Value/Module Property Description
Name No The name to be displayed as the label for the activity in the process.
SFTP Connection Yes

The path to the shared configuration resource containing the user information such as Host, Port, and User Name.

For configuration details, refer to SFTP Connection.

Quit (post-command) No When this check box is selected, it specifies that the SFTP Connection should be closed after completing this command.

If this check box is not selected, the SFTP Connection remains open so that all SFTP activities specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed.

Use Process Data No Specifies to use process data as the content of the file to place on the remote server. If this check box is selected, you can place only one file on the remote server.
Important: You must select this check box to allow the sFTP Put activity to work in TIBCO Cloud Integration.
Binary No Specifies whether to send the file content in binary or ASCII mode (selected signifies binary).

When ASCII mode is used, differences in line endings between the SFTP server and the machine executing the SFTP command are automatically handled. Also, the ASCII mode implies text data and that data can be encoded in a character encoding other than ASCII (such as UTF-8 or Latin-1).

Overwrite Existing File No Selecting this check box overwrites any existing files on the SFTP server, if the SFTP command sends files with the same names.

If this check box is not selected, any attempt to send a file to the remote server with the same name as an existing file throws an exception.

Persist Timestamp while Copy File No Selecting this check box specifies that the original time stamp of file persists while transferring the original/source file from the remote machine to local machine.
Append No This option is only available when the Overwrite Existing File check box is not selected.

This specifies whether to append data to an existing file. If the specified file exists on the SFTP server, append the data to the file when this check box is selected.

Timeout (msec) Yes The amount of time to wait (in milliseconds) for the SFTP server to respond. This timeout is used when the SFTP server places the SFTP connection used by this activity into a waiting state. Default is 120000.

This overrides the value specified in the SFTP Connection shared resource.

Description

Provide a short description for the activity.

Input

The following is the input for the activity.

Input Item Datatype Description
RemoteFilename string The path and name of the file to place onto the remote server. Wildcards are not permitted in this field.
LocalFilename string

The path and name of the local file to use in the SFTP put command.

Note: This input item is not available when the Use Process Data check box on the General tab is selected.
Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection shared resource.
Port integer The port number for incoming SFTP requests on the SFTP server. This value overrides the value specified in the SFTP Connection shared resource.
UserName string The username for logging into the SFTP server. This value overrides the value specified in the SFTP Connection shared resource.
Password password The password for logging into the SFTP server. This value overrides the value specified in the SFTP Connection shared resource.
Timeout integer The amount of time to wait for the SFTP server to respond. This timeout is used when the SFTP server places the SFTP Connection used by this activity into a waiting state.

This overrides the value specified in the SFTP Connection shared resource.

Output

The output for the activity is the following.

Output Item Datatype Description
FilesTransferred complex A repeating element containing the file name and NumOfBytes (file size) that were transferred.

If an error occurred while transferring files, the activity output is not available. However, the Fault tab lists the successfully transferred files and the files that failed to be transferred.

Name string The name of the remote file transferred.
NumOfBytes integer The number of bytes contained in the associated file name.

Fault

The Fault tab lists the possible exceptions thrown by this activity.

Exception Thrown When..
PutFilesException An error occurs during the SFTP put operation.
ConnectionErrorException An error occurs when connecting to the SFTP server.
CommandExecutionException An error occurs when executing the SFTP command.
ConnectionTimeoutException The connection to the SFTP server has timed out before the command has completed it execution.