Example representation: Workbook with a synced control (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.

This is an example representation of a workbook, retrieved using the Get a 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 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 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.

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

This example uses a table from the Sigma 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 control that is synced across two pages, so both copies share one control ID and value.

To create this workbook in the Sigma UI:

Go to the Home page.
Select Create new > Workbook.

A new workbook opens.
From the Add element bar, select Data > Table.
In the Select source modal, search for the table TRIP in the EXAMPLES.BIKES schema.
Select the table to add it to the workbook.

The table appears in the workbook.
From the Add element bar, select Controls > List values.

The new control appears on the canvas.
Select the control, then in the Properties tab of the editor panel, enter subscription-type as the Control ID and Subscription type as the Label.
For the value source, select the Trip table and the Subscription Type column.
Select Targets, then add the Trip table as a target on the Subscription Type column.
In the page tab bar, select to add a second page.
Return to the first page, hover over the control, then open its More menu.
Select Create a synced copy.

A synced copy appears on the page.
Open the More menu of the synced copy, then under Move to, select Page 2.

Both copies share the subscription-type control ID, so when you change one, the other follows.
In the document header, select Save as.
Enter a name for the workbook, such as synced-control.
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.

The code representation of this workbook appears like the following:

YAML representation

workbookId: 0d1a5a0a-885f-4ee1-ba58-e55953c20806
workbookUrlId: xBl4aXpBT4Y5vq1QkGLZMQ
createdBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
updatedBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
createdAt: '2026-09-01T14:53:46.158Z'
updatedAt: '2026-09-02T15:59:47.793Z'
name: synced-control
url: https://aws-api.sigmacomputing.com/org-name/workbook/xBl4aXpBT4Y5vq1QkGLZMQ
path: My Documents/<folder-name>
latestVersion: 3
ownerId: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
isArchived: false
contents:
  schemaVersion: 1
  elements:
    - id: eTizXgX
      kind: table
      source:
        connectionId: b2af3691-12a0-48fa-a91d-fbe2e1b31627
        kind: warehouse-table
        path:
          - EXAMPLES
          - BIKES
          - TRIP
      columns:
        - id: 6DqBgE6Rq
          formula: '[TRIP/Id]'
        - id: wOW6NNWOZqI
          formula: '[TRIP/Duration]'
        - id: jC0c8h8Ewz3g
          formula: '[TRIP/Start Date]'
        - id: cOIGflvCqIlC
          formula: '[TRIP/Start Station Name]'
        - id: JpVJowwqZg
          formula: '[TRIP/Start Station Id]'
        - id: GyZynaXgfv
          formula: '[TRIP/End Date]'
        - id: qQzuJifMd2
          formula: '[TRIP/End Station Name]'
        - id: 3Esuzz9y
          formula: '[TRIP/End Station Id]'
        - id: a1ySXDMEm
          formula: '[TRIP/Bike Id]'
        - id: Kng0H6Uvst
          formula: '[TRIP/Subscription Type]'
        - id: B0QtJd
          formula: '[TRIP/Zip Code]'
      order:
        - 6DqBgE6Rq
        - wOW6NNWOZqI
        - jC0c8h8Ewz3g
        - cOIGflvCqIlC
        - JpVJowwqZg
        - GyZynaXgfv
        - qQzuJifMd2
        - 3Esuzz9y
        - a1ySXDMEm
        - Kng0H6Uvst
        - B0QtJd
    - kind: control
      controlId: subscription-type
      id: 9tongEAVEE1JzD5yTBNV
      name: Subscription type
      filters:
        - source:
            kind: table
            elementId: eTizXgX
          columnId: Kng0H6Uvst
      controlType: list
      mode: include
      selectionMode: multiple
      values: []
      source:
        kind: source
        source:
          kind: table
          elementId: eTizXgX
        columnId: Kng0H6Uvst
    - kind: control
      id: Iwvb6Nbz
      controlId: subscription-type
      controlType: synced
  pages:
    - id: eKhTktnw
      name: Page 1
    - id: BdDna0y
      name: Page 2
  kind: workbook
  layout: |
    <?xml version="1.0" encoding="utf-8"?>
    <Page type="grid" gridTemplateColumns="repeat(24, 1fr)" gridTemplateRows="auto" id="eKhTktnw">
      <Element elementId="eTizXgX" gridColumn="1 / 25" gridRow="1 / 21"/>
      <Element elementId="9tongEAVEE1JzD5yTBNV" gridColumn="1 / 25" gridRow="21 / 27"/>
    </Page>
    <Page type="grid" gridTemplateColumns="repeat(24, 1fr)" gridTemplateRows="auto" id="BdDna0y">
      <Element elementId="Iwvb6Nbz" gridColumn="1 / 25" gridRow="1 / 7"/>
    </Page>
documentVersion: 3

Representing synced controls

Synced control representation

...
kind: control
id: Iwvb6Nbz
controlId: subscription-type
controlType: synced
...