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)
- Overwrite Existing Object (toggle):
- Toggling this on allows you to export files with the same name and overwrite the existing files.
- If this toggle is off, exports of files with the same name will fail as a file already exists with that name, so we recommend keeping the Filename setting as 'editable during export' and changing the name before exporting
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.
- Navigate to Activation Segments & start an export
Once you’ve created the activation segment, go to the Activation Segments tab under Activate, where you can find all of the historic segments that have been created by your team for that collaboration. Please ensure you are in the correct Collaboration view at the top for the Activation you're looking for.
A ‘ready’ status shows that the query has been successful and is ready to be sent to a Destination. Activation segments are only ‘Ready’ for 36 hours, this is to ensure that you are always exporting the freshest data. You can easily refresh a segment by clicking ‘refresh’ in the details panel of each segment.
When you select an Activation segment, an information panel appears on the side of the page allowing you to view the segment and export it to a Destination with the correct permissions for that Collaboration.
You can click ‘Export’ to start a new export, or click ‘View’ / double-click on the activation segment name to view all exports associated with this segment.
2. Select your destination
After you click Export, a new pane will appear with a list of the destinations available for this segment. You will be able to see all the Destinations that your company owns or has permission to use for that Collaboration. Select your destination, and configure any custom fields.
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.