SFTP Destination
Intro
You can use an SFTP destination to:
- Export query results to an SFTP server.
Once a destination is created, you need only provide run time variables to push an activation file to a remote resource. Saved destinations are available to all users in your company and can be reused indefinitely.
Creating an SFTP destination
First, select the Destinations tab under Activate and then click Create A New Destination.
The form below appears when you select SFTP as your destination type and the following fields need to be completed:
- Destination Type: Select SFTP.
- Name: Identifies the destination
- Description: A free-text explanation of the destination
Once completed, press Next.
Adding SFTP connection details
Use destinations to create a connection between the InfoSum Platform and your SFTP server.
The above form contains the following fields:
Authentication Method Settings
1. Authentication field dropdown - Choose between password or SSH key method.
2. Username and Password/SSH Key - These credentials should be supplied by an network admin within your company.
3. Host: The hostname of the SFTP server you want to connect to.
4. Port: The TCP port that the SFTP server is running on. (Default is Port 22)
Host Verification Settings
1. Host Verification - Select the Public Key type to use from the dropdown. There are three options.
-
- Public Keys (OpenSSH authorized_keys format)
- Public Keys (OpenSSH known_hosts format)
- Public Key (PEM Format)
2. Click Add A New item to complete the credentials field and input the key. Add to save the key.
3. Filename - Name the exported file (free text).
4. Destination Path - The name of any target “folder” within the bucket in which to store the data
Optional Settings
GPG Public Key (optional, to export an encrypted file)
Click Submit. The saved destination is stored in the Platform’s Destinations page and can be selected in the Activations tab when pushing an activation file to a remote resource. The destination can be reused and is available to all users in your company.
Exporting results to a destination
You can activate results to a Destination using either Segment Builder or the Query Tool.
1. Navigate to Activations & select your activation
Once you’ve created the activation query, go to the Activation tab under Activate, where you will see each of the activation queries that have been run in your account. Please ensure you are in the correct Collaboration view at the top for the Activation you're looking for. Your latest one will be at the top, but you can search by Activation name or use filters to manage this list.
You will see a modal providing more details on the Activation you have selected, such as the query used and the name of the output column. There are three menu tabs within this box - Details, Stats, and Export History. Once you've pushed the results, the details and status will be viewable under the Export History tab.
2. Select your destination
Click on the Export blue button to configure your export. This will open a pop up asking you to select which Destination it should be sent to. You will be able to see all the Destinations that your company owns or has permission to use.
3. Configure the export
When you select the correct Destination, the pop up will show additional options, including column mapping if required and optional fields.
4. Click Export to Destination to initiate the activation.