> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://help.sigmacomputing.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server.

# Example representation: Workbook with a set form values action (Beta)

> Example Sigma code representation of a workbook with a set form values action.

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](/docs/sigma-product-releases#beta-features).

This is an example representation of a workbook, retrieved using the [Get a workbook](/reference/get-workbook) endpoint with the query parameter `includeContents=true`. Representations like this one can be used to create a workbook from code using the [Create a workbook](/reference/create-workbook) endpoint. Each page in this example library includes the code representation of the workbook and step-by-step instructions to create it in the Sigma UI.

Consult this example and others in the [Workbook representation example library](/docs/workbook-representation-example-library) to:

* Troubleshoot the formatting of a particular feature in code representation
* Relate a feature from the Sigma UI to its representation in code
* Provide context to AI tools used to create workbooks from code

This example representation cannot be used as-is. All identifying details, such as IDs, names, and URLs, have been replaced with randomized ID values or generic substitutions. The format of these contents, like the length of ID values, is preserved for demonstrative purposes. However, this representation cannot be directly used without modification to the base URL, connection details, and more. For more information, see [Create and manage workbooks from code](/docs/manage-workbooks-as-code).

## System and user requirements

To complete the steps in this example, you must meet the user requirements listed below for creating the workbook in the UI and creating it from code.

The ability to create this workbook in the Sigma UI requires the following:

* You must be assigned an [account type](/docs/account-type-and-license-overview) with the **Create, edit, and publish workbooks** permission enabled.
* You must have access to a connection to a data platform.

The ability to create a workbook from code requires the following:

* You must be assigned an [account type](/docs/account-type-and-license-overview) with the **Create, edit, and publish workbooks** permission enabled.
* You must have developer credentials for the Sigma API. For more information, see [Get started with the Sigma REST API](/reference/get-started-sigma-api).

This example uses a table from the [Sigma Sample Connection](/docs/sigmas-sample-connection). Your organization might have disabled access to the Sigma sample connection. If so, you can contact an admin to enable it, or use a table from another connection to follow along with this example.

## Create the example workbook in the Sigma UI

This example shows a workbook with a form and a button that populates it using a **Set form values** action.

To create this workbook in the Sigma UI:

1. Go to the **Home** page.

2. Select ![](https://sigma-docs-screenshots.s3.us-west-2.amazonaws.com/Icons/button-add.svg) **Create new** > **Workbook**.

   A new workbook opens.

3. From the **Add element** bar, select **UI** > **Form**.

4. Add a text field and a number field to the form and label them **Station** and **Duration** respectively.

5. From the **Add element** bar, select **UI** > **Button**.

6. In the editor panel, under **Properties**, change the **Text** of the button to `Prefill form`.

7. In the editor panel, open the **Actions** tab.

8. Select ![](https://sigma-docs-screenshots.s3.us-west-2.amazonaws.com/Icons/button-add.svg) **Add action**.

9. Configure the action with the following settings:

   | Option     | Setting               |
   | :--------- | :-------------------- |
   | **Action** | **Set form values**   |
   | **Form**   | **New Form (Page 1)** |

10. Select ![](https://sigma-docs-screenshots.s3.us-west-2.amazonaws.com/Icons/button-add.svg) **Add all fields** to add every field on the form to the action, then set a value for each.

    The **Set form values** action populates the form but does not submit it to a data source.

11. In the document header, select **Save as**.

12. Enter a name for the workbook, such as `set-form-values-action`.

13. Select **Save**.

## Get a code representation of this workbook

To get a representation of this workbook, follow the steps in [Get the code representation of a workbook](/docs/get-the-code-representation-of-a-workbook).

The code representation of this workbook appears like the following:

#### YAML representation

```yaml
workbookId: aca9080e-9400-47b1-9901-c12fb2509b92
workbookUrlId: c3KGZnZYYApYtkKtJoyAqH
createdBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
updatedBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
createdAt: '2026-09-01T14:57:47.189Z'
updatedAt: '2026-09-02T20:27:59.387Z'
name: set-form-values-action
url: https://aws-api.sigmacomputing.com/org-name/workbook/c3KGZnZYYApYtkKtJoyAqH
path: My Documents/<folder-name>
latestVersion: 4
ownerId: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
isArchived: false
contents:
  schemaVersion: 1
  elements:
    - id: wJP2vU
      kind: form
      fields:
        - fieldId: fldStation
          type: short-text
          label: Station
        - fieldId: fldDuration
          type: number
          label: Duration
    - id: MHEDLe3B
      kind: button
      text: Prefill form
      appearance: filled
      actions:
        - id: sZLDXiE
          trigger: on-click
          effects:
            - effect: set-form-values
              formElementId: wJP2vU
              values:
                fldStation:
                  type: constant
                  value:
                    type: text
                    value: Market St
                fldDuration:
                  type: constant
                  value:
                    type: number
                    value: 600
  pages:
    - id: eKhTktnw
      name: Page 1
  kind: workbook
  layout: |
    <?xml version="1.0" encoding="utf-8"?>
    <Page type="grid" gridTemplateColumns="repeat(24, 1fr)" gridTemplateRows="auto" id="eKhTktnw">
      <Element elementId="wJP2vU" gridColumn="1 / 25" gridRow="1 / 18"/>
      <Element elementId="MHEDLe3B" gridColumn="1 / 25" gridRow="18 / 24"/>
    </Page>
documentVersion: 4

```

## Representing the set form values action

#### Set form values action representation

```yaml
...
actions:
- id: sZLDXiE
  trigger: on-click
  effects:
  - effect: set-form-values
    formElementId: wJP2vU
    values:
      fldStation:
        type: constant
        value:
          type: text
          value: Market St
      fldDuration:
        type: constant
        value:
          type: number
          value: 600
...
```