Creating a Library Survey
Note: We recommend searching for a survey before you create it to avoid creating duplicate surveys.
- Select Create New Survey.
- Use the following pages to configure the Survey JSON.
- Add information for the following fields next to the JSON editor.
- Details
- Display Label: This text is the label that respondents see when they receive the survey.
- Name: This name is the default reference name used when referring to the survey in the other areas, such as in rules. It acts as the default name when the library survey is added to a study collection.
- Access
- Respondent: This field is only available if you are creating an ePRO survey, which is defined in the Survey JSON. Select Participant or Caregiver to indicate who should receive and respond to the survey. It acts as the default respondent when the library survey is added to a study collection.
- Respondent Burden: Select a value to represent the burden of the survey. The respondent burden is the perceived difficulty of the survey for respondents to complete. Options include Very Easy, Easy, Moderate, Hard, and Very Hard.
- Additional Information
- Allow Study-Specific Edits: This field controls whether study teams can edit the survey configuration after they add it to their study. All other fields are still editable, for example: Display Label, Default Respondent, Reviewed, and so on.
- Reviewed: Select Yes, No, or N/A. See Tracking Reviewed Surveys on the Working With Collections page for more information.
- Licensed: Select Yes, No, or N/A. See Tracking Licensed Surveys on the Working With Collections page for more information.
- Details
- Select Save & Exit.
The new library survey will be created and you will land on the library survey page. Translations and more versions of the library survey can be managed from this page.
Working with Tokens
Tokens enable you to add placeholder variables in the survey JSON so the study builder can add different text or numbers even when using a locked survey in a study. For example, if a survey needs to reference different recall periods based on when it is scheduled. Token values will need to be translated if a study is configured to include multiple languages.
Creating a Token
- While viewing the survey, select the Tools menu (
). - Select Tokens.
- Select Create New Token.
- Enter a unique Name for the token. Ensure that the name does not include spaces.
Important: The name cannot begin with a reserved token name using this exact capitalization: “score”, “timepointLabel”, or “dayOfWeek”.
- Enter a short Description to help the Study Builder understand how the token is intended to be used.
- Enter the default Value that should be displayed in the survey. The Value can later be edited by study builders in Studio.
- Select Save. The token is saved.
- Save the survey.
Adding a Token in the Survey
- Find the place in the survey where you want to add the token and enter two curly brackets: {{. A list of available tokens is displayed.
- Select the token you want to add.
Important: If you are adding a token in a number or boolean parameter, it must be in quotation marks.
- Save the survey.
Tokens can be used multiple times in the same survey, but cannot be used in name or type parameters or image URLs.
Editing a Token
- Open Tools > Tokens and expand the token.
- Select Edit.
- Change any information, and select Save.
Note: Changing a token value or the placement of a token in a survey will require an updated translation review for the string of the token value and all strings the token is used in for the survey.
Removing a Token
- Open Tools > Tokens and expand the token.
- Select Remove ().
Re-adding a Removed Token
If you recently removed a token, you can select Undo to re-add the token.
Editing a Library Survey
- Access the library survey page.
- Next to the survey version that you would like to edit, select the Edit button ().
- Edit the Survey Configuration and other survey fields.
- Select Save & Exit.