How to Create Custom Action Buttons

Overview

SurveyToGo Studio allows you to create custom action buttons that can execute your own scripts during an interview. Any action that can be implemented through SurveyToGo scripting can be exposed as a button and made available to interviewers directly from the survey interface.

Custom action buttons are configured at the survey level and can be used to perform a wide variety of tasks, such as displaying messages, updating data, launching custom workflows, or executing other scripted actions.

This article covers:

1. Creating a custom action.

2. Writing the action script.

3. Testing the action on a device.

Step 1: Create a Custom Action

1. Open the survey and select the survey root.

2. Open the Advanced tab.

3. Click Edit Custom Actions.

4. Click New Action.

5. Enter a name for the action. This name will be displayed in the survey's Actions menu on the device.

Step 2: Write the Action Script

After creating the action, enter the script you want to execute in the Action Code field.

For example, you could display a message, update survey data, or perform any other supported scripted operation.

Note: The Action Available field can be ignored for basic custom action configuration.

Step 3: Test the Action

1. Deploy and run the survey on a device.

2. Open an interview.

3. Open the device menu (the method varies depending on the device).

4. Select Actions.

You will see a list of all custom actions configured for the survey.

Select the desired action to execute its script. The code entered in the Action Code field will run immediately.

For example, if the action script displays a message box, selecting the action will cause the message box to appear on the screen.