FTP Scope

Created by akaBot Support, Modified on Fri, 27 Dec, 2024 at 4:29 PM by akaBot Support

TABLE OF CONTENTS

Activity program name
Description
Properties
How to use

1. Activity program name

RCA.Activities.FTP.WithFTPSession

2. Description

Up to Studio version 2.0.2.0
Quick Access: "Toolbox" > "FTP" > "FTP Scope"

From Studio version 2.0.3.0
Quick Access: "Toolbox" > "FTP" > "FTP Scope"

This activity provides a container for connecting to an FTP server and performing multiple actions within it. Additionally, it helps to establish an FTP session by specifying and validating connection details. First, you need to establish a session with this activity before executing other FTP actions.

Tested on Studio version: 2.2.0.5
Note: Text and descriptions may vary slightly depending on the version.

3. Properties

Property Item	Property Name	Input Field	Description
Server	Port	Enter value (Int32)	Set the port to connect to the FTP server.
Server	Host	Enter value (String)	Set the IP or address of the FTP server.
Security	FTPS Mode	Dropdown selection	Select the FTPS mode for the FTP session: None, Explicit, or Implicit.
	Use SFTP	Checkbox	Set this if using SFTP.
	SSL Protocol	Dropdown selection	Set the SSL protocol for the FTP session: TLS1.0, Default, TLS1.1, or TLS1.2.
	Client Certificate Path	Enter value (String)	Set the path where the certificate file is stored.
	Client Certificate Password	Enter value (String)	Set the password for the certificate file.
	Accept All Certificates	Checkbox	Check to automatically accept all certificates required for the FTP session.
Misc	Continue On Error	Enter value (Boolean)	If checked, the process will continue after an error.
	Public	Checkbox	If checked, variables and arguments within the activity are written to log files and pushed to Center.
	Display Name	Any string	Reflected in the activity name on the Designer panel.
Credentials	Password, Username	Enter value (String)	Set the password and username to log into the FTP server.
Credentials	Use Anonymous Login	Checkbox	Use if the FTP server allows anonymous login. If not allowed, uncheck this.

4. How to use

An explanation based on the actual use case of the "FTP Scope" activity.

Example: Connecting to an FTP server.

Let's assume the following FTP server information for this example:

Port to connect to the FTP server: 21
Host to connect to the FTP server: 12.34.56.78 or ftp.myhost.com
Username to connect: UserNameForFTPSite
Password to connect: P@ssW0rd123
Connection Method: Anonymous connection (no SSL authentication)

Drag and drop the "With FTP Session" activity from "FTP" into the Designer panel.

Next, set the properties as follows for this example:

Property Name	Set Value
Server	Port: 21
Server	Host: "12.34.56.78"
Credentials	Password: “P@ssW0rd123”
	Username: “UserNameForFTPSite”
	Use Anonymous Login: Checked

It is recommended to store values like passwords in String variables and reference those variables in the properties.

If SSL connection is used, adjust the "Security" properties according to your environment.

Save and click "Home > Start" or press "F5" to execute. If all property settings are correct, the execution will complete without errors.