0

Exporting Dashboards With Dependencies

Introduction

Incorta provides the ability to a la carte export and import individual objects both through the Incorta UI and the Incorta Command Line Interface (CLI). Because any individual dashboard may rely on several supporting objects including session variables, business schemas, and physical schemas, it is incumbent upon the developer to be careful in tracking dependencies when releasing new/updated dashboards. With the goal of easing dependency tracking, Incorta has provided a special CLI script with the capability to export dashboards with all their dependencies (schemas, session variables, data sources, scheduler jobs and drill-down dashboards) that allow migrating your content from one environment to another without worrying about dependencies. To access the script, please reach out to Incorta Support for assistance.

What you should know before reading this article

We recommend that you be familiar with these Incorta concepts before exploring this topic further.

Applies to

This article applies to on-premise versions 4.9, 5.0, and 5.1 of Incorta.

Let’s Go

Customers familiar with managing multiple Incorta environments and deploying new use cases into existing environments know that it can sometimes be challenging pruning a subset of objects necessary to promote just the objects necessary to support the new use cases. Another scenario is deploying the first use case while simultaneously having additional use cases in active development. The new script was developed with the goals:

  • Select a subset of existing dashboards/folders from one environment and generate a package of all required objects to support deploying in a new environment.
  • Optionally install the package into a new tenant or an existing tenant

The Export Dashboards with Dependencies utility consists of two scripts, one for exporting and one for importing. See below for details on each.

The first script [export-dashboard-with-dependencies.sh] is responsible for exporting the desired objects and their dependencies into a zip file. Some of the options for export include:

  • Specifying the list of dashboards and/or folders to export
  • Optionally exclude:
    • Schemas
    • Data Sources
    • Session Variables

The output of the first script is a zip file containing every object necessary to run the exported dashboards in the target environment. The list of potential objects in the export as determined by the dependency inspection could include:

  • Schemas
  • Session Variables
  • Data Sources
  • Target Drill-down Dashboards
  • Scheduler jobs

The next step is to use the second script [] to import the objects into the target environment. Some of the options for import include:

  • Optionally overwrite existing objects
  • Import into new tenant or existing tenant
  • Optionally test incoming Data Source connections
  • Optionally load data after import
  • Optionally execute dashboards post-import to test operation
  • Optional Interactive mode: will prompt for skip or overwrite for each object that already exists
  • Key feature: Join pruning (optionally remove joins from incoming schemas that reference schemas that do not exist in the export file or target environment)
Reply Oldest first
  • Oldest first
  • Newest first
  • Active threads
  • Popular
Like Follow
  • 4 mths agoLast active
  • 22Views
  • 1 Following

Product Announcement

A new community experience is coming! If you would like to have beta access to provide feedback, please contact us at community@incorta.com.