Create actions that modify input table data

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 add, update, or delete rows in input tables. These actions are designed to support form functionality but can be used in other ways to accommodate different app use cases.

This document explains how to configure the Insert row, Insert row(s), Update row(s), and Delete row(s) 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.

Insert row

Create an action that adds a new row in a target input table.

Open the draft, a custom view, or a saved view of a workbook. If you open a saved view, go to the workbook header and click Customize this view to enable changes.
Select the trigger element (the element users must interact with to initiate the action).

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.
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 Insert row.
Into	Select a target input table (excluding linked input tables) to update with the added row.
With values	For each column of your input table, define the value (or source of the value) that Sigma must pass to the row. The availability of value type options (described below) depends on the elements in the workbook. Static values: Passes a specified (fixed) value Column: Passes the value of the specified table column. Control: Passes the value of the specified control element. Formula: Passes a value based on the defined formula. To leave a column blank, select Static values and leave the value unset.

Action

Select Insert row.

Into

Select a target input table (excluding linked input tables) to update with the added row.

With values

For each column of your input table, define the value (or source of the value) that Sigma must pass to the row.

The availability of value type options (described below) depends on the elements in the workbook.

Static values: Passes a specified (fixed) value
Column: Passes the value of the specified table column.
Control: Passes the value of the specified control element.
Formula: Passes a value based on the defined formula.

To leave a column blank, select Static values and leave the value unset.

In the document header, click Publish to apply the action to the published version of the workbook.
If the action is part of a workflow that can be triggered by any user with access to the workbook, confirm that the target input table is editable in the published version. For more information, see Set data entry permission.

Insert row(s) (Beta)

Create an action that inserts one or more rows in a target input table. You can insert new data that you define, or insert rows from an existing source in the workbook, such as a table, an input table, or an action variable.

Open the draft, a custom view, or a saved view of a workbook. If you open a saved view, go to the workbook header and click Customize this view to enable changes.
Select the trigger element (the element users must interact with to initiate the action).

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.
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:

In the modal, configure the required fields to define the response. Field requirements depend on the type of data you want to insert. Select the relevant tab below for guidance.

New data

Source data


Action	Select Insert row(s).
Insert type	Select New data.
Into	Select a target input table (excluding linked input tables) that the action must modify.
Set column values	Define the column values that Sigma must pass to the row or rows it inserts. You can configure values or value sources for any editable column in the target input table. Depending on the trigger element type, you can define the value using one of the following options: Static values: Specify a fixed value to pass to the inserted row or rows. Column: Choose a column from the trigger element (table, pivot table, input table, or chart) containing values to pass to the inserted row or rows. Sigma passes the column value for the row selected in the trigger element. Control: Choose a control element from the workbook. Sigma passes the current control value to the inserted row or rows. Formula: Enter a formula to evaluate. Sigma passes the returned value to the inserted row or rows. Action variable: Choose an action variable produced by an earlier action in the same sequence. Sigma passes the variable value to the inserted row or rows. This option is only available when a preceding action (like Insert row or Call API) in the same sequence produces an action variable.
Insert as multiple rows	Enable this option to insert multiple rows (up to 2,000 per action) from a single multi-value source.
Select field(s) to split	If you enabled Insert as multiple rows, map one or more columns to a multi-value source (a control, form field, or action variable that returns multiple values). Sigma inserts one row for each value in the split field(s) and applies any other defined column values to every inserted row.

In the document header, click Publish to apply the action to the published version of the workbook.
If the action is part of a workflow that can be triggered by any user with access to the workbook, confirm that the target input table is editable in the published version. For more information, see Set data entry permission.

Update row(s)

Create an action that updates the value of one or more rows in a specific input table or linked input table.

The Update row(s) action can only modify input tables created after April 23, 2023.

