Connecting to SFTP

Note

This documentation is prior to May 2022.

Secure file transfer (SFTP) provides a secure alternative to FTP. It is encrypted in GPR format. You can run SFTP interactively, or use it in combination with a batch file for automated, secure file transfer.

There are 3 options to connect to SFTP:

• Create a new project
• Edit an existing project connection
• Export data from the Export >Run recipe button

Connecting to SFTP when Creating a New Project

1. Click Enrich. The Enrich page is displayed.
2. Click  in the upper-right hand corner. The Create a new project window is displayed.
   
3. Type in a new project name. The project name needs to be unique.
4. Select a use case from the drop-down. 
5. Click Create. The Upload a dataset window appears.
   
6. Select SFTP. The following screen is displayed for a new connection creation:
   
7. Click + and Create new connection. The Create a new SFTP Connection window is displayed.
   
8. Choose a connection name (mandatory).
9. Type in the Host (mandatory).
10. Type in the Host key fingerprint (mandatory).
    This is relevant for the Administrator:
    We recommend that you use this link which explains how to discover the fingerprint from within the server itself: How to view your SSH keys in Linux, macOS, and Windows. 
    An alternative way is how to discover the host key fingerprint (value and type) from a personal computer which has already been connected to the SFTP at least once:
    In order to discover your SFTP’s host key fingerprint, run the following command:
    
    

    ssh-keyscan <host>
    The format of the result <host> <fingerprint type> <fingerprint value>can be seen inside the red block in the example below:
    host: s-2ab….
    fingerprint type: ssh-rsa
    fingerprint value: AAAAB3N…Ie80j
    '#' symbol: Lines of the output which are irrelevant

    
    
11. Select the Key type (host key finger print type).
12. Type in the User (mandatory).
13. Upload the Identity file (SSH-private key) of your server.
14. Enable the GPG encryption. If the checkbox was enabled once, then the connection will be treated as encrypted, even if the checkbox was disabled.
15. Click Upload to output the encryption public key of the user’s company. The upload enables Explorium to encrypt the output when uploading results to the client SFTP. If you do not select Upload (Output encryption public key) then you will not be able to upload results to the SFTP. The connection will be used just for input.
16. Download input (public) encryption key of Explorium (in order that the client will encrypt the files on it’s SFTP before uploading them to the Platform). After clicking, a file containing Explorium public key will be downloaded to the clients computer.
17.  Click Test Connection. A message is displayed that the connection was successfully created. If the test connection failed, then you are unable to create a connection.
    
    Before creating a new connection, a Test Connection must be run. If the test failed, or a parameter was changed, the Create button will be disabled, and you need to create a new connection.
    
    
18. After the test connection has succeeded, click Create in order to create the connection, and to start working with it.

Connecting to SFTP when Editing a Dataset

1. Click Enrich. The Enrich page is displayed.
2. Create or search for a project.
3. Click .
   
4. The Change data and edit dataset window is displayed.
   
5. Click Continue.
6. Click + Create new connection. The Create a new SFTP Connection window is displayed.
7. Choose a connection name (mandatory).
8. Type in the Host (mandatory).
9. Type in the Host key fingerprint (mandatory).
10. Select the Key type (host key finger print type). 
11. Type in the User (mandatory).
12. Click Upload, to output the encryption public key ( (optional). The upload enables Explorium to encrypt the output when uploading results to the client SFTP.
    If you do not select Upload (Output encryption public key) then you will not be able to upload results to the SFTP. The connection will be used only for input.
    
    

    Note: If you do not select Upload (Output encryption public key) then you will not be able to upload results to the SFTP. The connection will be used only for input.

    
    
13. Enable the GPG encryption. If the checkbox was enabled once, then the connection will be treated as Encrypted, even if the checkbox was disabled.
14. Download input (public) encryption key of Explorium (in order that the client will encrypt the files on it’s SFTP before uploading them to the Platform). After clicking, a file containing Explorium public key will be downloaded to the clients computer.
15. Click Test Connection. A message is displayed that the connection was successfully created. If the test connection failed, then you are unable to create a connection.
    Before creating a new connection, a Test Connection must be run. If the test failed, or a parameter was changed, the Create button will be disabled, and you need to create a new connection.
16. After the test connection has succeeded, click Create in order to create the connection, and to start working with it.

Exporting Data

1. Click Enrich. The Enrich page is displayed.
2. Create, search or edit a project.
3. Click the Export >Run Recipe.
   
   
4. The Schedule Recipe Run window is displayed.
   
5. Select the input connection (optional).
6. Select the output connection.