Activities

Connect to FTP
Disconnect from FTP
Create Folder
Delete File
Delete Folder
Download File
List Files/Folders
Rename File or Folder
Resume File Upload
Synchronize Folder/File
Upload File

NOTE: A free hosted FTP was used for all the examples regarding the FTP activities usage.

Connect To FTP

This activity connects to the specified FTP Server.

Activity Parameters

The Connect to FTP activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Host (text box editor type) (type: string): the FTP host.
Password combo box control): the password for the provided username.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password. (This parameter is used only when the user wants to send an encripted password from outside the workflow, for example Flowster Portal).
Username (text box editor type) (type: string): the username for authentication. If left empty, windows session credentials are used. For example, in the screen above there can be seen "flowster.orgfree.com" username, used for the given FTP host.

The Read Only Output variable are the possible output values that the activity will provide:

Connection (type: object): outputs a FTP connection. The output of this activity should be used as Input for all Connection parameters used for all activities placed under FTP category.

Disconnect from FTP

This activity disconnects from the specified FTP Server.

Activity Parameters

The Disconnect from FTP activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: object): the output from a Connect to FTP activity.

Create Folder

This activity creates a folder on a FTP server.

Activity Parameters

The Create Folder activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

New Directory (text box editor type) (type: string): the absolute path of the folder to create. Absolute paths can be used provided the FTP server supports this feature. E.g. 'Flowster FTP Folder'.

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs the result status. If the folder was created successfully then TRUE, otherwise FALSE.

Execution: the activity will create the folder on the given FTP host (provided in the Connect To FTP Server activity):

The new folder can be seen on the FTP Server (for testing purposes FileZilla was used):

Delete File

This activity deletes a file on an FTP server.

Activity Parameters

The Delete File activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

File Path (text box editor type) (type: string): the absolute path of the file to be deleted. E.g. "Flowster FTP Folder/Flowster Designer.pdf"'.

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs the result status. If the file was deleted successfully then TRUE, otherwise FALSE..

Execution: the activity will search for the given folder and file. If found, will delete the file from the remote FTP folder:

On the FTP Server there can be seen that the file was deleted:

the folder before file deletion:
the folder after file deletion:

Delete Folder

This activity deletes a folder on an FTP server.

Activity Parameters

The Delete Folder activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Delete Children (combo box editor type) (type: string): select True if the activity should delete the given folder's content or False if otherwise.
Folder Path (text box editor type) (type: string): the absolute path of the folder to delete. E.g. 'Flowster FTP Folder'.

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs the result status. If the folder was deleted successfully then TRUE, otherwise FALSE.

Execution: the activity will search for the given folder and if found, will delete it from the remote FTP folder:

Download File

This activity downloads File(s) from an FTP server.

Activity Parameters

The Download File activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Destination Folder Path (text box editor type) (type: string): a local path where the file(s) will be downloaded from the given FTP server. Can be manually inserted or selected by clicking the button
Remote File Path (text box editor type) (type: string): the absolute path of the file to be downloaded (e.g. "Flowster FTP Folder/Flowster Designer.pdf") or the absolute path to a folder. If a folder was given (in the screen above there can be seen the path to the "Flowster FTP Folder" folder), then all the files that are included in the main folder and in the sub-folders will be downloaded at the given local path.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Download File activity:

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs the result status. If the file was downloaded successfully then TRUE, otherwise FALSE.

Execution: depending on the given values (file or folder), the activity will start downloading the content to the selected local folder (single file or multiple files):

List Files/Folders

This activity lists the folders and files in the specified folder path.

Activity Parameters

The List Files/Folders activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Detailed Output (combo box control) (type: string): whether to list the details of the files and folders. By default the field is set to False, which means that the results will contain only the name of the file or folder. If set to True, details like Type, Size, Last Modified, Rights will be also retrieved.
Directory Path (text box editor type) (type: string): the path of the folder to list the contents of. If using "/", the all files and folders will be retrieved from the FTP root parent. Here can also be typed names for folders where the activity should do the search.

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: array<string>): outputs an array of strings containing details about the files and folders found.

