Provisioning Amazon Transfer (SFTP)

Note that you must create a Data Pipeline to process files loaded via a Data Service.

Provision SFTP folder

1. Go to Data Services page from the menu Admin → Data Flow Automation. This will display the Data Services grid on the page.

   

2. Select Add New Service to open the Add New Service screen.

   

3. Select Category of either File Loading or Data Export (note: this cannot be changed once the service is created).

SFTP folders can be used for either File Loading or Data Export, but not both. This is specified by selecting the category on the Add New Service screen and cannot be changed after the service is created.

4. Select Amazon Transfer (SFTP) from the Type field

5. Select Envizi from Owner field

6. Enter name of the data service on Name field

7. Select any existing Data Pipelines to link the Data Service to.

8. Save the screen by choosing Save button

9. On the Data Services page, the new data service is listed.

   

Manage SFTP connection details

1. On the Data Services page, select an Amazon Transfer (SFTP) service

2. Right-click and choose Manage Connections from action menu. This will open Manage Connections screen.

   

3. On the Manage Connections screen, the grid shows the following columns:

   1. Service Name - the name of the data service

   2. Server EndPoint - the SFTP host or server name

   3. Server Port - default SFTP port

   4. Root Folder - the SFTP directory

   5. Username - the user that has exclusive access to the SFTP root folder or directory

   6. SSH Public Key Id - Host reference id for the client’s public key. Note this is an Envizi reference Id to support troubleshooting SFTP issues. It is not the client’s SSH Public Key.

   7. Updated By - name of the user that updated the connection details

   8. Updated On - date and time when the connection details is last updated

      

Adding a User

Envizi requires the SSH public key to be provided in OpenSSH format (i.e., starting with “ssh-rsa”). If your key is in the SSH2 format (i.e., starting with “---- BEGIN SSH2 PUBLIC KEY ----”) it will need to be converted to the OpenSSH format before entering the key below.

1. Use your preferred key generator to generate SSH public/private key pair of type ‘RSA’ and ‘2048’ bits. Save your Private Key file which you will use to authenticate connections to the SFTP server. You may optionally choose to add a key passphrase for extra security.

2. Copy your SSH Public Key from Step 1 above in the OpenSSH format. In Envizi, right-click on the connection and choose Add User from action menu which opens the Add User form with an autogenerated username. Paste in your SSH Public Key in the OpenSSH format and click Save.

   

3. You can now use your preferred file manager to connect to the SFTP directory for file transfer using

   1. the connection details from Envizi

      1. Server Endpoint (and Port)

      2. Root Folder

      3. Username

   2. your private key file (and key passphrase if set).

Removing a user

1. On the Manage Connections page, select connection where the user will be removed.

2. Right-click and choose Delete User from the action menu.

3. A confirmation message will appear, confirming if the user wants to continue.

4. The user will be removed from the existing connection on the Manage Connections page.