Docs
...
Getting started

Getting started with the Knowledge Accelerators

Last updated: Jul 09, 2025
How to import the Knowledge Accelerators into IBM Knowledge Catalog

Add the Knowledge Accelerators components into IBM Knowledge Catalog by using either the UI or API calls and then customize the components.

Before you begin

  1. Ensure that you have the following plan and user permissions:
    Offering plan
    The IBM Cloud Pak for Data Enterprise plan. For more information, see IBM Knowledge Catalog service plans.
    Required permissions
    • Access catalogs
    • Manage asset discovery
    • Access governance artifacts
    • Manage glossary
    • Manage governance categories
    • Manage projects

Adding the Knowledge Accelerators with the UI

You can't import Industry Alignment Vocabularies with the UI. Instead, you must use the API method. To import Business Scopes or Business Core Vocabulary and Business Performance Indicators, use the UI import method.
  1. Go to Administration > Configurations and settings and click the Add Knowledge Accelerator tile.
  2. Select an industry to add vocabularies.
  3. Select the business scope or scopes that you want to add for the industry.
    All items - import all of the specific Knowledge Accelerators vocabulary

    You can choose to import each of the specific Knowledge Accelerators vocabularies which contain the complete Business Vocabulary, and all the Business Scopes. If you 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.

    You can import the Industry Alignment Vocabularies separately by using the API.

    Selected item - import a Business Scope

    You can separately import a selection of Knowledge Accelerators Business Scopes, 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, install one or more of these separate scopes. Each business scope is imported separately.

    For a detailed list of all available items for each industry, including a definition, the identifiers, and more information, see the following links.
  4. Set merging options for the import.

    For more information, see Methods for merging imported and existing artifacts.

  5. Click Add to start the import.
    Note:
    • If you import multiple KA Business Scopes, some relationships from shared artifacts such as policies and rules to vocabulary terms might be overwritten by a subsequent business scope import.
    • If you import the Knowledge Accelerators for multiple industries, relationships from shared artifacts such as from policies and rules to vocabulary terms, may not be merged for the subsequent import - the mappings from the initially imported KA artifacts are retained. You can ignore the messages (GIM00010E or GIM00015E) in the import log relating to the policies and governance rules.

    When you see a notification message that the import is starting, you can close the window.

    You can't start multiple import jobs simultaneously.

  6. Note the process_id value in the notification as you're not notified when the import is completed.

    Use process_id to check the status of the import job. Depending on the number and size of the items that were imported, the import might take some time.

    After the import is completed, you can start adding collaborators.

Adding the Knowledge Accelerators with API

You can find descriptions of the API endpoints for the Knowledge Accelerators in the API documentation.

  1. Optional: Check which Knowledge Accelerators are already imported by calling the Get what Knowledge Accelerator items are imported into glossary API endpoint.
  2. Optional: Check which items you can import:
  3. If you're using API to add Knowledge Accelerators components, you must authenticate with Cloud Pak for Data by generating an IBM Cloud IAM token:
    1. Get your API key as described in Creating an API key in the console.
    2. Generate an IAM token by using your API key as described in Generating an IBM Cloud IAM token by using an API key.
  4. Call the Import specified Knowledge Accelerator items into the glossary API endpoint.
  5. Choose the items that you want to install.
    Note:
    • If you import multiple KA Business Scopes, some relationships from shared artifacts such as policies and rules to vocabulary terms might be overwritten by a subsequent business scope import.
    • If you import the Knowledge Accelerators for multiple industries, relationships from shared artifacts such as from policies and rules to vocabulary terms, may not be merged for the subsequent import - the mappings from the initially imported KA artifacts are retained. You can ignore the messages (GIM00010E or GIM00015E) in the import log relating to the policies and governance rules.
    All items
    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.
    Selected items - import a Business Scope
    A selection of Knowledge Accelerator Business Scopes is 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.
    For a detailed list of all available items for each industry, including a definition, the identifiers, and more information, see the following links.
  6. 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. necessary
    do_import
    • Select false to check the parameters and find out what will be imported.
    • Select true to import.
    		 false
  7. Note the process_id value in the notification as you're not notified when the import is completed.

    Use process_id to check the status of the import job. Depending on the number and size of the items that were imported, the import might take some time.

    After the import is completed, you can start adding collaborators.

Checking the import status

Check the status of the import by calling the Import of assets status API endpoint where {process_id} is the value from step 4 of adding the Knowledge Accelerators with API.

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

Finding the Knowledge Accelerators in the Resource hub

  • Log in to the Cloud Pak for Data as a Service Resource hub https://dataplatform.cloud.ibm.com/gallery.
  • Select Filter > Tags > Knowledge Accelerators.
  • Click the tile to view the details for a particular Knowledge Accelerators industry.

Adding collaborators

You need to add collaborators to the Knowledge Accelerators categories, otherwise only the person who imports the accelerator can use the artifacts. See Managing access to a category for details on how to do this.

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.  
2. Enable lineage import.  
3. For users of the following IBM Industry Models, you need to prepare the models for import.
  1. Open the erwin Data Modeler file for the logical data model.
  2. Remove all diagrams from the model. For more information, see this support page - https://www.ibm.com/support/pages/node/7070054
  3. Save the model as Standard XML.
  4. Compress or zip the Standard XML file.

For more information, contact IBM Support.

4. Import your logical data model.  
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://api.dataplatform.cloud.ibm.com/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://api.dataplatform.cloud.ibm.com/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://api.dataplatform.cloud.ibm.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

You can also add the Knowledge Accelerators artifacts as CSV files in a Cloud Pak for Data project, by using the Copy Knowledge Accelerator items into project API endpoint.

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

Tip: You can download the CSV files locally and import the content with the UI. For more information, see https://cloud.ibm.com/apidocs/knowledge-catalog#copy-ka-into-ikc .