Overview


Scope

This document is a user manual for EFS/Questback Data Integration. It contains all relevant information for this integration that has been added into the Dapresy system.


Purpose

The purpose of this article is to provide an overview of EFS/Questback Data Integration and how to use it in the Dapresy system.


Using the System

Process Flow

The data integration process works as follows:




Setup Integration

To setup a EFS/Questback data source adapter, you must complete the following 5 tasks:


Task 1: Access Data Integration UI

To access Data Integration UI in Dapresy, please follow these 4 steps:

  1. Log into Dapresy
  2. Enter the Data tab from the main menu

Click on the arrow under Import Data, then select Schedule imports from the dropdown menu

Then the Data Integration UI will open


Task 2: Create Data Adapter Instance

Your first Data Adapter is automatically created when you access Import Scheduler UI for the first time. This screen contains all of the setup controls for the new data adapter instance. Some of these parameters are mandatory, and some are optional.

When you access this screen for the first time, you need to enter the Schedule name and check the Active checkbox.


After the first Data Adapter has been created, then you can create another Data Adapter for the same project with different configurations. To create a new Data Adapter, just click the ‘Create new’ button on Import scheduler UI.


The import schedule configuration form will be cleared for new parameters and configurations. Also, if you need to delete a Data Adapter, simply select the Data Adapter you would like to delete from the Selected import schedule dropdown list and then click the ‘Delete selected’ button.


Task 3: Set Data Import Scheduler

You can schedule every Import Scheduler job to be triggered just once or to be repeated based on one of the following schedules:

  • Hourly
  • Weekly
  • Monthly

You can select the schedule type from the ‘Import type’ dropdown menu on the Import scheduler UI.




When the ‘Run import on save’ checkbox is selected, then the import job will be triggered immediately after the Save button has been clicked. Scheduled jobs will also be saved for the time that you select.

Task 4: Choose Data Source

To select a Data Source for your Data Adapter, use the Data source dropdown menu.


By default, the data source is set to the FTP Server. This should be changed to EFS. There are more than one EFS endpoints in ‘Data source’ dropdown. Every endpoint starts with ‘EFS’ word. Proper endpoint should be selected here. When proper EFS endpoint is selected as the data source, the configuration form will be loaded on UI.



Task 5: Set up Data Source

To set up the EFS data source, two mandatory parameters are needed: Web service key and Project ID. To learn how to get these, see Pre-Requirements on Page 5 of this manual (Must be corrected later).
To set up the EFS data source, simply follow these 7 steps:


  1. Enter your unique Web service key from EFS
  2. Enter the Project ID from EFS that you need data from
  3. Enter Disposition codes if needed. These codes are used to get data only from specific respondents groups
  4. Choose the time period for the selected survey's data. Select this from the Time period dropdown. If nothing is selected, then the system will load data from all respondents. If a specific date range is needed, then select the ‘Static’ option from the time period dropdown list
  5. The Start and End date controls will then appear. Simply check the Start and End date check boxes and choose the specific dates from the calendars


There are other options in this dropdown too:

Floating – With this option it’s possible to filter responses for exact number of  hours/days

Total – Enables you to download responses from survey full period

Auto – When this option is chosen then the highest imported response date in the system is used as start date for new import


After completing these steps, EFS/Questback Data Adapter will be configured and ready to use. The last step is to click ‘Save at the end of the Import scheduler UI.