Getting started with the Knowledge Accelerators

Quick start

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

v1/knowledge_accelerators/api/explorer/

/icp4d-api/v1/authorize

/v1/knowledge_accelerators/{ka_id}
/import_items

/v3/governance_artifact_types/
import/status/{process_id}

Watch this video describing how to import the Knowledge Accelerators.

This video provides a visual method as an alternative to following the written steps in this documentation.

Video disclaimer: Some minor steps and graphical elements in this video may differ from your Cloud Pak for Data deployment.

Detailed import instructions and other useful API endpoints

Requirements and permissions

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

Required permissions

You must have this user permission to import the Knowledge Accelerators:

• Manage governance categories

Accessing the Knowledge Accelerators OpenAPI endpoints

Choosing which Knowledge Accelerator items to import

There are two main options to consider when you are planning to import Knowledge Accelerators content.

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.

Authenticating and Authorizing

To authenticate with Cloud Pak for Data, you need to generate a bearer token. For more details, see Authentication.

1. Generate your bearer token using the POST/icp4d-api/v1/authorize.
   1. Select POST/icp4d-api/v1/authorize call and click Try it out.
   2. Replace "string" with your username and api_key for example:

      {
        "username": "admin",
        "api_key": "your_api_key"
      }

      To get your API key, see Generating API keys for authentication.
      Tip: Alternatively, you can use your password as a way generate your bearer token. For example:

      {
        "username": "admin",
        "password": "your_password"
      }

   3. Click Execute. If successful, you get a response containing the token.
      Sample response:

      { 
      "_messageCode_": "200",
       "message": "Success",
       "token": "eyJhbGciOiJSUzI1.…..DOCtm5Mbzyg" 
      }

   4. Copy the token value which is between the quotes, for example:

      eyJhbGciOiJSUzI1.…..DOCtm5Mbzyg

2. Click Authorize and in the Value: box, paste the bearer token value.
3. Once authorized, click Close. The Authorize button shows a lock symbol.

Checking which items are available for import

1. Select GET /v1/knowledge_accelerators and click Try it out.
2. Click Execute.

{
  "count": 6,
  "knowledge_accelerators": [
    {
      "id": "kahc20",
      "name": "Knowledge Accelerator for Healthcare",
      "definition": "IBM Knowledge Accelerator for Healthcare
      Licensed Materials − Property of IBM 
      © Copyright IBM Corp. 2020, 2023. All Rights Reserved 
      Documentation for this offering https://www.ibm.com/docs/SSQNUZ_4.7.x/ka/ka-cpd.HTML 
      Notices for this offering https://www.ibm.com/docs/SSQNUZ_4.7.x/ka/notices.html ",
      "type": "knowledge_accelerator",
      "format": "wkc_glossary",
      "version": "…..
      …....

Checking which items are available for import per industry

1. Select GET /v1/knowledge_accelerators/{id} and click Try it out.
2. Enter the id value for the Knowledge Accelerator industry. See the following table for valid values.

   Cross Industry	Energy and Utilities	Financial Services	Healthcare	Insurance
   kaci20	kaeu20	kafs20	kahc20	kain20

3. Click Execute.

{
  "id": "kafs20",
  "name": "Knowledge Accelerators",
  "definition": "A category that groups governance artifacts that are used across the 
Knowledge Accelerators.
Licensed Materials − Property of IBM 
© Copyright IBM Corp. 2020, 2023. All Rights Reserved
Documentation for this offering https://www.ibm.com/docs/SSQNUZ_4.7.x/ka/ka-cpd.html
Notices for this offering https://www.ibm.com/docs/SSQNUZ_4.7.x/ka/notices.html",
  "type": "knowledge_accelerator",…..
      …....

Checking which Knowledge Accelerators are already imported

1. Select GET /v1/knowledge_accelerators/import_items and click Try it out.
2. Click Execute.

{
  "message": "KA008I: The following knowledge accelerator items are imported",
  "import_evaluation": [
    {
      "knowledge_accelerator": "CPD_URL/v1/knowledge_accelerators/kaci20",
      "items": [
        {
          "id": "personal-data",
          "evaluation": "imported_at_undeterminable_version",
          "latest_version": "2.0.2023XX"

Importing the Knowledge Accelerators

To import Knowledge Accelerators items into an instance of Watson Knowledge Catalog, call the POST /v1/knowledge_accelerators/{ka_id}/import_items Import specified Knowledge Accelerator items into the glossary API endpoint.

1. Choose the items 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 links below.

   • 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. Select POST /v1/knowledge_accelerators/{ka_id}/import_items and click Try it out.
3. 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 Watson 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

4. Click Execute.
5. 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

The import status will remain "IN_PROGRESS" until all the artifacts have been imported.

Adding collaborators

Copying into a project

1. Select POST /v1/knowledge_accelerators/{ka_id}/copy_items and click Try it out.
2. Enter the Knowledge Accelerator industry id, the id's for the items you wish to import and the project id and click Execute.

Summary of import steps and API endpoints

/icp4d-api/v1/authorize

 /v1/knowledge_accelerators

 /v1/knowledge_accelerators/
{id}

/v1/knowledge_accelerators/
import_items

/v1/knowledge_accelerators/
import_items

/v3/governance_artifact_types/
import/status/{process_id}