Open the draft, a custom view, or a saved view of a workbook. If you open a saved view, go to the workbook header and click Customize this view to enable changes.
Select the trigger element (the element users must interact with to initiate the action).

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.
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 Update row(s).
In	Select a target input table or linked input table that the action must modify.
Update row(s) by	Choose an option and define the criteria that determines which row or rows are updated. Single row: Target an individual row based on its unique identifier (the system-generated row ID for input tables or the primary key column value for linked input tables). Depending on the trigger element type, you can define the criteria using one of the following options: Static value: Specify a fixed value. If the value matches the unique identifier of a single row in the target element, Sigma updates that row. Column: Choose a column from the trigger element (table, pivot table, input table, or chart). If the column value for the row selected in the trigger element matches the unique identifier of a single row in the target element, Sigma updates that row. Control: Choose a control element from the workbook. If the control value matches the unique identifier of a single row in the target element, Sigma updates that row. Formula: Enter a formula to evaluate. If the expression returns a value that matches the unique identifier of a single row in the target element, Sigma updates that row. If the formula returns a value that matches multiple rows, the action does not affect the table, and Sigma does not update any row. If multiple rows meet the criteria set for the Single row option, the action does not affect the table, and Sigma does not update any row. Formula: Target rows based on a formula that evaluates to `True` or `False`. When the expression returns `True` for one or more rows in the target element, Sigma updates those rows. Column value matches criteria: Target rows based on a comparison or logical operator evaluated against the specified column. When the operator criteria is `True` for one or more rows, Sigma updates those rows.
Update with values	Define the column values that Sigma must pass to the row or rows it updates. You can configure values or value sources for any editable column in the target element. Depending on the trigger element type, you can define the value using one of the following options: Static value: Specify a fixed value to pass to the updated row or rows. Column: Choose a column from the trigger element (table, pivot table, input table, or chart) containing values to pass to the updated row or rows. Sigma passes the column value for the row selected in the trigger element. Control: Choose a control element from the workbook. Sigma passes the current control value to the updated row or rows. Formula: Enter a formula to evaluate. Sigma passes the returned value to the updated row or rows.

In the document header, click Publish to apply the action to the published version of the workbook.
If the action is part of a workflow that can be triggered by any user with access to the workbook, confirm that the target input table or linked input table is editable in the published version. For more information, see Set data entry permission.

Delete row(s)

Create an action that deletes one or more rows in a specific input table.

Open the draft, a custom view, or a saved view of a workbook. If you open a saved view, go to the workbook header and click Customize this view to enable changes.
Select the trigger element (the element users must interact with to initiate the action).

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.
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 Delete row(s).

In Select a target input table (excluding linked input tables) that the action must modify.


Action	Select Delete row(s).
In	Select a target input table (excluding linked input tables) that the action must modify.
Delete row(s) by	Choose an option and define the criteria that determines which row or rows are deleted. Single row: Delete an individual row based on its unique identifier (the system-generated row ID). Depending on the trigger element type, you can define the criteria using one of the following options: Static value: Specify a fixed value. If the value matches the unique identifier of a single row in the target element, Sigma deletes that row. Column: Choose a column from the trigger element (table, pivot table, input table, or chart). If the column value for the row selected in the trigger element matches the unique identifier of a single row in the target element, Sigma deletes that row. Control: Choose a control element from the workbook. If the control value matches the unique identifier of a single row in the target element, Sigma deletes that row. Formula: Enter a formula to evaluate. If the expression returns a value that matches the unique identifier of a single row in the target element, Sigma deletes that row. If the formula returns a value that matches multiple rows, the action does not affect the table, and Sigma does not delete any row. If multiple rows meet the criteria set for the Single row option, the action does not affect the table, and Sigma does not delete any row. Formula: Delete rows based on a formula that evaluates to `True` or `False`. When the expression returns `True` for one or more rows in the target element, Sigma deletes those rows. Column value matches criteria: Delete rows based on a comparison or logical operator evaluated against the specified column. When the operator criteria is `True` for one or more rows, Sigma deletes those rows.

Delete row(s) by

Choose an option and define the criteria that determines which row or rows are deleted.

Single row: Delete an individual row based on its unique identifier (the system-generated row ID). Depending on the trigger element type, you can define the criteria using one of the following options:
- Static value: Specify a fixed value. If the value matches the unique identifier of a single row in the target element, Sigma deletes that row.
- Column: Choose a column from the trigger element (table, pivot table, input table, or chart). If the column value for the row selected in the trigger element matches the unique identifier of a single row in the target element, Sigma deletes that row.
- Control: Choose a control element from the workbook. If the control value matches the unique identifier of a single row in the target element, Sigma deletes that row.
- Formula: Enter a formula to evaluate. If the expression returns a value that matches the unique identifier of a single row in the target element, Sigma deletes that row. If the formula returns a value that matches multiple rows, the action does not affect the table, and Sigma does not delete any row.
If multiple rows meet the criteria set for the Single row option, the action does not affect the table, and Sigma does not delete any row.
Formula: Delete rows based on a formula that evaluates to True or False. When the expression returns True for one or more rows in the target element, Sigma deletes those rows.
Column value matches criteria: Delete rows based on a comparison or logical operator evaluated against the specified column. When the operator criteria is True for one or more rows, Sigma deletes those rows.

In the document header, click Publish to apply the action to the published version of the workbook.
If the action is part of a workflow that can be triggered by any user with access to the workbook, confirm that the target input table is editable in the published version. For more information, see Set data entry permission.