Create a File System Connection
The File System Connection is the method to connect and add data from comma separated value (CSV) files in Hero Platform_ through an Input.
The Connection is restricted to only reading comma separated value (CSV) files.
Create a Connection to an File System in Hero Platform_
1. Open Hero Platform_.
2. Open Integration from the navigation menu and select Connections.
3. Click Create New Connection.
4. Give the Connection a name and select File System from the drop-down list for Connection type.
5. The File System Connection details screen pops up with fields that need to be configured.
The first field is labeled Input file system. There are six choices:
- Azure Blob Storage
- Dropbox File System
- FTP File System
- Hero Platform_ File System
- Microsoft OneDrive File System
- S3 File System
- SSH File System
Azure Blob Storage
Select Azure Blob Storage to connect to a folder on Microsoft Azure.
- Enter the account name
- Enter the access key
- Enter the endpoint suffix
- Enter the container name.
- Enter a root path.
6. Click Test connection. A confirmation message is displayed if the connection has been established with your file system.
7. Click OK to finish saving the Connection in Hero Platform_.
DropBox File System
Before being able to connect to Dropbox, you need give permission for Hero Platform_ to access Dropbox.
Go to https://www.dropbox.com/developers/apps and log into Dropbox.
Click Create App.
Select Dropbox API as the API.
Select Full Dropbox as the access choice.
Enter a name for the app.
Click Create app.
Make a note of your App key and App secret.
Enter your Hero Platform_ redirect URI for the OAuth 2 setting.
Example:
| Your Hero Platform_ instance URL | Redirect URI to enter in Drop Box |
|---|---|
| https://31v93t-of23ysg.cloud.automationhero.ai/ | https://31v93t-of23ysg.cloud.automationhero.ai/oauth2 |
| http://localhost:8080/ | http://localhost:8080/oauth2 |
Set the access token expiration to No expiration.
Under the Permission tab, mark all checkboxes for Files and Folders.
Under the Permissions tab, Dropbox free users should only mark “Individual Scope” permission settings. Team scope settings are only for Dropbox business accounts.
Select DropBox File System to connect to a DropBox folder.
- Enter the Dropbox App Key
- Enter the Dropbox App Secret
- Enter the file path in Dropbox to the folder you want to connect.
- Click Sign in with Dropbox.
6. Click Test connection. A confirmation message is displayed if the connection has been established with your file system.
7. Click OK to finish saving the Connection in Hero Platform_.
FTP File System
Select FTP File System to connect to a folder on the FTP server.
The supported maximum file length is ~2 GB for FTP file transfers.
- Select a FTP protocol.
- FTP
- FTPS (implicit)
- FTPS (explicit)
- Enter the host name.
- Enter the port number.
- Enter the username.
- Enter the password.
- Advanced settings (only change them, if you are having issues):
Connection timeout (s): in seconds, timeout used when connecting to a server.
Command timeout (s): timeout, used for listing, folder change, … answer timeout.
Data timeout (s): timeout, used for file upload / download.
Keep control channel busy while up/downloading: helpful setting if the FTP server is behind a firewall. While bigger files are up/downloaded, this feature can keep timeouts from occurring.
- Control channel encoding. The default is UTF-8. Rarely, special FTP servers may require different character encoding. This setting should only be change it if special characters (e.g., Ö,Ő,É,Ü) in file names are not fetched correctly.
- Escape file names. Rarely, special FTP servers may require extra escaping in commands. Only mark this box if you have problems with reading data from folders that has a space in the name.
6. Click Test connection. A confirmation message is displayed if the connection has been established with your file system..
Session reuse with an FTPS protocol isn't supported. Automation Hero recommends to use an SSH connection with the SFTP protocol. SSH with SFTP is a more secure method when session reuse is necessary.
7. Click OK to finish saving the Connection in Hero Platform_.
Hero Platform_ File System
Select Hero Platform_ File System to connect to a folder on the system where Hero Platform_ is installed.
Note: Hero Platform_ File System is not the user's file system. It is your Hero Platform_'s local file system.
- Select the path of the folder where the files are stored.
6. Click Test connection. A confirmation message is displayed if the connection has been established with the Hero Platform_ file system.
7. Click OK to finish saving the Connection in Hero Platform_.
Microsoft Drive File System
70 MB is the maximum file size recommended for uploading with the Microsoft Drive Connection.
Select Microsoft Drive File System to connect to a folder on MS Drive or SharePoint.
- Enter the client ID.
- Enter the client secret.
- Enter the auth URI.
- Default: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
- Enter the token URI.
- Default: https://login.microsoftonline.com/common/oauth2/v2.0/token
- Enter scopes.
- Default: offline_access Files.Read Files.Read.All Files.ReadWrite Files.ReadWrite.All User.Read
- Authentication scopes.
- Permission scopes.
- Drive type:
- OneDrive
- SharePoint
6. Click Test connection. A confirmation message is displayed if the connection has been established with your file system.
7. Click OK to finish saving the Connection in Hero Platform_.
S3 File System
Select S3 File System to connect to an S3 bucket.
- Select the mode:
- AWS - Amazon Simple Storage Services
- Select the S3 region for your file from the drop-down list.
- AWS_COMPATIBLE - Alternative vendors using S3 compatible technology.
- Enter the endpoint URL.
- Enter the S3 region. (optional)
- Trusting: Select a trust certificate.
- AWS - Amazon Simple Storage Services
- Enter the path to the folder location where the file(s) are stored.
- Enter the name of the S3 bucket.
- Enter your AWS S3 access key.
- Enter your AWS S3 secret key.
6. Click Test connection. A confirmation message is displayed if the connection has been established with your file system.
7. Click OK to finish saving the Connection in Hero Platform_.
SSH File System
Select SSH File System to connect to a folder on the SSH host.
- Enter the SSH host name.
- Enter the port number.
- Enter the username.
- Select an authentication type.
- If Password is selected, enter the password.
- If Private Key is selected, click Choose file to browse and selected the authentication key file.
- Selected the file transfer mode. (SFTP or SCP)
6. Click Test connection. A confirmation message is displayed if the connection has been established with your file system.
7. Click OK to finish saving the Connection in Hero Platform_.