Skip to content

Getting Started

Owen Selles edited this page Jun 15, 2015 · 19 revisions

Known Issues

##Question types At this point qual2db can handle most, but not all, Qualtrics question types. If qual2db encounters a question type it does not understand it will make a best guess. If it fails to interpret the response data for the unexpected question type the update process will be terminated.

Known issues are:

  • Gap Analysis
  • Heat map
  • Group and Rank Questions

##Choice and Answer Re-coding qual2db cannot process surveys that have choice and answer re-coding. Make sure to disable all question re-coding options before trying to add a survey to MySQL.

Installation

qual2db is easy install and use. It was deliberately built using only standard Python libraries so all you need is Python 2.7. No dependencies are required.

Requirements

Setup

At the moment, the best way to use qual2db is to:

  1. Download and unzip the source code
  2. Write scripts in the same directory as the qual2db folder that "import" qual2db

###Folder structure

your workspace/
               example_script.py
               qual2db/
                       config.ini
                       config.py
                       qualInterface.py
                       sqlInterface.py
                       survey.py

###Example Script

import qual2db

s = qual2db.survey('your survey id')
s.describe()

Configuration

Once you have downloaded and unzipped the code you must enter your credentials into the configuration file (config.ini).

###Qualtrics Credentials

Credential Description
basurl Leave this as the default: https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?
User The Qualtrics username of an account with API access
Password The account password
Version The API version. Leave this as the default: 2.3.

###MySQL Credentials

Credential Description
sqlUser MySQL username with read/write privileges
sqlPassword MySQL account password
sqlHost Database server url
sqlDB The database where the qual2db tables will be stored

##Setting up MySQL tables To set up the MySQL table structure write and run a script like this:

import qual2db

qual2db.sqlInterface.configure_db()

This will create all the tables needed to store Qualtrics data. It is recommended that you designate a MySQL database for the sole purpose of holding these tables.

Clone this wiki locally