Ftp/Sftp (File Transfer Protocol)

FTP Automation with Autom Mate

Introduction

This document provides an overview of how Autom Mate interacts with FTP (File Transfer Protocol) to automate tasks and enhance workflow processes. By leveraging this integration, users can streamline file transfers, reduce manual efforts, and improve overall productivity. The integration allows for seamless uploading, downloading, and managing of files on an FTP server directly from Autom Mate, ensuring that users can focus on more critical activities without worrying about manual file transfer operations.

What is FTP?

FTP (File Transfer Protocol) is a standard network protocol used for transferring files between a client and a server on a computer network. FTP is widely used for uploading and downloading files to and from a server, facilitating the management of files in various directories. It is a fundamental protocol for managing website files, sharing large files, and backing up data, making it an essential tool for both personal and professional file management tasks.

Key Features of FTP:

File Transfer: Efficiently upload and download files between local systems and servers.
Directory Management: Create, delete, and manage directories on the server.
File Permissions: Set and modify file permissions to control access.
Support for Large Files: Transfer large files without size limitations.
Authentication: Secure file transfers with user authentication.

Autom Mate Integration with FTP

Autom Mate integrates seamlessly with FTP to automate various file transfer-related tasks, streamlining workflow processes and reducing the need for manual intervention. By leveraging Autom Mate's powerful automation capabilities, users can efficiently manage their file transfers directly from the platform, ensuring consistency and saving valuable time. This integration is designed to interact with FTP servers to automate the uploading, downloading, and management of files and directories.

Key Integration Features:

Automated File Uploads: Automatically upload files to specified directories on the FTP server.
Automated File Downloads: Retrieve files from the FTP server to local directories based on defined triggers.
Directory Management: Create, delete, and organize directories on the FTP server through automated workflows.
File Permissions Management: Automate the setting and modification of file permissions to control access.
Error Handling: Implement error-handling mechanisms to manage failed transfers and retry operations.
Scheduling: Schedule file transfer operations to run at specific times, ensuring timely updates and backups.

Benefits of Autom Mate's FTP Integration

Increased Efficiency: Reduce manual file transfer efforts, allowing users to focus on more critical tasks.
Consistency: Ensure consistent and accurate file transfers with automated processes.
Time Savings: Save valuable time by automating repetitive file transfer tasks.
Reduced Errors: Minimize the risk of errors associated with manual file management.
Improved Security: Manage file permissions and authenticate transfers automatically, enhancing security.

Using the Integration

Credentials

Autom Mate ensures secure and efficient management of custom credentials for FTP integration, protecting sensitive information and restricting access to authorized users only.

Custom Credential Management

Custom credentials are specialized credentials used by bots or specific users, selectable during flow design and requestable by others.

Key Fields:

Credential Name: Name of the credential.
Request Status: Approval status of the request.
Access Type: Type of access granted.
Credential Owner: Owner of the credential.
Actions: Edit credential details.

Adding New Custom Credentials:

Go to the Vault section under Management.
Select the Custom Credentials tab.
Click "Add New Credential."
Enter required details:
- Credential Name
- Credential Description
- Variable Name
- Variable Description
- Variable Value
- Is Masked? (for confidential variables)
Click "+" to add more variables.
Click "Save."

Editing Custom Credentials:

Navigate to the Custom Credentials tab, click the pencil icon under Actions, and edit the details.

Deleting Custom Credentials:

Click the square icon next to the credential, then the trash can icon. For bulk deletion, select multiple credentials and click the trash can icon.

How To Use Actions

Hint

For files or folders exceeding the 250 MB limit, consider breaking the data into smaller chunks or compressing it before attempting the download to ensure compatibility with Autom Mate workflows.

Warning

Limitation: Files or folders larger than 250 MB will not be processed by the FTP Download Files or FTP Download Folder actions.
Attempting to process oversized data may result in action errors or workflow failures.

Connect

