Ethica Surveys

Each study in Ethica can have zero or more surveys, which are prompted at different times and serving different purposes. A given survey contains multiple components. The most important ones include:

  • Triggering Logic defines when the survey should be prompted to participants during their participation period.
  • Notification defines how and when the participant should be notified (or reminded) about the survey.
  • Criteria specifies under what conditions the survey is enabled or disabled for a given participant.
  • Expiry Time specifies how long Ethica should wait for the participant to complete the survey before it marks the survey as expired.

We describe each of these components, and other available attributes, in the following sections.

Accessing Survey

As a researcher, you can use the Design -> Surveys section of the Researcher Dashboard to view the list of surveys in your study, add new surveys, edit or delete the current ones, or release them to participants. To access this Page:

  1. From the left panel, open Projects list.
  2. From Projects, extend the study you plan to modify by clicking on the study name.
  3. From the options appearing for the study, select Design.
  4. From the options appearing for Design, select Surveys.
Accessing Surveys Page in Ethica Researcher Dashboard

You can add a new survey by clicking on Add New Survey button here. This will open Ethica Survey Editor which you can use to define your survey. You can read more about Ethica Survey Editor here.

Adding New Survey in Ethica Researcher Dashboard

As you add surveys to your study, you can see their list here:

Viewing List of Surveys in Ethica Researcher Dashboard

The list shows the following information for each survey:

  • ID: The ID of the survey. Each survey in Ethica is assigned a unique ID to be differentiated across the system. This ID is shown here.
  • Status: This indicates whether a survey is already published, or is in draft mode. More on that here.
  • Version: The current version of the survey. More on that here.
  • Name: The friendly name assigned to this survey by the researcher.
  • Expiry Time: How long the survey remains active on participants' devices, waiting for a response. You can read more about Expiry Time here.
  • Triggering Logics: When the survey is expected to be promoted to the participant. More on that here.
  • Notifications: How the participant should be notified or reminded about the survey. You can read more about Notifications here.

Clicking on each row will expand the row and shows a more information about the survey, including the description of the survey and details of the Triggering Logics and Notifications defined for the survey. There, you will also get the option to perform the following actions on a given survey:

  • Edit opens the survey in the Survey Editor and allows you to modify it.
  • Delete deletes the survey from your study.
  • Move moves the survey from the current study to another study. You need to have the required permissions on both the current and the destination study.
  • Duplicate creates a copy of this survey.
  • Release Now prompts the survey to one or more participants right away. More on that here.

Note that when you make any changes to a given study, such as editing its surveys, deleting them, or adding or removing surveys via Move and Duplicate, the change does not immediately received by the participants' devices. You need to update the device for all participant currently enrolled, as described here. Any participant who joins you study after this change will have the latest published version of the survey.

Clicking on Survey Row Shows the Extended View

Also, deleting a survey or moving it to another study does not delete or move the responses currently provided for that survey.

Survey JSON Definition

Surveys in Ethica are defined using a plain-text JSON document. The document describes when the survey should be prompted (the Triggering Logics), how the participant should be notified (the Notifications), what activates or deactivates a survey (the Criteria), what questions should be asked and what should be their flow, and any other setting Ethica supports for surveys. A valid survey JSON file is required to meet the specification defined in the Ethica Survey Schema. When you use Ethica's Survey Editor to program your surveys, the Survey Editor creates such JSON document behind the scene to describe your survey. The following image shows Ethica Survey Editor's home page where you can download your survey as JSON, or upload a JSON file as your survey:

Download or Upload Ethica Survey as JSON File

You can download this JSON document, open it with a text editor, and examine its content. Note that the content will be minimized to save space. You can use tools such as JSON Editor Online to format the content and make it more readable. You will notice the content of the JSON file represents all the configurations of your survey which are either the default values, or the values you have specified via the Survey Editor.

Similarly, you can modify the survey's JSON file, or create your survey from scratch as a JSON file, and upload it via the Survey Editor. Doing so will load youryour survey content into the Survey Editor, where you can further modify the survey using the Survey Editor's graphical interface, or publish the survey to your participants.