Create and modify a new survey package

Create a survey package

In order to send out your survey to participants, you must create survey packages.  In the 'Structure' tab, open the 'Survey Packages' sub-tab.

Click '+ Add' to create a new survey package.

Edit a survey package

In the 'Add a survey package' window, you can set up the configuration of the new survey package. Survey packages behave as 'containers' for your surveys and allow you to send the surveys to individual participants or a group of participants. A survey invitation by default includes a {url} tag. The {url} tag is the actual link to the survey which will be generated once the survey invitation is sent. The remaining text of the invitation mail can be edited based upon your preference.

• Name: the title of the Survey Package
• Invitation sender: the email address of the sender the respondent will see in the survey invitation email
• Invitation subject: the subject of the invitation mail that will be sent to participants.
• Invitation message: The content of the invitation message itself. This field must contain the {url} tag. During the invitation process, Castor will generate a unique URL where the respondent can find his/her Survey. This URL will be placed in the invitation mail where the {url} tag is located.
• Lock survey if finished: Locks the survey after the respondents clicks on the ‘finish survey’ button. After the survey is locked, responses in the survey can not be changed.
• Auto send: if enabled, an invitation will automatically be sent when the new Survey Package is created. Alternatively, you can manually send the invitations at a later date.
• Allow step navigation: if enabled, respondents can click through the step navigator (if shown).
• Show step navigator: if enabled, respondents will see a list of the Steps of the Survey on the left hand of the Survey data entry screen
• Force step completion: if enabled, respondents have to complete all required fields of a Step before they can continue to the next Step
• Finished URL: when a respondent completes all the surveys in the survey package, a 'Finish' button will appear instead of the 'Next Step' button. Clicking 'Finish' will take the respondent to the URL specified in this field.

Note: When creating a test survey package, it is recommended to include an example email body. Otherwise, there is a high chance that your test survey invitation will be filtered out by your email provided and placed in the spam/junk folder.

Set up a reminder for a survey package

It is possible to set up a reminder for a survey package. This is a generic setting for the survey package and will always be applied when an invitation is sent for that survey package. 

To create a reminder, follow the steps below:

1. Navigate to the Scheduling tab when creating/editing a survey package
2. Tick the box 'Send reminder if survey not yet completed'.  This will send a survey reminder if the survey progress not 100% and the survey is not locked.
3. Add the reminder subject
4. Add the invitation message. Use {url} where the invitation URL should come. When a survey will be sent, the {url} will be converted to an actual survey link. Use {logo} to include a small version of the study logo.
5. Set the number of days after which the reminder should be sent. The reminder can be set for up to 99 days after the invitation was sent.

Introduction and outro text

In the survey package, you can provide introductory and concluding text that will be shown as the first and last pages of the survey package. You can also provide intro/outro text that will be displayed at the beginning and end of the survey itself:

Survey selection

In the Survey selection tab you can choose which surveys you want to add to the survey package and in which order you want them to appear. You can re-arrange the order of the surveys using the blue arrows.

Creating Survey Package for Castor Connect

Before a survey package can be made available in the app, it has to be configured to be mobile-friendly. When creating a survey package or editing an existing one, "Edit survey package" window will appear where you can configure the details of the survey package:

