Documentation

Read the Manual


This document is also available as: PDF

Survana Manual v.1.0

Table of Contents

  1. Getting Started
  2. Dashboard
  3. Command Line Tools
  4. Developer API

1. Getting Started

Survana has a few easy ways to quickly get started, each one appealing to a different use case.

Download Survana

Installing Survana

Running the Web Service

Configuration

For security reasons, you must set an administrator username and password, as shown below:

After a configuration change, restart the web service for the new changes to take effect.

2. Dashboard

To access Survana's dashboard:

Sign in:

Enter your administrator username and password and click on "Sign in" to continue.

Create study:

To quickly add a new study, click the green button on the Studies page:

Choose any of the available forms on the right and click the Save button when finished.

Preview study:

Survana lets you preview the study as it appears to the subject.

All available actions are displayed as yellow buttons on the toolbar:

Use these buttons to visualize how your study will look on a variety of device formats:

Edit study:

To bring up the edit screen for your study, click on Edit. You can add or remove forms, just as you did on the Create study page.

Publish study:

When the study is ready for distribution, click on to bring the publication screen.

You will notice two new buttons:

Study link:

After publishing your study, the page will display the public URL to your study, which you can share with your participants.

To make changes to your study after you've published it, click Revert to draft

Note that your study will be inaccessible during the time its not published.



3. Command Line Tools

To download responses collected by the study, use the command line tool survana, bundled with the downloaded package.

$ ./survana -store https://example.com/store/ -study XYZ
This will download all responses for the study with id XYZ from the specified Survana Store URL.

4. API

To develop questionnaires in Survana you must have knowledge of the JSON data format.
When you've gained enough knowledge of Survana, visit the API page for an in-depth coverage of the questionnaire format:

Read the API Documentation