Start and End Scripts

Overview

Scripts are user-written blocks of code that allow you to customize survey behavior and control how questions and chapters are displayed and processed.

A common use case is dynamically updating question text based on answers provided earlier in the interview. For example, a start script can insert a respondent's name or a previous answer into the current question text.

SurveyToGo supports both Question Scripts and Chapter Scripts, each with Start and End events.

Question Start and End Scripts

Questions support both Start Scripts and End Scripts.

Question Start Script

A Question Start Script is executed whenever the page containing the question is displayed.

Typical uses include:

• Setting question text dynamically.

• Filtering answers.

• Initializing variables.

• Showing or hiding answers.

• Applying formatting.

Question End Script

A Question End Script is executed when the respondent leaves the page containing the question.

Typical uses include:

• Processing answers.

• Setting values in other questions.

• Performing calculations.

• Preparing data for subsequent questions.

Chapter Start and End Scripts

Chapters also support Start and End Scripts.

Chapter Start Script

A Chapter Start Script runs when the first question within the chapter is displayed.

This is useful for initialization tasks that should occur once when entering a chapter.

Chapter End Script

A Chapter End Script runs when the respondent exits the chapter, before the first question of the next chapter is displayed.

This can be used to perform calculations, save values, or execute logic that depends on the answers collected throughout the chapter.

Chapter scripts automatically handle situations where the survey jumps into the middle of a chapter or exits a chapter through a jump rule.

Relationship Between Scripts and Rules

Scripts and rules work together to control survey flow and behavior.

Start Script Execution

The sequence is:

1. Entrance Rule is evaluated.

2. If the question or chapter should be displayed, the Start Script executes.

3. The question is shown to the respondent.

In other words, Start Scripts only run after the Entrance Rule allows the question or chapter to be displayed.

End Script Execution

The sequence is:

1. Validation Rules are evaluated.

2. If validation passes, the End Script executes.

3. Jump Rules are evaluated.

4. The survey moves to the next destination.

This means End Scripts run after validation is completed but before any Jump Rule is applied.

Writing Start and End Scripts

To create a Start Script or End Script:

1. Select the desired question or chapter.

2. Open the Scripts tab.

3. Enter the required code in the appropriate Start Script or End Script section.

The scripting syntax is the same as that used throughout SurveyToGo, including:

• Expressions

• Survey Initialization Scripts

• Advanced Scripts

• Rules and calculations

All standard SurveyToGo functions and supported scripting features can be used within Start and End Scripts.