Build from codeWorkbook representation example library (Beta)

Example representation: Workbook with a navigation element (Beta)

View as Markdown

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:

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 navigation element that lists two workbook pages and an external link as navigation options.

To create this workbook in the Sigma UI:

  1. Go to the Home page.

  2. Select Create new > Workbook.

    A new workbook opens.

  3. In the workbook footer, select Add page.

    A new page, Page 2, appears in the workbook footer.

  4. Return to Page 1.

  5. From the Add element bar, select Layout > Navigation.

    The navigation element appears in the workbook, listing Page 1 and Page 2 as navigation options.

  6. In the editor panel, select Properties.

  7. Select Manual.

    The navigation options no longer update automatically when the workbook pages change.

  8. Select Add an option > Link.

  9. Configure the link option to open https://help.sigmacomputing.com/docs/about-sigma in a new window.

  10. In the document header, select Save as.

  11. Enter a name for the workbook, such as navigation-element.

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

workbookId: 594b88a5-a897-4fcd-af72-0a38660451f5
workbookUrlId: TCD1NXDpbBLrrSxg8dYtnL
createdBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
updatedBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
createdAt: '2026-08-14T17:05:56.018Z'
updatedAt: '2026-08-17T15:48:27.803Z'
name: navigation-element
url: https://aws-api.sigmacomputing.com/org-name/workbook/TCD1NXDpbBLrrSxg8dYtnL
path: My Documents/<folder-name>
latestVersion: 2
ownerId: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o
isArchived: false
contents:
  schemaVersion: 1
  elements:
    - id: xIpsxkhmGE
      kind: navigation
      mode: manual
      options:
        - destination:
            type: page
            pageId: EqPXLTdOjK
        - destination:
            type: page
            pageId: DlLHnvUiOb
        - destination:
            type: link
            url: https://help.sigmacomputing.com/docs/about-sigma
            openTarget: _blank
  pages:
    - id: EqPXLTdOjK
      name: Page 1
    - id: DlLHnvUiOb
      name: Page 2
  kind: workbook
  layout: |
    <?xml version="1.0" encoding="utf-8"?>
    <Page type="grid" gridTemplateColumns="repeat(24, 1fr)" gridTemplateRows="auto" id="EqPXLTdOjK">
      <Element elementId="xIpsxkhmGE" gridColumn="1 / 9" gridRow="1 / 3"/>
    </Page>
    <Page type="grid" gridTemplateColumns="repeat(24, 1fr)" gridTemplateRows="auto" id="DlLHnvUiOb"/>
documentVersion: 2

Representing navigation elements