Deploy content to tenant organizations (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 a premium feature. To enable it for your Sigma organization, contact your Sigma Account Executive.
You can deploy documents to tenant organizations from parent organizations or other tenant organizations. Documents deployed to a tenant organization are automatically updated when the source document is published (or a new version is tagged) in the source organization, and cannot be edited in the receiving tenant organization.
Which documents gets deployed and how to swap the data sources used by the relevant documents is defined in a deployment policy. You can create multiple deployment policies to manage which documents to deploy to which tenants, and tenants can receive documents from multiple deployment policies.
Each deployment policy creates a workspace in each tenant that receives the deployed documents, so you can manage user access to deployed documents by changing permissions on the workspace in the tenant.
What gets deployed to a tenant
Sigma currently supports sharing documents (workbooks and data models) with the following contents:
- Custom functions
- Plug-ins (workbooks only)
- Input tables (workbooks only), see How input table data is deployed for more details.
- Stored procedure actions (workbooks only)
- Metrics, relationships, and column-level security settings (data models only)
In addition, data models and datasets used as data sources of deployed documents are also automatically deployed. Data models deployed as data sources of workbooks are visible in tenant organizations, but datasets are unavailable for use.
After a document is deployed, it is automatically updated when the source document is published or a new version is tagged. A deployed document cannot be edited in the tenant organization, but users with the relevant permissions can save a deployed document as a new document in the tenant, or create workbooks that use deployed data models as a data source.
Additional limitations apply when deploying documents. Review Recreate settings after deploying documents.
Manage deployed documents
Before you deploy documents to a tenant organization, make sure that each tenant organization has a connection to one or more data sources, and that the connection has been synced.
How input table data is deployed
When a deployment policy contains one or more documents with an input table, the data entry permissions set on the input table and the option enabled on the deployment policy manage whether the input table data is included when the document is deployed:
| Data entry permission | Copy input table data toggle | Details |
|---|---|---|
| Only editable in draft | Copy input table data toggle turned on | Input table rows from the document in the parent organization are copied to the deployed document when the document is published. |
| Only editable in draft | Copy input table data toggle turned off | Empty input table is copied, and structure of the input table is updated when the document is published. Users cannot add data to the input table in the deployed document. Users in the tenant organization cannot add data to the input table of the deployed document. |
| Editable in published version | Any | Empty input table is copied, and structure of the input table is updated when the document is published or tagged. Users in the tenant organization can add data to the input table. If the data structure is changed to e.g., delete a column, the data in that column is nuked |
If you change the data entry permission of the input table after deploying the document, the following happens:
-
If you change from Editable in published version to Only editable in draft, the data in the input table in the deployed workbook is replaced with the data from the parent organization.
The data in the input table in the deployed document on the tenant organization is deleted and cannot be recovered.
-
If you change from Only editable in draft to Editable in published version, the input table data included when the document was originally deployed is not deleted, and users in the tenant organization can make changes to the input table and its data. If you want to remove data from a deployed input table, you must delete the data in the source document and then publish or tag the document to deploy the empty input table.
When data in an input table is copied to tenant organizations, it is written to a Sigma-owned S3 bucket and deleted within 2 hours. Data is only accessible to the parent organization and its tenants.
Deploy content to tenant organizations
You can deploy content to tenant organizations from a parent organization, or from another tenant organization.
To deploy content from a parent to one or more tenants, see Deploy content from a parent organization to one or more tenants.
Example deployment configurations
Depending on how you plan to use Sigma Tenants, you might set up different deployment configurations. For end-to-end examples and detailed configuration steps for common use cases, see Deployment use cases and examples.
Updated about 3 hours ago