Rivery Kit Hub | Pre-Built Data Model Kits

ahoy

APR 9, 2024

Content

This Sigma Workbook Materialization Kit can refresh Sigma Workbooks through Rivery action/logic rivers using Sigma’s API. Instead of trying to update these sources on a schedule within Sigma, this kit can be scheduled to run directly after a river seamlessly adding the latest and greatest data in the front end dashboard.

This Kit includes…

4 action rivers to refresh the data:

Sign in/Retrieve API Token
Get list of Materializations within a Workbook
Refresh Materializations
Check on Materialization Refresh Status

1 logic river that orchestrates these actions to refresh the selected data sources

Configuring this Kit for use

Variables

In this Kit, there are 4 river variables that need to be modifed in the logic river (Sigma Materialization Logic River) to use.

{sigma_api_server} – This is the server in which your Sigma instance is hosted. This is dependent on your cloud provider. More information can be found here. The default is set to (http://aws-api.sigmacomputing.com).

{sigma_client_id} – This is your Client ID for Sigma’s API. You can find information on where to find this and how ot generate it here.

{sigma_client_secret} – This is your CLient Secret for Sigma’s API. You can find information on where to find this and how ot generate it here.

{sigma_workbook_id} – This is the ID associated with a workbook for an individual dataset’s page in Sigma. To find a workbook ID, you can open the workbook and find the ID as part of the URL; after the workbook name. Specifics on this structure can be found here.

To modify these, go to the Variables menu on the right side navigation bar inside the ‘Sigma Materialization Logic River’ river. You can add the values there and you can also encrypt any values you deem necessary (ex. sigma_client_secret, sigma_client_id)

Directions

The current configuration of this kit allows for one Sigma Workbook and all it’s underlying Materializations to be refreshed. You’ll also need to create and schedule the materializations before they can be triggered with this Kit

Create your Materializations – This is done within a Sigma Workbook of your choice; this requires write access on your dataset’s connection and you must be an organization admin or be assigned a custom account type with materialize permissions. General information on Sigma’s materializations can be found here.

Schedule Materialization – Though this kit refreshes a set of materializations, you’ll still need to schedule the materialization to enable API access. More information on scheduling materializations can be found here.

Although this Kit can be used in a number of different ways, its intended purpose is to refresh a workbook within Sigma where the underlying data has been updated through rivers. The easiest way to do this is to add the ‘Sigma Materialization Logic River’ to the end of another logic river that updates data. This way, when the data river is scheduled, it will automatically push the new data to the connected data source keeping the dashboards as up to date as possible in Sigma.