Create actions that modify forms (Beta)

🚩
This documentation describes one or more public beta features that are in development. Beta features are subject to quick, iterative changes; therefore the current user experience in the Sigma service can differ from the information provided in this page.
This page should not be considered official published documentation until Sigma removes this notice and the beta flag on the corresponding feature(s) in the Sigma service. For the full beta feature disclaimer, see Beta features.

Workbooks support actions that set or clear form fields. Using these actions, you can control the state of a form based on other interactions in an app. For example, you can prepopulate form fields with values from a control element, or reset the form to clear all field values after submission.

This document explains how to configure the Set form values and Reset form actions. For more information about actions in Sigma, see Intro to actions.

User requirements

📘
The following requirements apply to users who configure actions. Users who access and interact with a workbook can typically trigger all existing actions within it. Any restrictions are noted in this document.

The ability to configure actions requires the following:

You must be assigned an account type with the Full explore or Create, edit, and publish workbooks permission enabled.
You must be the workbook owner or be granted Can explore¹ or Can edit access to the workbook.

1If you’re granted Can explore access to the workbook, you can configure actions in custom, saved, and shared views. Actions saved to views do not apply to the workbook’s published version.

Set form values

Create an action that sets the form value. Setting form values allows you to populate a form field with a value in response to other interaction in the workbook. For example, you can configure an action on a button to set a form field value based on the value of a control element.

📘
The Set form values action does not submit form data to a data source.

For more information about creating and configuring forms, see Use forms to streamline user data entry.

Open the draft, custom view, or saved view of a workbook.
Select the trigger element (the element users must interact with to initiate the action).
In the editor panel, open the Actions tab.
Create a new sequence, or locate an existing sequence that you want to modify.
Select the default action (if creating a new sequence), or click Add action to add a new action to the sequence.
In the modal, configure the required fields to define the response:


Action	Select Set form values.
Set form	Select a form from your workbook.
Set form value as	Add form fields, and determine the type of value used to set them. Choose from Static value, Control, Column, Form field, or Formula depending on the context. Based on your selection, configure the value to set.

Action

Select Set form values.

Set form

Select a form from your workbook.

Set form value as

Add form fields, and determine the type of value used to set them. Choose from Static value, Control, Column, Form field, or Formula depending on the context.

Based on your selection, configure the value to set.

If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.

💡
You can add individual form fields to a Set form values action by selecting + Add field, or add all form fields for the selected form to the action by selecting + Add all fields.

Reset form

Create an action that resets the form, clearing all values from all form fields.

Open the draft, custom view, or saved view of a workbook.
Select the trigger element (the element users must interact with to initiate the action).
In the editor panel, open the Actions tab.
Create a new sequence, or locate an existing sequence that you want to modify.
Select the default action (if creating a new sequence), or click Add action to add a new action to the sequence.
In the modal, configure the required fields to define the response:

Action Select Reset form.
Form Select a form to reset.


Action	Select Reset form.
Form	Select a form to reset.

If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.

Updated about 18 hours ago