Getting started with the Knowledge Accelerators

Add the Knowledge Accelerators vocabularies into IBM watsonx.data intelligence by using either the UI or API calls and then customize the components.

Before you begin

  1. Ensure that you have the necessary plan and user permissions:
    Service plan

    With the Essentials plan, you can import Knowledge Accelerator for Cross Industry only.

    For more information about plans, see
    Required permissions
    • Access catalogs
    • Access governance artifacts
    • Manage glossary
    • Manage governance categories
Note:

If you want to add sample predefined business terms, see Installing sample predefined business terms.

Adding the Knowledge Accelerators with the UI

To import Business Scopes, Business Core Vocabulary, and optional Industry Alignment Vocabularies, follow the UI steps.

  1. Go to Administration > Configurations and settings and click Add industry vocabularies.
  2. Select the industry for which you want to add vocabularies.

    If you want to add sample predefined business terms, see Installing sample predefined business terms.

  3. Select to add one of the following:
    • A business core vocabulary including all business scopes and the optional Industry alignment category.
    • A business scope for the industry.
    Business core vocabulary
    Import each of the specific Knowledge Accelerators vocabularies that 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, select this option.

    Optionally, you can also import an Industry Alignment vocabulary.

    Business scope
    You can separately import a Knowledge Accelerators Business Scope, for example Data Privacy or other industry specific scope. 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 these separate scopes. Each business scope is imported separately.
    For a detailed list of all available artifacts for each industry, including a definition, the identifiers, and more information, see the following links.
  4. Optional: If you selected the business core vocabulary, you can select an industry alignment vocabulary to import.
  5. Set merging options for the import.

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

    By default, the following items are imported:
    • Specified artifacts that you selected: the business core vocabulary, industry alignment vocabulary or a business scope.
    • Artifacts that are considered mandatory for the specified vocabulary or business scope.
  6. Click Add to start the import.

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

    You can't start multiple import jobs simultaneously.

    Note:
    • If you import multiple 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 Knowledge Accelerators for multiple industries, relationships from shared artifacts such as from policies and rules to vocabulary terms, might 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.

    Depending on the number and size of the artifacts that were imported, the import might take some time.

  7. Optional: Click the View details button to see the import progress or click the View log button to see details of the import.

Next steps

After the import is completed, 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..

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. Authenticate with Cloud Pak for Data.
  4. Call the Import specified Knowledge Accelerator items into the glossary API endpoint.
  5. Choose the artifacts 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 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.
    Sample
    The IBM Knowledge Accelerators Sample Personal Data includes 1 category with 100 predefined business terms.
    Business core vocabulary
    Import each of the specific Knowledge Accelerators vocabularies that 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, select this option.

    Optionally, you can also import an Industry Alignment vocabulary.

    Business scope
    You can separately import a Knowledge Accelerators Business Scope, for example Data Privacy or other industry specific scope. 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 these separate scopes. Each business scope is imported separately.
    For a detailed list of all available artifacts 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 watsonx.data intelligence. 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. Optional: Depending on the number and size of the items that were imported, the import might take some time. Check the status manually as you're not notified when the import is completed:
    1. Note the process_id value in the notification

    2. 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.

Next steps

After the import is completed, 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..

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.