Description and Purpose: This action aims to connect to an FTP server using the necessary information. It is essential to use this action before starting other FTP-related actions, ensuring a secure and authenticated connection.

Usage: To use this action, the user needs to know the FTP server name or IP address and the port number. This information, along with the username and password, facilitates CRUD (Create, Read, Update, Delete) operations. Users can define custom credentials for ease of use, though it's not mandatory. The action supports FTP, FTP Secure, and Secure FTP (Beta) options, along with ASCII and Binary transfer types.

Inputs:

FTP Server Name or IP Address: The address of the FTP server.
Port Number: The port number for the connection.
Username and Password: Credentials for authentication.
Custom String or Custom Credentials (Optional): Predefined credentials for ease of access.
Transfer Type: Choose between ASCII and Binary transfer types.
Server Type: Select between FTP, FTP Secure, and Secure FTP (Beta).
Authentication Type: Anonymous or Username & Password

Action Output: Successful connection to the FTP server, enabling subsequent FTP operations such as file uploads, downloads, and directory management.

Create Folder

Description and Purpose: This action allows the user to create a folder on the FTP server. It is used after establishing a connection to the FTP server to organize and manage files more effectively.

Usage: To use this action, the user must first establish a connection to the FTP server using the Connect action. After configuring the Connect action and successfully connecting to the FTP server, follow these steps:

Drag and drop the Create Folder action into Autom Mate.
Configure the Create Folder action by defining the folder name in the "Folder Name" section.
Specify the location where the folder should be created in the "Folder Path" section.
Once the configuration is complete, press the run button. The folder will be created at the specified location on the FTP server.

Inputs:

Folder Name: The name of the new folder to be created.
Folder Path: The path where the new folder will be created on the FTP server.

Action Output: A new folder is created at the specified location on the FTP server.

Upload File

Description and Purpose: This action allows the user to upload files to an FTP server. It facilitates the transfer of files from a local system or cloud storage to a specified directory on the FTP server, streamlining the file management process.

Usage: To upload files to the FTP server using Autom Mate, follow these steps:

Drag and drop the Connect action into Autom Mate and configure it to connect to the FTP server.
Drag and drop the Upload File action into Autom Mate and start the configuration process.
Fill in the required sections:
- Location of the File(s): Define the file path to specify the location of the file(s). There are two options:
  - Autom Mate Data Store: Click the button at the right side of the Local Files Path section to open Autom Mate Data Store and select the file(s) to upload.
  - Custom Location: Specify any location on the Cloud Desktop or On-Premise desktop.
Define the location on the FTP server where the files will be uploaded. Use the Path to Upload section and specify the folder path using the "/" notation.
After configuring these details, press the run button to upload the files to the FTP server.

Inputs:

Local Files Path: The path to the local files to be uploaded. This can be selected from Autom Mate Data Store or specified manually.
FTP Upload Path: The destination path on the FTP server where the files will be uploaded.

Action Output: The specified files are uploaded to the defined directory on the FTP server.

To upload more than one file, separate file paths by using a comma (e.g., C:/folderX/my.docx, C:/folderY/my.txt).

Upload Folder

Description and Purpose: This action allows the user to upload files inside a specified folder to the FTP server. It is used to transfer multiple files from a local directory to a designated folder on the server, ensuring efficient file management and organization.

Usage: To upload files inside a folder to the FTP server using Autom Mate, follow these steps:

Drag and drop the Connect action into Autom Mate and configure it to connect to the FTP server.
Drag and drop the Upload Folder action into Autom Mate and start the configuration process.
Fill in the required sections:
- Local Path: Specify the local folder path containing the files to be uploaded.
- Path to Upload: Define the destination folder path on the FTP server.
- File Extensions: Enter the file extensions of the files to be uploaded. All files with the specified extensions within the local folder will be uploaded. To upload files with multiple extensions, separate the extensions using a comma (e.g., .docx, .txt).
After configuring these details, press the run button to upload the files from the local folder to the specified folder on the FTP server.