• Name: this is the name that will be presented to the participant in the header bar of the app when completing an assessment and within their task list, as well as on the platform.
• Enable for mobile app: Ticking this box and saving will convert the survey package invite into either a launch/app invite email (if the participant has not used the app previously OR will be added to the participant's task list (if they have used the app previously). Becomes read-only after a package has been used at least once.
• Invitation sender: These fields control which email address will be displayed as the sender in the participant's invite email.
• Invitation subject: Pre-defined and uneditable for a mobile-enabled survey package .
• Invitation message: Body of the invitation email - this is pre-filled for studies using Castor Connect.
• Lock survey if finished: Locks the invitation on completion (prevents re-use).
• Auto-send, Allow step navigation, Force step completion, Finished URL: These settings do not currently apply to mobile-enabled survey packages.

Intro and Outro text: If you want specific intro and outro text to be present to the participant - in addition to any intro and outro text configured at the individual survey level - it can be defined here

Survey selection: Define which surveys will be included in the survey package, and in what order they must be completed by the participant. Surveys that have been configured with fields that are not currently supported on mobile, will not be displayed in this list.

Scheduling: this section allows to set up an automatic survey package reminder:

• Send reminder if survey not yet completed: Determine if a reminder will be sent (not 100% completion, not locked)
• Reminder subject/Reminder message: Define the header and body text that will be displayed in a push notification on the subject's device
• Send reminder after [x] hours: Determine if a reminder will be sent for completion
• Expire after [x] hours: Define by when the survey package must be completed after the invitation has been sent, in hours

Create survey questions

Each survey contains one or multiple steps. Each step will appear as a different page in the survey where users will need to navigate through (using Next/Previous buttons). You can group the survey questions in different steps in a relevant manner, similarly to the normal study CRF. Each question corresponds to a field.

To create your survey questions:

1. Navigate to the 'Form' tab > 'Surveys' sub-tab.
2. Using the dropdown menus in the header, select the survey and step you have previously created where you want to add questions.
3. Start adding fields in the same way that you add fields in your study form.

Copy a survey package

To duplicate a survey package, click on the cogwheel and select Copy survey package

Add a name for the copied survey package and click SaveWhen copying survey packages the following is copied: Intro text, outro text, settings and the usages of surveys within the package.

Video tutorial

Watch the video walk-through on Castor Academy:

Create a survey package

In order to send out your survey to participants, you must create survey packages.  In the 'Structure' tab, open the 'Survey Packages' sub-tab.

• Name: this is the name that will be presented to the participant in the header bar of the app when completing an assessment and within their task list
• Enable for mobile app: Ticking this box and saving will convert the survey package invite into either a launch/app invite email (if the participant has not used the app previously OR will be added to the participant's task list (if they have used the app previously). Becomes read-only after a package has been used at least once.
• Invitation sender: These fields control which email address will be displayed as the sender in the participant's invite email.
• Invitation subject: Pre-defined and uneditable for a mobile-enabled survey package 
• Invitation message: Pre-defined and uneditable for a mobile-enabled survey package
• Lock survey if finished: Locks the invitation on completion (prevents re-use)
• Auto-send, Allow/Show step navigator, Force step completion, Finished URL: These properties currently are not applicable for mobile-enabled survey package invitations

Intro and Outro text: If you want specific intro and outro text to be present to the participant - in addition to any intro and outro text configured at the individual survey level - it can be defined here.

Survey selection: Define which surveys will be included in the survey package, and in what order they must be completed by the participant. Surveys that have been configured with fields that are not currently supported on mobile, will not be displayed in this list

Scheduling: this section allows to set up a survey package reminder

• Send reminder if survey not yet completed: Determine if a reminder will be sent (not 100% completion, not locked)
• Reminder subject/Reminder message: Define the header and body text that will be displayed in a push notification on the subject's device
• Send reminder after [x] hours: Determine if a reminder will be sent for completion
• Expire after [x] hours: Define by when the survey package must be completed after the invitation has been sent, in hours

Create survey questions

Each survey contains one or multiple steps. Each step will appear as a different page in the survey where users will need to navigate through (using Next/Previous buttons). You can group the survey questions in different steps in a relevant manner, similarly to the normal study CRF. Each question corresponds to a field.

To create your survey questions:

1. Navigate to the 'Form' tab > 'Surveys' sub-tab.
2. Using the dropdown menus in the header, select the survey and step you have previously created where you want to add questions.
3. Start adding fields in the same way that you add fields in your study form.

Video tutorial

Watch the video walk-through on Castor Academy:

Create a new survey (package) | Castor Academy