Data Catalog Package Installation and Configuration Guide

This guide provides step-by-step instructions for installing and configuring the Data Catalog package in Incorta.

• Prerequisites
• Pre-Installation setup
• Installation steps
• Post-Installation verification
• Initial load
• Dashboard customization requirements

Prerequisites

• Ensure you have Tenant Owner or Admin privileges to perform this installation.
• Install the following components from Marketplace → Components: Slicer, Multi Slicer, Dual KPI, and Relative Date Slicer
  • For Cloud Instances:
    1. Navigate to Marketplace → Components.
    2. Search for the components listed above.
    3. Select Install for each component.
    4. Wait for installation to complete.
    5. Verify the installation by confirming the components appear in the installed components list.
  • For On-Prem Installations:
    1. Go to Incorta Marketplace.
    2. Search for and download the components listed above.
    3. Save the component files to your local machine.
• Identify your metadata database type:
  • On-Premise deployments: MySQL or Oracle (confirm with your administrator)
  • Cloud deployments: MySQL

Pre-Installation setup

Upload components to Incorta (On-Premise only)

1. In Incorta, navigate to an existing dashboard or create a temporary one.
2. Select Edit to enter edit mode.
3. Locate and open the Add Insight panel on the right side of the page.
4. Select External Component → Add Component.
5. Select Upload, then select the first component file.
6. Repeat step 5 for each of the remaining components.
7. Select Refresh or reload the dashboard page.
8. Verify the installation by opening Add Insight → External Component and confirming that all components are listed.

Create a metadata datasource

1. Navigate to Data Sources.
2. Create a new datasource with the following details:

3. Test the connection.
4. Select Save.

Installation steps

Step 1: Download and extract the package

1. Download data-catalog-blueprints.zip:
   • Select Data Catalog → More Options (⋮) → Download Catalog Overview Assets
     OR
   • Select Data Quality → More Options (⋮) → Download Catalog Overview Assets
2. Extract data-catalog-blueprints.zip.
3. The extracted contents include:
   • MySQL folder
   • Oracle folder
   • load_plans.zip file
4. Navigate into your metadata type folder: MySQL or Oracle
5. Extract the data-catalog.zip file inside that folder.
6. The extracted data-catalog folder contains:
   • schemas.zip
   • business_schemas.zip
   • dashboards.zip

Folder structure overview

Copy
data-catalog-blueprints/
├── MySQL/
│   └── data-catalog/          ← Extract and work from here
│       ├── schemas.zip
│       ├── business_schemas.zip
│       └── dashboards.zip
├── Oracle/
│   └── data-catalog/          ← Extract and work from here
│       ├── schemas.zip
│       ├── business_schemas.zip
│       └── dashboards.zip
└── load_plans.zip            ← Use from parent folder

Step 2: Import schemas

1. Navigate to Schema → Import.
2. Select schemas.zip from the extracted data-catalog folder.
   • The location is MySQL/data-catalog/schemas.zip for MySQL and Oracle/data-catalog/schemas.zip for Oracle.
3. Enable Overwrite (required for both new installs and upgrades).

Imported schemas

• _incortaGovernanceMetadata
• dataCatalog
• datacatalog_audit

Step 3: Import business schemas

1. Navigate to Business Schema → Import.
2. Select business_schemas.zip from the extracted data-catalog folder.
3. Enable Overwrite (required for both new installs and upgrades).

Imported business schemas

• Data_Catalog_Audit_KPIS
• Data_Classification_BV_V1

Step 4: Import dashboards

1. Navigate to Content → New → Import Folder/Dashboard.
2. Import dashboards.zip with Overwrite enabled (required for both new installs and upgrades).

Imported folder

The Data Catalog Samples folder contains the following dashboards:

• Data Catalog Audit KPIS
• Data Classification KPIS V1

Step 5: Import and configure load plan

1. Navigate to Scheduler → Load Plan → Import Load Plan.
2. Select load_plans.zip from the main data-catalog-blueprints folder (not from inside MySQL/Oracle).
3. Enable Overwrite (required for both new installs and upgrades).

Imported load plan

• Data Catalog Load Plan: Refreshes data catalog metrics
• Default Schedule: Weekly
• To Modify Schedule:
  1. Navigate to Scheduler → Load Plans.
  2. Select the plan to modify.
  3. Select Edit Schedule.
  4. Adjust frequency and timing as needed.
  5. Save changes.

Post-Installation verification

Verify schemas

1. Navigate to Schema.
2. Confirm that all three schemas are present.

Verify load plans

1. Navigate to Scheduler → Load Plans.
2. Confirm both load plans exist.
3. Check configuration and schedule settings.

Verify business schemas

1. Navigate to Business Schema.
2. Confirm that two business schemas are present.
3. Ensure tables are accessible without errors.

Verify dashboards

1. Navigate to Content → Data Catalog Samples folder.
2. Verify that all dashboards render correctly.

Initial load

After installation, you must run the load plans as follows:

1. Navigate to Scheduler → Load Plans.
2. Select Data Catalog Load Plan → Run Now.
3. Wait for completion (monitor progress in Schema → Load Jobs).
4. After the load finishes successfully, verify that all dashboards under Content → Data Catalog Samples folder render correctly.

Dashboard customization requirements

To customize the overview dashboards, Data Governors require the following permissions:

• Analyze User role
• View access to all required imported schemas and business schemas

Grant access

Tenant Owners or Admins should complete the following steps to grant access:

1. Add Data Governors to a group with the Analyze User role assigned.
2. Share the following schemas with the Data Governor group:
   • Imported Schemas (3):
     • _incortaGovernanceMetadata
     • dataCatalog
     • datacatalog_audit
   • Business Schemas (2):
     • Data_Catalog_Audit_KPIS
     • Data_Classification_BV_V1
3. Share the Data Catalog Samples folder with the Data Governor group and grant Edit permission.