Q-Integrate: The Qualtrics Event Listener

Installation Overview

  1. Download the program files from www.dwconsultants.com/q-integrate.
  2. Using Microsoft Internet Information Services (IIS) Manager, set up a website or virtual directory to hold the code.
    • Define a new Application Pool for this website. Set the .NET CLR Version to "No Managed Code". Managed Pipeline Mode is "Integrated".
    • Set the bindings to where you want the listener to be available. Note the URL for later use.
  3. Unzip the archive you downloaded and copy all of the files to the home directory of the website you created in the previous step.
  4. Verify your site is available. The site is running if you get this main page.
  5. Define your database connection string for DBConn1 in the appsettings.json file. This tool currently supports Oracle and Microsoft SQLServer
    • Oracle Example: Data Source= (DESCRIPTION =(ADDRESS = (PROTOCOL = TCP)(HOST = {HostName})(PORT = {Port}))(CONNECT_DATA =(SERVICE_NAME = {ServiceName})));User Id={User};Password={Password};
    • SqlServer Example: Server={ServerName};Database={DatabaseName};User Id={User};Password={Password};
    • Set the "DatabasePlatform" attribute to either Oracle or SqlServer as appropriate
  6. Click this VERIFY link to check your database connection status. Look at the "Connection" attribute and verify that isValid = true.
  7. Once you have verified your connection string is valid, click to install the required database components.
  8. Click this VERIFY link again to verify all components are installed correctly.
  9. Using Postman or a similar tool, submit a test Event Post to validate your installation.
    • The REST method needs to be POST.
    • The URL will be your server name with "/api/qualtrics/response".
    • The post method needs to be x-www-form-urlencoded.
    • All Key/Value pairs need to be submitted.
  10. Using your database client, validate the record you submitted in the step above is available.
    • Check the target table and verify the data is presnet: SELECT * FROM qual_listener_response
  11. Your setup is complete! You are now ready to subscribe to real-time events from Qualtrics. See the Qualtrics site for how to subscribe to these events. Qualtrics API Documentation

 

License Info

  1. Once you complete the installation steps above, the listener is ready to receive real-time Qualtrics event notices. The unlicensed product is fully functional except that approximately 25% of events will not have the RESPONSE_ID and corresponding response JSON recorded. The target table will show that the event occurred, but the data will not be saved.
  2. When you purchase a license, a key will be provided to add to your appsettings.json file.
  3. For more information on licensing please visit www.dwconsultants.com/q-integrate.

 

Configuration Details - Appsettings.json

  1. ApplicationName
  2. DatabasePlatform
  3. GetResponseJSON
  4. LogDirectory
  5. LogMethod
  6. LicenseKey
  7. QualtricsBaseURI
  8. QualtricsApiKey

 

 

Copyright © 2024 Data Warehouse Consultants. All rights reserved.