Overview

The FTP library enables the user to connect to a File Transfer Protocol server and perform all the fundamental actions within it, such as searching, downloading, uploading, deleting, or creating, both for files and directories.

The features provided by the FTP library are as follows:

Getting File: GetFTPFileList
Downloading File: DownloadFTPFile and DownloadFTPDirectory
Uploading and Deleting File: UploadFTPFile, UploadFTPDirectory, DeleteFTPFile and DeleteFTPDirectory

Common Properties

Common properties

CONNECTION

Configure settings related to accessing the FTP server.

Common	Properties	Type	Required	Unit	Auto-setting	Description
Y	Host	String	Y	-	N	Enter the URL of the FTP server that you want to connect to.
Y	UserName	String	Y	-	N	Enter the Username that is to be used to connect to the FTP session.
Y	Password	String	Y	-	N	Enter the password that is to be used to connect to the FTP session.Enter the password details : - Normal : The password input is saved as a plain text. - Credential : The password input is encrypted and retrieved from shared resources. - Secure : The password input is encrypted for saving.
Y	SecureFTP	Toggle Button	N	-	Y	Select whether to initiates a secure connection to the FTP server. If off, the standard connection protocol is initiated.

MORE OPTIONS

MORE OPTIONS properties
Properties	Type	Required	Unit	Auto-setting	Description
On Error	Combination box	N	-	N	Specify an action to carry out when an error occurs at the time of execution. - --Ignore--: Ignore the error. - --Retry--: Try the activity one more time. - --Goto--: Try the scenario for the specified time if the activity fails. - _Event: Select an event created within the project.

DESCRIPTION

Properties	Type	Required	Unit	Auto-setting	Description
DESCRIPTION	Text	N	-	N	Enter the description for the activity card. The Description entered in the DESCRIPTION field is used as an description of the property. A representative value will be displayed in the absence of the DESCRIPTION input.

GetFTPFileList

Overview

This activity card fetches the file list of a specified directory on FTP server.

Application procedures

In the [Output] Result field, enter the variable in which to receive the file containing all the DataTable variable found on the FTP server.
In the RemoteFilePath field, enter the FTP directory's path from where the file list needs to be retrieved.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Output] Result	Variable	Y	-	Y	Enter a variable to store the list of files found on the FTP server.
N	RemoteFilePath	String	Y	-	N	Enter the FTP directory's path from where the file list needs to be retrieved. If left blank the root directory is searched. If '/' is entered, the root directory is searched.
Y	CONNECTION	-	-	-	-	Common property of the FTP Library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FTP Library.
Y	DESCRIPTION	-	-	-	-	Common property of the FTP Library.

Example of utilization

GetFTPFile list outputs the content of the FTP remote path.

Sample file

Menu > Help > Samples > Sample > FTP > P_FTP_Test

Used variables

RESULT = Variable to receive the file containing all the DataTable that can be found on the FTP server.

Used properties

[Output] Result = RESULT
Host = this.var1
UserName = this.var2
Password = Enter the password
SecureFTP = Off
RemoveDirpath = ''

DownloadFTPFile

Overview

This activity card downloads the specified file from the FTP server to the specified local folder.

Application procedures

In the LocalDirPath field, enter the local path of the directory where the file is to be downloaded.
In the RemoteFilePath field, enter the file path of the FTP server from where the file is to be downloaded.
Set the OverWrite property to select whether to overwrite content in the destination path.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	LocalDirPath	String	Y	-	N	Enter the local path where the file is to be downloaded.
N	RemoteFilePath	String	Y	-	N	Enter the path on the FTP server from where the file is to be downloaded.
N	OverWrite	Toggle button	N	-	N	Select whether to overwrite the directory in the destination. RemotePath with the directory that is to be copied. (Defalut: Not Use - gray)
Y	CONNECTION	-	-	-	-	Common property of the FTP library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FTP library.
Y	DESCRIPTION	-	-	-	-	Common property of the FTP library.

Example of utilization

DownloadFTPFile is used to download the file from FTP remote path to the local path.

Sample file

Menu > Help > Samples > Sample > FTP > P_FTP_Test

Used variables

this.var1 = URL of the Host
this.var2 = Username for connecting to the host

Used properties

RemoveFilePath = Test1.pptx
Host = this.var1
UserName = this.var2
Password = Enter the password
SecureFTP = Off
LocalDirPath = 'C:\\'
Overwrite = No

Related/Similar activities

UploadFTPFile, GetFTPFileList, DeleteFTPFile

DownloadFTPDirectory

Overview

This activity cards downloads the specified directory from FTP server to the specified local folder.

Application procedures

In the LocalDirPath field, enter the local path where the files are to be downloaded.
In the RemoteDirPath field, enter the file path of the FTP server from where the files are to be downloaded.
Set the OverWrite property to select whether to overwrite the directory in the destination path.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	LocalDirPath	String	Y	-	N	Enter the local path where the files are to be downloaded.
N	RemoteDirPath	String	Y	-	N	Enter the path on the FTP server from where the files are to be downloaded.
N	OverWrite	Toggle button	N	-	N	Select whether to overwrite the directory in the destination. RemotePath with the directory that is to be copied. (Default : Not Use - gray)
Y	CONNECTION	-	-	-	-	Common property of the FTP library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FTP library.
Y	DESCRIPTION	-	-	-	-	Common property of the FTP library.

