Setting up reporting for IBM Knowledge Catalog

Configure reporting to query metadata from IBM Knowledge Catalog, IBM Knowledge Catalog Standard, or IBM Knowledge Catalog Premium and generate dashboards and reports by using BI tools such as Cognos Analytics and Tableau. The insights allow your data and governance teams to make use of data analytics, identify data issues, and efficiently allocate resources.

To create a report, use an SQL query to pull the data to a supported external relational database of your choice. Then, connect to a reporting tool like Cognos Analytics to generate reports, see Sample reporting queries for IBM Knowledge Catalog.

To ensure that sensitive data is protected, you can send data to various schemas on the database, and restrict access to these schemas.

Only top-level categories can be enabled for reporting. Subcategories use the same schema as their top-level categories.

Types of data you can query and report

You can create reports on many types of metadata if you have the required permissions:

Catalogs

Catalog and asset metadata information (for example, tags and description)
Asset to asset relationship (for example, child-parent relationship)
Asset to governance artifact relationship
Data quality rules (for example, definition, binding, and execution)
Data quality checks (for example, asset and column problems)
Asset to a governance artifact or category custom relationship (for example, a custom property to business term relationship)

Projects

Metadata imports
Metadata enrichments (for example, artifact assignment)
Asset to asset relationship
Asset to governance artifact relationship
Data quality rules (for example, definition, binding, and execution)
Data quality checks (for example, asset and column problems)

Governance artifacts

Custom properties in governance artifacts
Custom category roles
Metadata of category with custom role
Metadata of all the governance artifacts (for example, business terms)
Associations between all governance artifacts
Associations between data protection rules and governance artifacts

Admin

Workflows for governance artifacts (for example, workflow for creating a business term)

Requirements

Supported database types

Db2 on Cloud with a Standard or Enterprise plan

If you select a Db2 database for storing the reports, make sure to create the database with 32 K page size.
```
db2 create database <DATABASE_NAME> PAGESIZE 32 K
```
PostgreSQL version 12 and later
Microsoft SQL Server 2022 and later
Microsoft Azure SQL Database

Prerequisites

You need a connection to a supported type of database. If no connection is defined in the platform connections, contact your administrator to configure at least one. See Creating the catalog for platform connections.

When a connection used for reporting is configured to use SSL certificate from a CyberArk vault, use Custom secret type, not Key.

Required permissions

To configure the reporting, you must have:

Reporting Administrator role for IBM Cloud Pak for Data service access roles. For more information, see User roles and permissions for IBM Knowledge Catalog and watsonx.ai Studio.

Alternatively, create an access group containing the same access level policies. Then assign users to this access group. See Setting up IAM access groups.

Users with the Reporting Administrator role can send all metadata from any project, catalog, or category to an external database regardless of membership or access permissions in existing projects, catalogs, and categories. However, when creating or editing a project, catalog or category, the owner can allow or disallow metadata reporting.

Procedure to set up and configure reports

When you configure reporting you select where to send the IBM Knowledge Catalog data and what data to use for reporting.

To set up the reporting:

Go to Administration > Configurations and settings > Reporting setup.
Select a connection to a database. If no connection is defined, see Prerequisites.
Select the default schema. All data is written to the selected schema by default, but you can edit the schema for a particular catalog, project, or category. Make sure that the database users have write access to the selected schemas.
Enable the catalogs, projects, categories, or data protection rules for which you want to run the reports.
Click Save settings.

Next steps

Before you start reporting you can modify the settings. For example, you can change the schema that you use, enable and disable data for reporting by using the slidebar for each concrete type of data. After you save the new settings and update the reporting, the reports are updated. For more information, see Managing reporting for IBM Knowledge Catalog.

To better understand the relationships between the SQL tables that store the reporting data, see Data model for IBM Knowledge Catalog reporting.

Learn how to handle synchronization failures in Managing reporting for IBM Knowledge Catalog.

Learn more

Parent topic: Planning to monitor IBM Knowledge Catalog