Share content with tenant organizations

Share content, such as workbooks, with tenant organizations. Content that you share with a tenant appears in a workspace in the tenant and is available to all members of the tenant organization with an access level that you specify.

📘

Workbooks that contain custom functions, themes, or fonts can be shared, but those customizations can't be edited within the tenant organizations to ensure consistency and centralized governance.

Manage what you share with tenant organizations by defining deployment policies. Each deployment policy creates a workspace, so you can restrict user access to specific documents by changing permissions on the workspace.

You can specify the following:

• Which documents, and optionally which tagged versions to share
• The connection in the tenant organization to use for the shared documents
• The tenants with which to share the documents

Any update to a shared workbook, such as publishing or tagging a new version, is automatically deployed to the tenants specified in the relevant deployment policy and immediately available to use.

Prepare to share content

🚩

Before sharing content, make sure that each tenant organization has a connection to a data source set up and configured.

After setting up connections to data sources in tenant organizations, the first time you share content from the parent organization, do the following:

1. Create a user attribute to use to manage tenant connections.
2. Assign the user attribute to specific tenants to map the connections to tenants.
3. Configure a source swap policy for the user attribute to manage swapping connections.
4. Define a deployment policy to manage sharing content with tenants.

💡

If you add a new connection to all tenants, perform all 4 steps again.

Steps when adding a tenant

After these setup steps have been performed once, the next time you add a new tenant you only need to perform the following steps:

1. Assign the user attribute to the new tenant.
2. Add the tenant to the deployment policy.

Example configurations

Depending on how you manage your data and documents, you can set up your tenant organizations and deployment policies in different ways.

• Example: One connection per tenant
• Example: Two connections per tenant

Example: One connection per tenant

If each tenant is associated with a customer, and each tenant has one connection set up to use for all workbooks:

1. Create one user attribute, tenant_connections
2. Assign the tenants to their respective connection IDs in the user attribute.
3. Create one source swap policy to manage swapping connections between the parent organization and the tenant organizations.
4. Create one or more deployment policies depending on what content you want to share to which tenants.
5. Add documents and tenants to each deployment policy.

Example: Two connections per tenant

If each tenant is associated with a customer and each tenant has two connections set up, one a dev connection and one is a production connection:

1. Create two user attributes:
   • tenant_dev_connections
   • tenant_prod_connections
2. Assign the tenants to their respective connection IDs for each user attribute.
3. Create two source swap policies, one for each user attribute.
4. Create at least two deployment policies:
   1. One deployment policy to share the Dev tagged workbook versions using the source swap policy associated with the tenant_dev_connections user attribute.
   2. One deployment policy to share the Prod tagged workbook versions using the source swap policy associated with the tenant_prod_connections user attribute.
5. Add documents and tenants to each deployment policy.

Prerequisites

To share content with tenant organizations, you must know the connection ID of each connection configured on a tenant. You need the connection ID when assigning the user attribute to one or more tenants.

1. In the Administration portal, go to Tenants.

2. Locate the tenant that you want to configure, then select More > Open tenant as admin.

3. In the tenant, open the Administration portal and go to Connections.

4. Select the connection that you want to use.

   The connection ID is visible in the URL:

   https://app.sigmacomputing.com/<tenant-organization-slug>/admin/connections/<connection-id>

Create a user attribute to manage tenant connections

When you prepare to share content to tenant organizations the first time, create a user attribute to manage tenant connections as part of a deployment policy. Create one user attribute for each deployment policy that you plan to use to share content to tenants.

To create a user attribute, see Configure user attributes.

Assign the user attribute to one or more tenants

To map the connections to tenants and ensure that the source swap and deployment policies swap the sources of the content to tenants to the correct connections, assign the user attribute to specific tenants.

📘

You must know the connection ID of each connection configured on a tenant organization to perform this step.

Assign the user attribute to one or more tenants.

1. In the Admin portal, go to User attributes.
2. Select the user attribute that you created. For example, tenant_connections.
3. On the user attribute detail page, select Tenants Assigned.
4. Click Assign Attribute to Tenants.
5. In the Assign Attribute modal, search for and select one or more tenant names.
6. For each tenant that you want to assign, specify an Assigned Value. The assigned value must be a connection ID.
7. Click Assign.

Configure a source swap policy

To manage swapping connections for the documents shared as part of a deployment policy, configure a source swap policy for each user attribute that you set up:

1. In the Admin portal, go to Source swap policies.
2. Click Create policy.
3. For Name, enter a name for the policy. For example, Tenant Connection Policy.
4. For Type, select Deployment.
5. For Swap on, leave the default of Connection.
6. For User attribute, select the user attribute that you created and assigned to tenants. For example, tenant_connections.
7. Click Create.

After creating a source swap policy, share content with tenants.

Share content with tenants

To share content with tenants, define one or more deployment policies that specify what content to share to which tenants.

For example, you might define a deployment policy with a set of starter workbooks for each tenant to have, and then a separate policy with specialty workbooks that are only relevant to a subset of tenant organizations. Sigma currently supports sharing of these features:

• Custom functions and plug-ins
• Data models
  • Data models with metrics
  • Relationships
• Data sets
• Input tables
• Stored procedures for database connections

📘

You may need to manually sync the stored procedure in the shared tenant.

When you add a workbook with a data model to a deployment policy, Sigma also shares the data model itself with your tenant organizations. Tenants can build directly on top of shared models for faster, more consistent workflows.

Currently, these features aren't supported for sharing with tenants:

• Materializations
• Warehouse views

Each deployment policy creates a workspace in the tenant organization, and all documents shared by the deployment policy are placed in the workspace and accessible to all users of the tenant. You can manage access to each workspace created on a tenant. See Manage workspaces.

💡

A tenant can be added to multiple deployment policies. Each deployment policy creates a separate workspace in a tenant organization.

Define a deployment policy

To manage sharing content with tenants, define a deployment policy:

1. In the Administration portal, go to Tenants.
2. Select the Deployment policies tab.
3. Click Create deployment policy.
4. For Name, name the deployment policy. The name of the deployment policy is the name of the workspace created in the tenant organization. For example, for a set of content to deploy when you first create a tenant, name the policy Starter pack.
5. [optional] By default, the published version of the documents added to the deployment policy is shared. If you want to share a tagged version instead, for Version tag, choose a version tag.
6. For Swap data sources, search for and select the connection in the parent organization used by the documents that you want to share, then choose the source swap policy to use to swap the connection for each tenant organization.
7. [optional] Add another connection and source swap policy.
8. Click Create.
   Your deployment policy is created. Select it to add documents and tenants.

Add documents to the deployment policy

After creating a deployment policy, add documents to share them with tenants:

1. In the Administration portal, go to Tenants.
2. Select the Deployment policies tab.
3. Locate and select the deployment policy to which you want to add documents.
4. Click Add document.
   The Add document modal opens.
5. For Permission, choose a permission with which to share the documents. All members of the tenant organization are granted this permission on the shared documents.
6. Search for and select a workbook to share with tenant organizations.
7. Click Add.

Add tenants to the deployment policy

After creating the deployment policy, add tenants to share the documents with:

1. In the Administration portal, go to Tenants.
2. Select the Deployment policies tab.
3. Locate and select the deployment policy to which you want to add tenants.
4. Select the Shared with tab.
5. Click Add tenant.
6. In the Add tenant modal, search for and select one or more tenants.
7. Click Add.

After adding a tenant, a workspace appears on the tenant named after the deployment policy. The workspace contains any documents shared as part of the deployment policy. The workspace and all documents shared should appear within a few minutes.