Installing IncortaMetadata Analytics for version 4.9

[JoeM]

Updated 2021-Feb-05

The steps below will help you get Incorta's own IncortaMetadata Analytics up and running in your own environment in no time.  These steps will help you setup a pre-built schema, business schema and dashboards.

Assumptions & Prerequisites

• Confirm the version of your Incorta installation.   These attachments and instructions are exclusively for version 4.9 and higher.
• These instructions also assume that you are using MySQL as the Incorta metadata database.  If you're using Derby or Oracle for your metadata database, please consult with your Incorta customer success team first.
• These instructions assume that you already have a Data Source connection setup that connects to the Incorta metadata database running on MySQL.  The assets below assume this Data Source connection is called "_IncortaMetadata".  If you do not have one called "_IncortaMetadata", please create one.  Alternatively, if don't have the permission or information to recreate a new "_IncortaMetadata" data source, you can crack open the ZIP file for the schema above and replace the "_IncortaMetadata" name with the name of your existing connection.  Please see the "Optional: Rename Your Data Source" section below for guidance.
• Within the dashboards, any timestamps displayed (e.g. schema load timestamps) will be on server time, which may be offset from local browser time. In fact, it can be a certain number of hours different, and when you are matching dashboard timestamps with time indicated in the UI under Schema Job Details you will need to take this possible time zone difference into account. 
• If you've deployed previous versions of the "Audit" schema or "Incorta Metadata" schema, this install subsumes and supersedes those.  Older versions are now deprecated in lieu of this newer version.  Once you have this up and running, older versions can be removed.

Assets To Download

Download the three zip files attached to this post.  

1. Schema ZIP -- import to create your _IncortaMetadata schema

2. Business Schema ZIP -- import to create your _incorta business schema

3. Content ZIP -- import to create your ~Incorta Admin-Audit folder (which contains the dashboards enumerated below)

Installation Instructions

1. Download the three assets above.
2. Import the schema zip.  It will create a schema named _IncortaMetadata, and you will want to make sure you check the overwrite existing schema checkbox when importing.  
3. Import the business schema.  It will create a business schema called _incorta
4. Import the content ZIP where you wish in your content structure.  It will create a folder named ~Incorta Admin-Audit which will contain the dashboards
5. Perform a full load on the newly created _IncortaMetadata schema.  Create a periodic scheduled job (daily, hourly, whatever frequency you want) to keep the metadata updated.
6. Explore the dashboards in the ~Incorta Admin-Audit folder.  A brief overview of the dashboards can be found below.

Overview of the IncortaMetadata Dashboards

• 0. Environment/Tenant Overview - Lists all tenants on the server, users/groups, and all objects (schemas, datasources, datafiles, dashboards/folders, session variables).
• 1. Dashboard/User Analytics (BI Audit) - User engagement and dashboard analytics. This dashboard is driven from the audit log file.
• 2. Job/Load Summary (Schemas/Tables) - Summary of jobs (extracts/loads) historically.
• 3. Job Execution Analytics (within one day) - Analytics regarding load jobs (extracts/loads) with default of previous day.  It includes a job gantt chart for looking at the phases and timings of a schema load.
• 4. Dashboards - Provides information on Dashboard and Folder details. 
• 5. Objects Shared - by Group/User - Overview of objects (schemas, folders, dashboards, etc) shared with groups/users. 
• 6. Security (Users/Groups/Roles)    - Overview of Users/Groups/Roles. 
• 7. User Actions - Tracing actions in the environment to users.
• 8. Schema-Table Metrics - Metrics on data volumes in the environment (rows by Table/Schema/Tenant).
• 9. SQL Query / User Analytics (BI SQLi_Audit) - SQL query analytics, driven from SQLi_Audit log file. 

Happy Analyzing!

Optional: Rename Your Data Source

If you don't have permission to create a data source or don't have the MySQL credentials handy to create your own "_IncortaMetadata" data source, you can follow these steps to replace the "_IncortaMetadata" data source name with your existing MySQL metadata connection's name.

1. Download the Schema ZIP attached to this post.
2. Uncompress it.
3. Find the files schema.xml and loader.xml and open them with your favorite text editor.
4. In both files, find ource="_IncortaMetadata" and replace it with ource="YourExistingDataSourceName"
5. Save the files.
6. Rezip the folder into a new ZIP file
7. Use the new ZIP file in the import step above and the schema will now create tables that work with your existing MySQL data source connection.