Introducing Version Tagging for Sigma Workbooks
Streamline your workbook development lifecycle with new version control features
We're very excited to introduce Version Tagging in Workbooks!
With Version Tagging, you can now seamlessly manage, control, and organize multiple iterations of your workbooks throughout their lifecycle. This empowers your teams to develop and stage multiple versions of the same workbook for different users, ensuring an efficient and streamlined collaboration process.
Learn more about Sigma’s embedded analytics capabilities here.
What is a Version Tag?
A Version Tag is a feature in Sigma workbooks that allows users to manage, control, and organize multiple iterations of their workbooks throughout their software development lifecycle (SDLC). This tool is used to mark or label different stages or versions of a workbook, allowing for a more efficient and streamlined collaboration process.
Why Version Tagging Matters
The SDLC of a workbook in Sigma has multiple stages. From first designs to early proofs to full production workbooks with multiple data sources, going from start to finish can take multiple steps and multiple iterations. As you work through these steps, it's sometimes essential to control and share stable versions with different stakeholders based upon their relevance to any project. Now you can modify workbooks at different stages without affecting the core experience of any one given user.
Read about Sigma’s Input Tables feature here.
How to Use Version Tagging
1. Create Tags: If you’re an administrator in your Sigma organization, you can go to the administration panel and create the tags you want for your workflows. You can add descriptions and select colors for your tag. This color will allow you to easily identify the tag on your workbooks.
These tags can be named according to your workbook development lifecycle, and the significance of them is based on how you use them. For example: If your organization has a process that moves workbooks from development to staging for testing, and needs an approval from the governance team before moving to production, you will create three different tags: Staging, Governance, and Production
2. Assigning tags: Once an administrator has created tags, the creator of the workbook will be able to apply these tags to drive the workbook through different stages of its development lifecycle. In the workbook view, an owner or admin can click on “Tag this published version” to tag a copy of their workbook with your new “Production” tag.
3. Swapping connections: When a workbook is tagged, you have the option to swap the connection used by the tagged version.Your organization may have different data access levels between teams. For example, you might have production data that is not shared with developers or QA. This allows you to show the correct data to the right audience.
4. Sharing a tagged workbook: A tagged workbook can be shared with stakeholders that have limited access to making or viewing core changes to the main workbook. From the share modal on the workbook, select the users or teams that need access to the tagged version and select the tag from the list. For example: for your stakeholders or customers, you may want to only provide them with access to “Production” tagged workbooks. This way, they will not see any workbook versions that are not tagged production.
5. Version Tagging for Embedding: In an embedded environment, it is critical to control when changes made to embedded workbooks in Sigma are deployed/rolled out to your customers. This is because embedded workbooks are exposed to a potentially large number of the embedding application’s users, and it is imperative to provide a stable experience to these users. Additionally, it is quite common that changes to embedded workbooks need to be migrated to non-development environments in tandem with other changes being made to the embedding application.
6. Using Version Tagging APIs: To specify the version tag you would like to use in an embed, you can add ‘/tag/<tag_name>’ to your embed path. For example if your embed path was 'https://app.sigmacomputing.com/embed/7KnctsOB98suXFKLBIpiw7' then you could use ‘https://app.sigmacomputing.com/embed/7KnctsOB98suXFKLBIpiw7/tag/Development’ to display the dev version of the workbook in the embed. So even if in Sigma you are looking at production data, the embed will show the dev version as the tag is used to generate the embed. To show the prod version instead, you would use ‘https://app.sigmacomputing.com/embed/7KnctsOB98suXFKLBIpiw7/tag/Production’. Check out the documentation for the Version tagging API here.
7. Version Tagging + Input Tables: Version Tagging also supports Input Tables! You can add input tables to your workbooks and tag them with version tags you have already created. Now you can share a tagged workbook with others and allow them to edit and add data to your production workbook. Confidently deploy your workbooks while also letting anyone add new data to that workbook like a custom application!
One important behavior to note is that when you tag a workbook that has an input table, the data in that input table is not copied over. We maintain different environments for your tagged versions so that users only see and interact with the data that is relevant to them. If data needs to be copied over, feel free to use our copy paste feature to bring that data into the tagged version if needed.
Learn more about Sigma Input Tables here.
Workbook Version vs. Version Tag
In Sigma, the published view will show the latest version. You can go into your version history by clicking on the dropdown next to the workbook name to see the different versions. Each time you publish your workbook, you are creating a new version of the workbook. In the version history, you will also be able to see every version where you have applied a tag. A version tag can be applied to any workbook version. At a given point there will be one workbook + unique tag combination.
You can restore to older versions or apply tags to an older version as well. This easy access menu allows you to see the history of the workbook as well as the application of different version tags on it.
Benefits of Version Tagging
- Version tagging saves you time, providing a simpler way for workbook lifecycle management within the same workbook.
- You can easily iterate on workbooks and collaborate with peers to publish changes without worrying about breaking the experience for your customers or stakeholders.
- Additionally, you can provision different access to different data to developers, QA personnel, and customers by swapping connections, databases, and/or schemas before tagging workbooks
- Version tagging also gives users the ability to integrate the workbook lifecycle management capabilities into Git via Sigma Version Tagging APIs.
- Finally, the URL follows the tag as it floats to a new workbook version when that version is associated with the tag.
We're excited to bring this feature to you. To get started with Version Tagging, chat with your customer success representative on how it could enhance your team's workflow. Check out our help documentation or follow a quickstart guide to try it out yourself.
If you don’t have Sigma yet, chat with one of our friendly and helpful representatives to get your organization on Sigma or sign up for a free trial here.
