SFTP

SFTP connectors are secure gateways through which data can be moved in and out of the Platform using Secure Shell (SSH) keys. It is referred to as a database connector. Users with the technician role are able to create and manage them.

SSH Keys

SSH Keys provide a more secure method of logging into a server than using a password. For security purposes, SSH keys are only accessible to the user that created the connector on behalf of the organisation. If you are using an SFTP connector created by a different user, contact this user to obtain access to the SFTP server location to retrieve the exported data.

Pre-requisites

To use an SFTP connector, you need:

1. Host

2. Port

3. Username

4. Password

5. Folder path (optional)

Create a Connector

SFTP (on platform)

An SFTP connector will provide the owner with SSH key credentials to access an SFTP server.

SFTP (external)

• Click Manage on the Navigation bar

• Select Connectors to view the Manage Connectors screen

• Click the Create connector button at the top right

• Enter a Name for your Connector and a Description (optional)

• Select the Type > SFTP (External)

  • Enter details for:

  • Host

  • Port

  • Username

  • Password

  • Folder path (optional) - to ensure the data is placed in a specific location that includes the supplied folder name.

• Add any Integration Metadata needed for programmatic integrations

• Click the Create button

  • You can create up to ten SSH keys. SSH keys can be downloaded as .PEM files and used to access the SFTP server.