Setting up reporting for Watson Knowledge Catalog

You can generate reports to get insights about the Watson Knowledge Catalog data. The data from which you generate reports is saved in an external database. This data captures information about catalogs, projects, and governance artifacts.

Example reports can show the following information:

• The list of catalog assets with no business terms assigned
• The number of catalog assets that are grouped by tag and asset type
• The list of catalog assets with a particular business term is assigned
• The list of assets where a particular user is assigned as a steward

You can generate reports on the following information:

• Data quality rules (definition, binding, and execution)
• Data quality problems (asset and column problems)
• Custom properties in governance artifacts
• Custom category roles

The external database into which the Watson Knowledge Catalog data is written is a relational database. You can use SQL to query for the needed data. You can connect to a reporting tool to generate reports, for example to Cognos Analytics. Sample queries are provided in the Sample reporting queries for Watson 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.

Supported database types are:

• Db2

• PostgreSQL version 12, and later

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

PrerequisitesA nonvaulted connection to a supported type of database is required. If no connection is defined in the platform connections, contact your administrator to configure at least one. See Connecting to data sources at the platform level.

Required permissions To configure the reporting, you must have these user roles:

• Reporting Administrator
• Manager

If you have the Administrator role for the IBM Cloud account, you have permissions to generate reports.

Configure the reporting settings

To set up the reporting:

1. Go to Administration > Catalogs > Reports setup.
2. Select a connection to a database.
3. 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.
4. Enable the catalogs, projects, categories, or data protection rules for which you want to run the reports.
5. Click Save settings.

You can modify the settings. You can change the schema, and enable or disable data for reporting. The reports are updated after you save the new settings and update the reporting. Learn about reporting features and how to handle synchronization failures in Starting, stopping, pausing, and resuming reporting for Watson Knowledge Catalog.

Data model

The following image shows the data model that you can use to create SQL queries to generate reports onWatson Knowledge Catalog data.

For more information about the SQL tables, see:

• Description ofDb2 SQL tables that are used for Watson Knowledge Catalog reporting
• Description ofPostgreSQL SQL tables that are used for Watson Knowledge Catalog reporting

You can use a database storage estimator to calculate the size of your target database. Add your own data and the estimated storage size of the database is calculated automatically. Download the database storage estimator template.

Learn more

• Starting, stopping, pausing, and resuming reporting for Watson Knowledge Catalog
• Sample reporting queries for Watson Knowledge Catalog
• Description of Db2 SQL tables that are used for Watson Knowledge Catalog reporting
• Description of Postgres SQL tables that are used forWatson Knowledge Catalog reporting
• Projects
• Catalogs
• Categories
• Data protection rules
• Governance artifacts
• Connecting to data sources

Parent topic: Administering a catalog