Getting started with the Knowledge Accelerators

Quick start

The following table outlines the main steps to import a Knowledge Accelerators artifact.

Descriptions of the API endpoints for the Knowledge Accelerators can be found at https://cloud.ibm.com/apidocs/watson-data-api-cpd#list-kas.

Watch this video, which describes how to import the Knowledge Accelerators.

Video disclaimer: This video provides a visual method to learn the concepts and tasks in this documentation. Some minor steps and graphical elements in this video may differ from your Cloud Pak for Data deployment.

Requirements and permissions

The Knowledge Accelerators are available to import into IBM Knowledge Catalog, to IBM Cloud Pak for Data users with the following user permissions.

Required permissions

You must have these user permissions to import the Knowledge Accelerators:

• Manage governance categories
• Manage glossary

Authenticating and Authorizing

To authenticate with Cloud Pak for Data, you need to generate a token.

1. To generate a token, follow the instructions in the Authentication topic.

Choosing which Knowledge Accelerator items to import

When you are planning to import Knowledge Accelerators content, consider the following two main options.

Importing a selection of Business Scopes

A selection of Knowledge Accelerator Business Scopes are available to be imported separately, for example Data Privacy and other industry specific scopes. If one or more of these business scopes exists for an area you are interested in, and if you prefer to start with a relatively small number of business terms, for example 200 to 500 terms, then you can install one or more of these separate scopes.

Importing some or all of the Knowledge Accelerator vocabularies

The Knowledge Accelerators vocabularies exist for each of the four specific industries and contain the complete Business Vocabulary, Industry Alignment Vocabularies, and all the Business Scopes. You can choose to import all or a selection of these vocabularies. If there is a need to import an extensive set of business terms to address the breadth of an industry, for example 5,000 to 20,000 terms, then select this option.

Checking which items are available for import

See https://cloud.ibm.com/apidocs/watson-data-api-cpd#list-kas

Checking which items are available for import per industry

See https://cloud.ibm.com/apidocs/watson-data-api-cpd#get-ka-by-id.

kaci20

kaeu20

kafs20

kahc20

kain20

Checking which Knowledge Accelerators are already imported

See https://cloud.ibm.com/apidocs/watson-data-api-cpd#get-ka-status.

Importing the Knowledge Accelerators

To import Knowledge Accelerators items into an instance of IBM Knowledge Catalog, call the Import specified Knowledge Accelerator items into the glossary API endpoint.

See https://cloud.ibm.com/apidocs/watson-data-api-cpd#import-ka-into-ikc.

1. Choose the items that you want to install. See Checking which items are available for import and Checking which items are available for import per industry.
   Tip: For each industry, you have the option of importing specific business scopes or the full industry Business Core Vocabulary and optional Industry Alignment Vocabularies. For a detailed list of all available items, including a definition, the identifiers, and more information, see the following links.

   • Knowledge Accelerator for Cross Industry
   • Knowledge Accelerator for Energy and Utilities
   • Knowledge Accelerator for Financial Services
   • Knowledge Accelerator for Healthcare
   • Knowledge Accelerator for Insurance
2. Enter values for the following parameters.
   For example:

   Parameter	Description	Example
   ka_id	The id for an industry	kafs20
   ids	The id for one or more Knowledge Accelerator items you want to import separated by a comma. Please note that you can only import one scope at a time.	core-bpi,ccpa,fhir, gdpr
   merge_option	The merge option to be used when importing into IBM Knowledge Catalog.	all
   dependencies	Indicates which dependencies of the item ids specified should also be imported.	mandatory
   do_import	Select false to check the parameters and find out what will be imported. Select true to import.	false

3. In the response, take note of the "process_id" as you can use this to check the status of the import job in the next section, Checking the status of the import job. It might be necessary or desirable to do this check, as sometimes the import can take some time, depending on the number and size of the items that were imported.

Checking the status of the import job

See https://cloud.ibm.com/apidocs/watson-data-api-cpd#get-import-status where {process_id} is the value from Importing the Knowledge Accelerators.

The import status remains "IN_PROGRESS" until all the artifacts are imported.

Adding collaborators

Assigning terms to logical data model assets

This Knowledge Accelerators feature automatically assigns Knowledge Accelerators business terms to logical data models assets that are imported into an IBM Cloud Pak for Data catalog.

Prerequisites

You need to import a logical data model into a IBM Cloud Pak for Data catalog. You can import a model by using the following steps:

