FTP Push configuration

Tabata Vossen -

As a Qualifio user, you have the option to automate the daily upload of participation data files on your FTP. The FTP Push integration allows participation data to automatically be copied to your specified server, using FTP. The participation data file is copied to the server every day at the end of the day.

Introduction

Sending data to your FTP / SFTP server is one of the simplest ways to get your data from Qualifio. This feature allows participation data in CSV format to be pushed automatically and periodically to your server. FTP, SFTP and FTPS servers are currently supported. Amazon S3 and WebDAV will be supported at a later time.

Enable FTP Push

  1. Head to the Settings
  2. Click on "Integrations & Partners"
  3. Select "CSV file to FTP/SFTP server" from the list
  4. Use the ON/OFF button to enable or disable this integration

Screenshot_2019-08-20_at_11.50.06.png

Now, click on "Configure". You'll be directed to a page where you can enter information.

Configuring the FTP Push integration

To configure the FTP push, you must specify settings for the following fields:

File server host: The address of the server in which the data is to be uploaded to. This address can be entered as a numeric IP address or a valid DNS address.

File server login: The username required to login to the server.

File server password: The password required to login to the server.

File server port: The port used by your FTP or SFTP server.

File server path: The directory structure that the FTP Push should follow to upload the files.

Screenshot_2019-08-20_at_11.49.08.png

Click on Save.

Important note:
The name of the file that Qualifio uploads on your remote server will always be "qualifio_{YYYYMMDD}.csv"

What data is included?

We work with a template that contains relevant information about each participation to all the campaigns the integration was enabled for.

Please note that Qualifio's FTP Push only supports the CSV file format.

Form fields and background data

  • playTime: Participation date and time (e.g. 2019-08-12T13:39:28.+0000)
  • participationID: Unique identifier for that participation
  • siteName: Name of the website on which the participation happened
  • siteCountry: Country of the website on which the participation happened
  • campaignID: Unique identifier for the campaign
  • campaignName: Title of the campaign in which the participation happened
  • campaignLanguage: Language of the campaign in which the participation happened
  • themes: Themes assigned to the campaign (and therefore to the participation)
  • utm parameters
  • userAgent: e.g. Mozilla/5.0 (Macintosh Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.100 Safari/537.36
  • ip: Hashed IP adresse of the participation
  • device: Device used to participate
  • crmId: Unique identifier...
  • newProfile: Used to determine if this profile previously existed in the Qualifio CRM. Returned value can be TRUE – if the profile is indeed new to the CRM– or FALSE.
  • Participant's data: Information you collected about the participant through the campaign form (e.g. first name, last name, email, birth date, address, gender, company, postal code, etc.)

As this is a standard integration, the way data is ordered is default and cannot be changed.

We do accept other form data to be included in the file.
Please contact your Qualifio Expert should you wish to speak to our team about including other form data in the CSV file.

What about opt-ins?

Opt-ins can be included if

1) You contact your Qualifio Expert first, as this requires a technical manipulation on our end.

2) They are linked to an SSO variable. SSO variables are available in Settings. See this FAQ to learn more about how to use them.

The returned value can be

  • 1 – if the participant accepted the opt-in by ticking the checkbox or selecting "Yes".
  • 0 – if the participant did not accept the opt-in and did not tick the box or did select "No".

Example

You can download a data file example.

With each new participation, we'll add an extra line to that CSV file.

Enable the FTP Push in a Master Form or campaign

After adding the FTP Push integration, it will show under the "Data connections" menu of your forms.

Screenshot_2019-08-20_at_11.53.21.png

As an Admin, you can choose and lock this setting for your team if you're using Master Forms.

Notes

  • The FTP Push is incremental, meaning that one file will be uploaded with information collected from all campaigns since the last upload. This avoids having to manage data duplication.
  • File is uploaded to your FTP server every day at 2:00 AM (GMT/Brussels time). This timing is default and cannot be changed.
  • If the upload to your file server fails five times in a row on Monday, we will try again on Tuesday. On Tuesday, you will thus receive both the data from Monday and Tuesday. However, these data will be compiled within one file.
  • The ability to push participation data to an FTP server allows you to store it indefinitely, as opposed to storing it in Qualifio, which has a maximum data retention period of 2 years.
  • If choosing between SFTP or FTP, we strongly recommend that you use SFTP because it's a more secure way to transfer files.
  • Data will be written between quotes and with semicolons as field separators.
  • Currently, it is not possible to have both an FTP push and a real-time push enabled for a campaign.

 

If you need more help using the FTP Push after reading this article, please contact your Qualifio Expert.

 

Related topics:

Powered by Zendesk