Execution: the activity will perform the search in the given directory (in this example the root is used, /):

Rename File or Folder

This activity renames a file or folder on an FTP server.

Activity Parameters

The Rename File or Folder activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

New Name (text box editor type) (type: string): the new name of the file or folder. For example, "Flowster" (if a folder will be renamed) or "Flowster Designer - new document.pdf" (if a file will be renamed).
Path (text box editor type) (type: string): the absolute path of the file or folder to rename. E.g. 'Flowster FTP Folder' (if a folder will be renamed) or 'Flowster FTP Folder/Flowster Designer.pdf' (if a file will be renamed).

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs the result status. If the renaming was completed successfully then TRUE, otherwise FALSE.

Execution: the activity will search for the given folder or file. If found, will rename the object (file or folder) from the remote FTP folder:

On the FTP Server there can be seen that the folder was renamed:

the folder before folder rename:
the folder after folder rename:

Resume File Upload

This activity resumes a file upload on a FTP server.

Activity Parameters

The Resume File Upload activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Local File (text box editor type) (type: string): the full path of the Local File or select it by clicking the button. E.g. "C:\Program Files\Flowster Solutions\Flowster Studio\Documentation\Flowster Designer.pdf".
Remote Destination Folder(text box editor type) (type: string): the path of parent Folder from the FTP server, where the File will be uploaded. E.g. 'Flowster FTP Folder', located in the FTP root node.

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs the result status. If the file was uploaded successfully then TRUE, otherwise FALSE.

Synchronize Folder/File

This activity performs a one way synchronization of a folder/File.

Activity Parameters

The Synchronize Folder/File activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Filter (combo box control) (type: string): the document type which you would like to be synchronized. Flowster provides All, Folders and Files as options:
- All: all document types will be taken into consideration during the synchronize operation
- Folders: only the folders will be taken into consideration during the synchronize operation
- Files: only the files will be taken into consideration during the synchronize operation.
Local Folder (text box editor type) (type: string): the full path of the Local Folder or select it by clicking the button. E.g. "C:\MySQL_Files" (a local folder where some MySQL Files are stored, for demonstrative purposes only).
Master Folder (combo box control) (type: string): determines which folder is the master. Flowster provides Remote and Local as options:
- Remote: the activity will synchronize the Local Folder with the Remote one (for example, it will download all files from the Remote given folder into the Local one)
- Local: the activity will synchronize the Remote Folder with the Local one (it will upload all files from the Local given folder into the Remote one)
Remote Folder (text box editor type) (type: string): the path of the Folder from the FTP server. E.g. 'Flowster FTP Folder'.

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs the result status. If the folders were syncronized successfully then TRUE, otherwise FALSE.

Execution: the activity will synchronize the folder one way only (Remote with Local or Local with Remote), by downloading/uploading files (downloading into the Local folder if Remote is selected as Master, uploading into the Remote folder if Local is selected as Master):

The screenshot presents the activity synchronizing the Local folder with a Remote one (uploading file to FTP). The uploaded files can be seen on the FTP Server:

Upload File

This activity uploads Files to the specified FTP Server.

Activity Parameters

The Upload File activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Local File (text box editor type) (type: string): the full path of the Local File or select it by clicking the button. E.g. "C:\Program Files\Flowster Solutions\Flowster Studio\Documentation\Flowster Designer.pdf".
Remote Folder (text box editor type) (type: string): the path of parent Folder from the FTP server, where the File will be uploaded. E.g. 'Flowster FTP Folder', located in the FTP root node.

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs the result status. If the file was uploaded successfully then TRUE, otherwise FALSE.

Execution: the activity will search for the given FTP Folder and if found, it will upload the given local file on FTP:

The uploaded file can be seen on the FTP Server, under the selected directory:

Browser not supported