SFTPScope

Estimated reading: 3 minutes

This activity helps the user to connect to an SFTP server using a username and password. It allows users to upload, download, create, delete, and check files or directories. Once authenticated, the credentials apply to all related actions, avoiding repeated logins.

Properties

INPUT

HostName: *Specifty the address of the “SFTP Server” to connect with and execute actions from within. It typically refers to the “Domain” or “IP Address” of the server and it accepts input values in “String” datatype.

Password: *Specify the “Password” for the provided server, allowing access and authentication to the specified SFTP server. It accepts values in “String” datatype.

PortNumber: *Specify the network port number that is used to establish a connection between the system and SFTP server. It accepts values in “Integer” datatype.

Username: *Specify the Username for the provided server, allowing access and authentication to the specified SFTP server. It accepts values in “String” datatype.

MISC

Body: Gets auto filled once the “Activity” is dropped into the body.

DisplayName: Displays the name of the activity. The activity name can be customized, which aids in troubleshooting.

SkipOnError: Specify the “Boolean” value as “True” or “False.”

True: Continue executing the workflow regardless of any errors thrown.
False: Halt the workflow if it encounters any errors.
None: If the option is left blank, the activity will, by default, behave as if “False” were chosen.

Version: It indicates the version of the feature being used.

OUTPUT

Result: This parameter allows you to view the execution status of the activity and returns a value in “Boolean”.
True: Indicates that the activity has been executed successfully without any errors.
False: Indicates that the activity has been unsuccessful due to an unexpected error being thrown.

* Represents mandatory fields to execute the workflow.

Execution of activities

The user needs to provide the server credentials to authenticate the SFTP server. Once authenticated, proceed to drag and drop the necessary activities inside the scope.

To learn how to execute these activities, follow these steps:

Utilize “SFTP Scope”: Drag and drop the “SFTP Scope” activity into the workflow.
Enter Server Credentials: Provide the required server credentials, including the servername, username, and password, to establish a secure connection to the SFTP server.
Configure Additional Settings: Adjust other relevant settings such as port number, if needed.
Drag and Drop Activities: Add the desired activities within the SFTP scope to perform file operations such as uploading, downloading, or deleting files.
Execute the Activities: Once the activities are configured, execute the workflow to perform the defined operations on the SFTP server.

For detailed instructions and examples on executing these activities, click here.

SFTPScope

Properties

Execution of activities

SFTPScope

CONTENTS