How do I import dashboards, Klips, and data sources into client accounts?

You can import dashboards, Klips, and data sources from one account to another, for example, from a Parent (Master) account to a client account, from a client to a Parent account, and from one client to another. With this feature you avoid re-creating dashboards from scratch, which is especially useful for Partners who manage multiple clients and want to use the same dashboard across different accounts, with data unique to each client. 

NOTES:

  • You must be signed into the client account as an administrator to import assets or update Klip instances.
  • When a data source is imported, the OAuth token used to create it is not added to the client's Connected Accounts. 
  • When a Klip is imported, all associated data sources are imported with it. When you import a modelled data source, the associated raw data source is also imported.
  • Data source changes and additions cannot be pushed to client instances using Update Client instances. Klips with data source changes and additions must be re-imported.
 This article uses the following terms:
  • master template - the original dashboard, Klip, OAuth token, or data source
  • instance - a copy of a master Klip that was imported into a client account
  • assets - dashboards, Klips, and data sources

 This article includes:

Importing dashboards, Klips, and data sources into client accounts

Importing creates a new unique copy of an asset. When possible, we recommend you import whole dashboards, rather than individual Klips or data sources. This is beneficial because when a dashboard is imported, all associated Klips and data sources are imported with it and the dashboard layout is retained. This saves you from importing and rearranging Klips individually and it is helpful when you want to reuse a dashboard across multiple clients. 

To import dashboards, Klips, or data sources into a client account:

  1. Sign in to the client account as an administrator.
  2. In the left navigation bar, click either Dashboards, Klips, or Data Sources, depending on the type of asset you want to import. 
  3. Click Import.

  1. Select the asset or assets to be imported and click Next.
    Note: You can filter assets by using the drop-down menus at the top of the window.

  1. A list of the assets selected and a list of all associated assets are displayed. Confirm the items to be imported and click Import Now.

The imported asset or assets are now in the client's relevant asset list(s) and can be added to the client's dashboard. They are also ready to be shared, which is essential if you want others to see your dashboard or Klips. See Creating groups and setting default dashboards.

Managing re-imports

If you have issues with re-importing, we recommend the following: 

  1. In the client account, delete the imported assets.
  2. In the Parent account, review the master template Klip formulas and data sources and fix any errors. 
  3. Try the import again.
  4. If the issues persist, contact [email protected].

Updating imported Klips

If you make changes to the master template of a Klip that doesn’t involve new or modified data sources, you can push those updates to client instances (to ensure content alignment) using the Save & Update Client Instances functionality.

However, data source changes and additions cannot be pushed to client instances using this method. Klips with data source changes and additions must be re-imported.

When you update imported Klips all client instances are updated. If you previously made edits to specific instances, those edits will be overwritten during the update process.

Note: Unlike re-importing a Klip, it is not necessary to re-configure scheduled email snapshots and published dashboards.

To view client instances (Klips):

  1. Click Klips in the left navigation bar and select the Klip for which you want to view client instances.
  2. At Client Klip Instances, click View Client Instances.

To apply Klip updates to client instances in the Klip Editor:

  1. From the Parent account, enter the Klip Editor and click the drop-down arrow beside Save and Exit.
  2. Select Save & Update Client Instances.

  1. A list of client instances of the Klip displays. Click Update Now to apply the updates.

 

To apply Klip updates from the list of Klips (after saving the Klip):

  1. Click Klips in the left navigation bar and click the name of the Klip for which you want to update the client instance.
  2. At Client Klip Instances, click Update Client Instances.

  1. A list of the client instances of the Klip is displayed. Click Update Now to apply the updates.

Note: Client instances cannot be updated individually from the Parent account. If you want to modify in only one client, but still want to be able to update instances of the same Klip from the master template for other clients, then a unique copy needs to be made at the client level. For example, if a client would like to modify a Klip to use their company colours, making a copy of that Klip and then modifying the copy ensures that the colours used in the Klip copy are not reset when the client instances of the original Klip are updated from the Parent account.

Managing OAuth tokens for imported data sources

OAuth tokens are not imported and are therefore also not added to the receiving client’s Connected Accounts. Instead, imported data sources refresh using the OAuth token that created them in the Parent Account. When this OAuth token is re-authorized in the Parent account, it is also re-authorized for the imported data sources.

We recommend against creating unnecessary OAuth tokens because many services (such as Google Analytics and Salesforce) limit the number of tokens per account. Once the limit is reached, each new token created automatically invalidates the oldest token. We strongly recommend you keep track of which OAuth tokens are used by the Parent and client accounts.

An OAuth token does not need to be created in the receiving client account if:
  • The imported data source query does not need to be modified
  • No new data sources need to be created
An OAuth token may need to be created in the receiving client account if:
  • The receiving client uses different credentials to access the service
  • A new data source is needed
  • An imported data source query must be modified

Setting up Company Properties to simplify importing

The primary purpose of Company Properties is to enable Partner accounts to create Klips and data sources that can be imported between Parent and Client accounts without having to reconfigure data sources. Often, generic dashboards, Klips, and data sources are created in the Parent account for import to client accounts.

The following example describes the high-level steps to create a data source and a Klip that can be imported into client accounts and used as is. This example assumes you are familiar with variables and dynamic data sources.

In the Parent account:

  1. Either add a Company Property to the Parent account or create a User Input Control Klip that sets a variable named companyID and set the Values subcomponent to a list of all clients' company IDs.
    Note: This is used to allow the Parent account to select and view all client data.
  2. Create a dynamic data source that uses the companyID variable: {props.companyID}.
  3. Create a Klip that uses the dynamic data source created in the previous step and add it to a dashboard.

 In each client account:

  1. Create a Company Property named companyID and assign it the client-specific value.
  2. Import the dashboard from the Parent account. This will bring its Klips and data sources into the client.
  3. Add the imported dashboard to the client's dashboard view. The imported dynamic data source will automatically use the companyID assigned as a Company Property and return the client-specific data used in the imported Klip.

Learn more

Here are some additional resources to help you manage clients: