SFTP Get

Use this activity to download the file or the file content from the specified server. The content of the remote files can be placed in the activity’s output or written directly to local storage. If you choose to place the contents of a remote file into the activity’s output, you can only retrieve one remote file and the file’s content will be stored in memory as part of the activity’s output. If you choose to write the contents of the retrieved files to local storage, you can retrieve only one file.

Settings

The Settings tab has the following fields:

Field Description
SFTP Connection

Name of the SFTP connection.
Use Process Data

Specifies to use process data to get the content of the file from the remote server. If set to true, you can get the content of only one file from the remote server.

Note: You must set this field to true to allow the SFTP Get activity to work in TIBCO Cloud Integration.
Overwrite Existing File

Set Overwrite Existing File to true to overwrite any existing files with the same names on the local. If set to false, any attempt to write a file to disk with the same name as an existing file appends the data to the file.

This field is visible only when the Use Process Data is set to false.

Input

The Input tab has the following fields:

Field Description
Remote File Name The path and name of the file to place onto the remote server.
Local File Name

The path and name of the local file.

Note: This input item is not available when the Use Process Data on the Settings tab is set to true.

Output

The Output tab displays the output schema of the activity as a tree structure and it is read-only. The properties that are displayed in the schema correspond to the output of this activity and can be used as input by subsequent activities in the flow.

Field Description
Binary Data Specifies to receive the file content in binary mode. Available only when Use Process Data is set to true.
Files Transferred A repeating element containing the File Name and Number of Bytes (file size) that were transferred.
File Name The path and name of the retrieved remote file.
Number of Bytes The number of bytes in the associated file name.

Loop

The Loop tab is useful when an activity needs to use the loop feature to do batch processing or fetch multiple records by running the activity multiple times. With each iteration of the activity, the output is available for mapping to the activity input.

Field Description
Type

You can select type of loop.

Note: The default type is None, which means the activity does not iterate.
Iterate You can enter a number that represents the number of times you would like the activity to iterate without considering any condition for iterating.
Repeat while true You can select this type if you want to set up a condition for the iteration.