Setup and Configuration

PDS password reset

How can I reset a password for a PDS should I forget it?

If you forget your password for the demo server, you can reset it, by right-clicking the server name, and selecting the Request password reset menu item in the self-service portal. The new password will be automatically generated and sent to your email. The older password will no longer be valid.

How do I know that a new password has been sent to me?

Password reset requests for PDS servers are processed automatically and the new password usually arrives within minutes after the request is submitted. You will see a notification of the password reset in the Notifications section of the self-service portal. When you see the notification this means that our system has processed your request, and sent out the new password. The notification as you see it in the portal will not show the actual password value, but rather it is covered with asterisks (a star-character: * ). The actual password can only be retrieved from the message you receive in your mailbox. It cannot be seen in the portal. It is not known to our support staff.

August 26, 2021

Personal Demo Server

Survey Solutions users may familiarize themselves with the Headquarters/Admin functionality using a personal demo server (PDS).

Personal demo servers are managed through the self-service portal. You start by submitting a corresponding request. Before you proceed, make sure you understand the purpose and limitations of the PDS:

  • Every Survey Solutions user may request one PDS.
  • There are no forms to fill and the server becomes available shortly after the request is submitted.
  • The address of the server is https://username-demo.mysurvey.solutions and cannot be changed.
  • The server and all stored data will be automatically deleted 30 days after it was created.
  • A PDS may not be extended, but can be requested again after it expires.
  • We do not do backups of data stored on PDS and there is no possibility for any data recovery after the site has been stopped (all content is deleted immediately).
  • Once a PDS is created for a user, it may not be transferred to another user.

The objective of a PDS is to give the user a playground to study and experiment and not to collect any real survey data. In fact the PDS are configured to handle only minimal workloads (approx 1,000 interviews).

July 19, 2021

Data Server Errors

The following errors may be encountered when working with a data server:

1. “Unable to import new questionnaire: Could not connect to Designer. Please check if Designer is available and try again."

Your Headquaters installation is trying to contact the Survey Solutions Designer server to import the questionnaire, but can’t reach it. It is very unlikely that the Designer is not responding or is not working read how to check here so the problem is most likely with your network configuration. Consult your network administrator and ask him/her to trace the signal and see where it stops. Most commonly it is prevented by your Firewall software or hardware.

June 23, 2021

DB connection errors

The following error may be encountered during the server startup, when it fails to establish connection to the database server:


Note, that since the message is displayed on a publicly accessible page, it does not elaborate the specific reason for the problem.

When the server displays the above message, it is incapacitated and the error needs to be fixed asap. This is especially critical if the server is being utilized for CAWI surveys, where the respondents following the link in the invitation will likely be lost if they encounter this message instead of the survey form to fill out. Also the interviewers will not be able to synchronize their tablets, neither to submit collected interviews, nor to receive new assignments. In fact, because the database is storing the information that is needed to authenticate the users, no activity can be undertaken on the server that requires authentication.

June 23, 2021

AWS setup

Installation of Survey Solutions on Amazon AWS

The installation consists of the following steps:

  1. Create security group for web server and RDS to be able to communicate
  2. Create PostgreSQL instance
  3. Create EC2 instance for running Survey Solutions
  4. Install Survey Solutions

Create security group

In order to have connection between Survey Solutions and PostgreSQL you can create new security group as described in here.

From the AWS Management Console:

  • Click on EC2 under the Compute heading
  • Scroll down the left-hand navigation to Network & Security
  • Click on Security Groups
  • Click on Create security group

In the create security group specify name and description:

May 31, 2021

Configuring export to external cloud storage.

Survey Solutions may be configured to export data to major international cloud storage providers:

  • DropBox
  • Google Drive
  • Microsoft OneDrive

To enable export to the external storages the following configuration changes need to be done to the configuration file appsettings.Production.ini:

  1. Add section:
[ExternalStorages:OAuth2]
RedirectUri="https://YOURSERVERNAME/data-export-storages.html"
ResponseType="code"

Note that you need to substitute-in your server name in the RedirectUri parameter.

  1. Decide which external storages you want to make available to the users of your server (this is shared across all workspaces) from the above mentioned list of cloud providers.

    April 29, 2021

Support packages

Support packages are also known as tablet information packages. These terms are used interchangeably in this documentation.

Survey Solutions contains a built-in mechanism for collecting the data from tablets and transmitting it to the HQ server. This helps to investigate the issues where the interviewers can not supply any detailed problem report and commonly describe the problem with “it doesn’t work” or “it crashes” and it is difficult or not possible to access the device directly.

March 18, 2021

Device Logs

Survey Solutions contains a built-in mechanism for logging the problems and transmitting the log data from tablets to the HQ server. This helps to investigate the issues where the interviewers can not supply any detailed problem report and commonly describe the problem with “it doesn’t work” or “it crashes” and it is difficult or not possible to access the device directly.

The information contained in the device logs is rather technical and should be interpreted by IT personnel or software developers. If you are looking for a description of activities undertaken by an interviewer, rather than solving a technical problem, then the Interviewer Actions Log must be used instead.

March 18, 2021

Azure setup

Installation of Survey Solutions on Microsoft Azure

In order to install - register on azure portal and login. Installation steps are going to use azure shell.

After loggedin into azure shell execute command with variables that are going to be needed later. Feel free to change them as you need:

RG=surveysolutions \
LOC=westeurope \
STOREACC=surveysolutions \
SHARE_NAME=surveysolutions \
PGSERVER=suso-postgres \
PGPASS=password \
WEBAPPNAME=surveysolutions-webapp \
SRVPLAN=AppSvc-SurveySolutions-plan
  • RG - resource group where all survey solutions related resources are going to be grouped
  • LOC - location where you will run survey solutions software. Choose the one that fits your needs https://azure.microsoft.com/en-us/global-infrastructure/geographies/
  • STOREACC - storage account that will contain binary data https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview. Should be unique so change it, do not use one provided here
  • SHARE_NAME - name of file share for survey solutions to store binary data
  • PGSERVER - name for PostgreSQL server
  • PGPASS - password for PostgreSQL database change. Make your own password, do not use the one provided in here.
  • WEBAPPNAME - address and name of created survey solutions intallation. Should be unique across all other web apps.
  • SRVPLAN - name for created service plan

Create a resource group:

November 5, 2020

Installer Command Line Parameters

Survey Solutions installer may be launched with command line parameters.

ParameterMeaningExampleDefault
Siteportport number on which the site shall be installed in IIS80809700
Connserverpart of the DB connection string identifying the address of the database serverdata.warehouse.com127.0.0.1
Connportpart of the DB connection string identifying the port of the database server4435432
Connusernameuser name for connection to the DBjohnsmithpostgres
Connpasswordpassword for connection to the DBMyPassword911
Installfolderfull installation path where the Survey Solutions server should be installedC:\World Bank\Survey SolutionsC:\Survey Solutions
Additionally, specify /s for a silent install.

Example:

Install to directory D:\SuSo\ silently and bind Survey Solutions site to port 8080 in IIS:

May 11, 2020