Example of utilization

DownloadFTPDirectory is used to download the directory from FTP remote path to the local path.

Sample file

Menu > Help > Samples > Sample > FTP > P_FTP_Test

Used variables

this.var1 = URL of the Host
this.var2 = Username for connecting to the host

Used properties

Host = this.var1
UserName = this.var2
Password = Enter the password
SecureFTP = Off
LocalDirPath = 'C:\\'
RemoveDirPath = 'dir3'
OverWrite = On

Related/Similar activities

UploadFTPDirectory, GetFTPFileList, DeleteFTPDirectory

UploadFTPFile

Overview

This activity card uploads a file to the FTP server.

Application procedures

In the LocalFilePath field, enter the local path of the file which is to be uploaded.
In the RemoteDirPath field, enter the destination path on the FTP server to which the file is to be uploaded.
Set the OverWrite property to select whether to overwrite the file in the destination path.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	LocalFilePath	String	Y	-	N	Enter the local path of the file which is to be uploaded.
N	RemoteDirPath	String	N	-	N	Enter the destination path on the FTP server to which the file is to be uploaded.
N	OverWrite	Toggle button	Y	-	N	Select whether to overwrite the file in the destination path. RemotePath with the file that is to be copied. (Default: Not Use - gray)
Y	CONNECTION	-	-	-	-	Common property of the FTP library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FTP library.
Y	DESCRIPTION	-	-	-	-	Common property of the FTP library.

Example of utilization

UploadFTPFile is used to upload a file from the local path to the FTP remote path.

Sample file

Menu > Help > Samples > Sample > FTP > P_FTP_Test

Used variables

this.var1 = URL of the Host
this.var2 = Username for connecting to the host

Used properties

LocalFilePath = 'C:\\Test1.pptx'
Host = this.var1
UserName = this.var2
Password = Enter the password
SecureFTP = Off
RemoteDirPath = ''
OverWrite = On

Related/Similar activities

GetFTPFileList, DownloadFTPFile, DeleteFTPFile

UploadFTPDirectory

Overview

This activity card uploads a directory to FTP server.

Application procedures

In the LocalDirPath field, enter the local path of the directory which is to be uploaded.
In the RemoteDirPath field, enter the destination path on the FTP server where the directory is to be uploaded.
Set the OverWrite property to select whether to overwrite the directory in the destination path.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	LocalDirPath	String	Y	-	N	Enter the local path of the directory that is to be uploaded.
N	RemoteDirPath	String	Y	-	N	Enter the destination path on the FTP server where the directory is to be uploaded.
N	OverWrite	Toggle button	N	-	N	Select whether to overwrite the directory in the destination path. (Default: Not Use - gray)
Y	CONNECTION	-	-	-	-	Common property of the FTP library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FTP library.
Y	DESCRIPTION	-	-	-	-	Common property of the FTP library.

Example of utilization

UploadFTPDirectory is used to upload the directory from the local path to the FTP remote path.

Sample file

Menu > Help > Samples > Sample > FTP > P_FTP_Test

Used variables

var1 = URL of the Host
var2 = Username for connecting to the host

Used properties

Host = this.var1
UserName = this.var2
Password = Enter the password
SecureFTP = Off
LocalDirPath = 'C:\\dir3'
RemoteDirPath = ''
OverWrite = Off

Related/Similar activities

DownloadFTPDirectory, DeleteFTPDirectory

DeleteFTPFile

Overview

This activity card removes a specified file from FTP server.

Application procedures

In the RemoteFilePath field, enter the path of the file on the FTP server to be deleted.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	RemoteFilePath	String	Y	-	N	Enter the path of the file on the FTP server to be deleted.
Y	CONNECTION	-	-	-	-	Common property of the FTP library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FTP library.
Y	DESCRIPTION	-	-	-	-	Common property of the FTP library.

Example of utilization

DeleteFTPFile is used to delete the file from FTP remote path.

Sample file

Menu > Help > Samples > Sample > FTP > P_FTP_Test

Used variables

this.var1 = URL of the Host
this.var2 = Username for connecting to the host

Used properties

RemoteFilePath = 'Test1.pptx'
Host = this.var1
UserName = this.var2
Password = Enter the password
SecureFTP = Off

Related/Similar activities

UploadFTPFile, DownloadFTPFile

DeleteFTPDirectory

Overview

This activity card removes a specified directory from FTP server.

Application procedures

In the RemoteDirPath field, enter the path of the directory on the FTP server to be deleted.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	RemoteDirPath	String	N	-	N	Enter the path of the directory on the FTP server to be deleted.
Y	CONNECTION	-	-	-	-	Common property of the FTP library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FTP library.
Y	DESCRIPTION	-	-	-	-	Common property of the FTP library.

Example of utilization

DeleteFTPDirectory is used to delete the directory from FTP remote path.

Sample file

Menu > Help > Samples > Sample > FTP > P_FTP_Test

Used variables

this.var1 = URL of the Host
this.var2 = Username for connecting to the host

Used properties

Host = this.var1
UserName = this.var2
Password = Enter the password
SecureFTP = Off
RemoteDirPath = 'dir3'

Related/Similar activities

UploadFTPDirectory, DownloadFTPDirectory