Inputs:

Local Path: The path to the local folder containing the files to be uploaded.
Path to Upload: The destination path on the FTP server where the files will be uploaded.
File Extensions: The file extensions of the files to be uploaded. Separate multiple extensions with a comma.

Action Output: The specified files are uploaded from the local folder to the designated folder on the FTP server according to the defined file extensions.

Rename File

Description and Purpose: This action allows the user to rename files on the FTP server. It is used to update file names efficiently, ensuring proper organization and management of files.

Usage: To rename files on the FTP server using Autom Mate, follow these steps:

Drag and drop the Connect action into Autom Mate and configure it to connect to the FTP server.
Drag and drop the Rename File action into Autom Mate and start the configuration process.
Fill in the required sections:
- File(s) Path: Define the file path(s) of the file(s) to be renamed. If there are multiple files, separate the paths using a comma (e.g., C:/folderX/my.docx, C:/folderY/my.txt).
- New File Name: Specify the new file name, including the extension (e.g., newfile.docx).
After configuring these details, press the run button to rename the specified files on the FTP server.

Inputs:

File(s) Path: The path(s) of the file(s) to be renamed.
New File Name: The new name for the file(s), including the extension.

Action Output: The specified files are renamed on the FTP server according to the new names provided.

Rename Folder

Description and Purpose: This action allows the user to rename folders on the FTP server. It is used to update folder names, ensuring proper organization and management of directories.

Usage: To rename a folder on the FTP server using Autom Mate, follow these steps:

Drag and drop the Connect action into Autom Mate and configure it to connect to the FTP server.
Drag and drop the Rename Folder action into Autom Mate and start the configuration process.
Fill in the required sections:
- Folder(s) Path: Define the path of the folder(s) to be renamed.
- New Folder Name: Specify the new name for the folder.
After configuring these details, press the run button to rename the specified folder on the FTP server.

Inputs:

Folder(s) Path: The path of the folder(s) to be renamed.
New Folder Name: The new name for the folder.

Action Output: The specified folder is renamed on the FTP server according to the new name provided.

Move File

Description and Purpose: This action allows the user to move files from one location to another on the FTP server. It facilitates efficient file management by enabling the transfer of files between different directories.

Usage: To move files on the FTP server using Autom Mate, follow these steps:

Drag and drop the Connect action into Autom Mate and configure it to connect to the FTP server.
Drag and drop the Move File action into Autom Mate and start the configuration process.
Fill in the required sections:
- File(s) Path: Define the current path(s) of the file(s) to be moved. To move more than one file, separate the paths using a comma (e.g., /folderX/my.docx, /folderY/my.txt).
- Moving Path: Specify the new path where the file(s) will be moved.
After configuring these details, press the run button to move the files from their current location to the specified new location on the FTP server.

Inputs:

File(s) Path: The current path(s) of the file(s) to be moved.
Moving Path: The new path where the file(s) will be moved.

Action Output: The specified files are moved from their current location to the requested location on the FTP server.

Move Folder

Description and Purpose: This action allows the user to move all files from specified local folders to designated folders on the FTP server. It facilitates the transfer and organization of multiple files, ensuring efficient file management.

Usage: To move folders from a directory to a folder on the FTP server using Autom Mate, follow these steps:

Drag and drop the Connect action into Autom Mate and configure it to connect to the FTP server.
Drag and drop the Move Folder action into Autom Mate and start the configuration process.
Fill in the required sections:
- Folder's Path: Specify the folder paths containing the files to be moved. If there are multiple folders, separate the paths using a comma (e.g., folderX/folderY, folderZ).
- Move Path: Define the destination folder path on the FTP server.
After configuring these details, press the run button to move the folders from the local directory to the specified folder on the FTP server.

Inputs:

Folder's Path: The paths to the local folders containing the files to be moved. Separate multiple folder paths with a comma.
Move Path: The destination path on the FTP server where the folders will be moved.

