Managing reporting for IBM Knowledge Catalog

Prerequisites

Before you start the reporting synchronization, make sure that you use a clean schema with no reporting tables present at it.

If you are using an existing schema, you don't need to delete that schema. Delete all the tables that are present under your schema:

DROP TABLE <SCHEMA_NAME>.<TABLE_NAME>;

Reporting synchronization

• When you click Start reporting, the data is sent to the selected database, and you can start generating reports with SQL queries. Refer to the data model diagram to get started with the queries.

The data is automatically synchronized between IBM Knowledge Catalog and the database. Any change in the catalog, project, category, or data protection rule that is enabled for reporting is reflected on the database.

• You can stop the synchronization of IBM Knowledge Catalog data into the reporting data mart when interruptions occur. When you stop reporting, the data is no longer synchronized and it is deleted from the database. The existing reporting settings are retained.
• When interruptions occur instead of stopping the reporting completely, you can pause the synchronization of IBM Knowledge Catalog data into the reporting data mart. Any updates that are made to assets or artifacts while paused are processed when you resume synchronization.

Automatic sychronization and update of data in the data mart

Data is initially synchronized with the data mart when you enable and start the reporting.

If a failure occurs, automatic synchronization is retried up to four times.

After reporting is established, the data mart is synchronized only when changes occur in the data for which reporting is configured. For example, changes in the assets or governance artifacts, or their attributes, relationships, or assignments.

You can't configure a synchronization interval.

Handling synchronization failures and manual restart of the synchronization

If the inital synchronization for a particular item fails, the metadata that is related to that item is not synchronized to the target tables in the data mart. Instead, this data is skipped until you resolve the underlying problem. After you resolve the issue that triggers the error, the details of that missing asset or artifact are automatically updated in the data mart.

Furthermore, upon any update in the reporting setting, all assets that were skipped are also queued for an update.

If the synchronization fails after you modify the reporting settings, the synchronization is still established for the previous settings.

In case you believe that the cluster or database is out of sync, you can restart the synchronization manually in the user interface.

• For those items that failed. This option restarts only the containers or features that failed.
• For items that failed and items in the queue. This option restarts all the items that had not yet started (if there are any) and the failed containers or features.
• For all configured items. This option restarts all the items that had not yet started (if there are any) and the failed or passed containers or features.

Depending on the option you choose, the process might take a while. Learn more about Setting up reporting for IBM Knowledge Catalog.

If you want to remove the reporting data from the database and start with a new configuration, complete these steps:

1. Click Stop reporting. The data is no longer synchronized and it is deleted from the database. The existing reporting settings are retained.
2. Click Reset settings. The settings are restored to the default state. You can then define a new connection and configure the reporting in a different way.

Parent topic: Setting up reporting for IBM Knowledge Catalog