Prerequisites	Steps and where to find more information
1. Install MANTA Automated Data Lineage.	Installing MANTA Automated Data Lineage
2. Enable lineage import.	Enabling lineage import
3. For users of the following IBM Industry Models, you need to prepare the models for import. IBM Banking and Financial Markets Data Warehouse 8.10.1 IBM Insurance Information Warehouse 8.10.1 IBM Unified Data Model for Healthcare 9.5.0 IBM Data Model for Energy and Utilities 3.1.0	Open the erwin Data Modeler file for the logical data model. Remove all diagrams from the model. For more information, see this support page - https://www.ibm.com/support/pages/node/7070054 Save the model as Standard XML. Compress or zip the Standard XML file. For more information, contact IBM Support.
4. Import your logical data model.	Importing metadata

To call the endpoint

To assign existing Knowledge Accelerators terms to your logical data model assets, call the Assigns terms to the asset using the specified strategy, for example\ \ industrymodels_ldm API endpoint.

1. See https://cloud.ibm.com/apidocs/watson-data-api-cpd#post-add-assignment.
2. Find the ids of the catalog, asset, and category in the IBM Knowledge Catalog user interface.

   To find the catalog ID:

   1. From the main IBM Cloud Pak for Data menu, expand Catalogs and select All catalogs.
   2. Go to the catalog that you are using.
   3. In your browser URL, you will find the catalog id between the “/catalogs/” and “?context=icp4data” strings. For example in the following URL, the id is 67ea9e1f-b2d9-423c-ab9e-c234945f9c0b: https://cpd-wkc.apps.host.company.com/data/catalogs/67ea9e1f-b2d9-423c-ab9e-c234945f9c0b/?context=icp4data

   To find the asset id:

   1. From the catalog, click the filter icon, select “Logical model” as the Asset Type and click Apply.
   2. Click the “Logical Model” listed in the results set, for example Atomic Warehouse Model.
   3. In your browser URL, you can find the asset id between the “/asset/” and “?context=icp4data” strings. For example in the following URL, the id is 7948818c-d3b5-4844-bf1b-5cc22f6fe6e1: https://cpd-wkc.apps.host.company.com/data/catalogs/67ea9e1f-b2d9-423c-ab9e-c234945f9c0b/7948818c-d3b5-4844-bf1b-5cc22f6fe6e1/?context=icp4data

   To find the category id:

   1. From the main IBM Cloud Pak for Data menu, expand Governance and select Categories.
   2. Go to the category that you are using.
   3. In your browser URL, you will find the catalog id after the “/categories/” string. For example in the following URL, the id is dc559b02-a39a-4132-8832-d42cd51af994: https://cpd-wkc.apps.host.company.com/gov/categories/dc559b02-a39a-4132-8832-d42cd51af994

3. Enter the values in the request body.
   For example:

   Value	Specification	Default value	Description	Example
   strategy	Optional	industrymodel_ldm	The term assignment strategy to apply on the asset.	industrymodel_ldm
   asset_id	Optional	The Logical Data Model in the catalog.	The id of the asset in the catalog, for which to assign Business Terms.	7948818c-d3b5-4844-bf1b-5cc22f6fe6e1
   category_ids	Optional	The Business Core Vocabulary of the installed Knowledge Accelerator.	The id of the category from which to source the Business Terms to map the asset to. This will automatically include the subcategories of the category that is supplied and by extension their terms.	dc559b02-a39a-4132-8832-d42cd51af994
   ldm_type	Optional	The type of Industry Model Logical Model stored assignments to use for doing entity and column name to term assignments.	The type of Industry Model Logical Model stored assignments to use for doing entity/column name to term assignments.	bfmdw_awm
   term_matching_method	Optional	The term matching method, artifact_id (id) is only supported.	The term matching method, artifact_id (id) is only supported.	id
   catalog_id	Required	The id of the catalog that contains the asset that you want to assign business terms to.	The id of the catalog that contains the asset that you want to assign business terms to. Provide either a Catalog Id or Project Id but not more than one.	67ea9e1f-b2d9-423c-ab9e-c234945f9c0b

4. In the response, take note of the "process_id" as you can use this to check the status of the import job in the next section, Checking the status of the term assignment process. It might be necessary or desirable to do this check, as the assignment process can take some time, depending on the number and size of the logical data model assets and glossary terms that were imported.

Checking the status of the term assignment process

To monitor the progress of the assignment of business terms to logical data model assets, call the Gets the status of assigning terms to the asset API endpoint, where {process_id} is the value from Assigning terms to logical data model assets.

See https://cloud.ibm.com/apidocs/watson-data-api-cpd#get-mappings-added

Copying into a project

See https://cloud.ibm.com/apidocs/watson-data-api-cpd#copy-ka-into-ikc