Action Output: The specified folders and their contents are moved from the local directory to the designated folder on the FTP server.

Download File

Description and Purpose: This action allows the user to download files from the FTP server. It facilitates the transfer of files from the server to a local system or cloud storage, ensuring easy access and management of files.

Usage: To download files from the FTP server using Autom Mate, follow these steps:

Drag and drop the Connect action into Autom Mate and configure it to create a connection with the FTP server.
Drag and drop the Download File action into Autom Mate and start the configuration process.
Fill in the required sections:
- File(s) Path: Define the path(s) of the file(s) to be downloaded from the FTP server. To download more than one file, separate the paths using a comma (e.g., /folderX/my.docx, /folderY/my.txt).
- Local Path: Specify the location where the file(s) will be downloaded. This can be the Autom Mate Data Store, an on-premise location, or a cloud desktop location.
After configuring these details, press the run button to download the files from the FTP server to the specified local or cloud location.

Inputs:

File(s) Path: The path(s) of the file(s) to be downloaded from the FTP server.
Local Path: The location where the file(s) will be downloaded.

Action Output: The specified files are downloaded from the FTP server to the defined local or cloud location.

Download Folder

Description and Purpose: This action allows the user to download files from a specified folder on the FTP server to a local directory. It facilitates the transfer of multiple files, ensuring efficient file management and access.

Usage: To download files from a folder on the FTP server to a local directory using Autom Mate, follow these steps:

Drag and drop the Connect action into Autom Mate and configure it to connect to the FTP server.
Drag and drop the Download Folder action into Autom Mate and start the configuration process.
Fill in the required sections:
- Folder Path(s): Specify the folder path(s) on the FTP server containing the files to be downloaded.
- Local Path: Define the local directory path where the files will be downloaded.
- File Extensions: Enter the file extensions of the files to be downloaded. All files with the specified extensions within the FTP folder will be downloaded. To download files with multiple extensions, separate the extensions using a comma (e.g., .docx, .txt).
After configuring these details, press the run button to download the files from the specified folder on the FTP server to the local directory.

Inputs:

Folder Path(s): The path(s) to the folder(s) on the FTP server containing the files to be downloaded.
Local Path: The local directory path where the files will be downloaded.
File Extensions: The file extensions of the files to be downloaded. Separate multiple extensions with a comma.

Action Output: The specified files are downloaded from the FTP server folder to the defined local directory according to the specified file extensions.

Delete File

Description and Purpose: This action allows the user to delete files from the FTP server. It helps manage and clean up unnecessary or outdated files, ensuring efficient file organization.

Usage: To delete files from the FTP server using Autom Mate, follow these steps:

Drag and drop the Connect action into Autom Mate and configure it to connect to the FTP server.
Drag and drop the Delete File action into Autom Mate and start the configuration process.
Fill in the required section:
- File(s) Path: Define the path(s) of the file(s) to be deleted from the FTP server. If there are multiple files, separate the paths using a comma (e.g., /folderX/my.docx, /folderY/my.txt).
After configuring this detail, press the run button to delete the specified files from the FTP server.

Inputs:

File(s) Path: The path(s) of the file(s) to be deleted from the FTP server.

Action Output: The specified files are deleted from the FTP server according to the paths provided.

Delete Folder

Description and Purpose: This action allows the user to delete folders from the FTP server. It helps manage and clean up unnecessary or outdated directories, ensuring efficient organization of the server's file system.

Usage: To delete folders from the FTP server using Autom Mate, follow these steps:

Drag and drop the Connect action into Autom Mate and configure it to connect to the FTP server.
Drag and drop the Delete Folder action into Autom Mate and start the configuration process.
Fill in the required section:
- Folder(s) Path: Define the path(s) of the folder(s) to be deleted from the FTP server. If there are multiple folders, separate the paths using a comma (e.g., /folderX, /folderY).
After configuring this detail, press the run button to delete the specified folders from the FTP server.