Knowledge base import overview


Knowledge base import is a complex process that imports articles and their attributes from a BMC application that you use to create and maintain knowledge content to

WarningSome content is unavailable due to permissions.

. This process accommodates knowledge model differences between the systems to seamlessly import articles, their attributes, states and localizations without data loss.    

If you want to create knowledge articles directly in BMC Helix Knowledge Management by ComAround, you can import knowledge articles from your BMC application to BMC Helix Knowledge Management by ComAround as a one-time activity.

 

How knowledge base import works

An import job creates a list of articles to be imported. The following article types are added to the list:

  • New articles
  • Updated articles
  • Articles that failed to be imported previously

The job runs in this order:

import_flow_25.2.png

 

How knowledge articles are imported to

WarningSome content is unavailable due to permissions.

folders

The import tool imports knowledge articles from your BMC application to folders and subfolders in

WarningSome content is unavailable due to permissions.

. You create folders in

WarningSome content is unavailable due to permissions.

when you import knowledge articles for the first time. 

The following table explains how the folder structure is created in

WarningSome content is unavailable due to permissions.

Product

Folder structure in

WarningSome content is unavailable due to permissions.

WarningSome content is unavailable due to permissions.

Folder structure in

WarningSome content is unavailable due to permissions.

is based on the companies, assignment groups, and visibility groups in

WarningSome content is unavailable due to permissions.

.

WarningSome content is unavailable due to permissions.

Folder structure in

WarningSome content is unavailable due to permissions.

is based on knowledge sets and associated lines of business in

WarningSome content is unavailable due to permissions.

.

When you import all articles as part of the initial knowledge base import, the import tool automatically generates subfolders for each folder created in

WarningSome content is unavailable due to permissions.

and imports knowledge articles directly into them. The number of articles that can be imported into one subfolder is limited to 100 articles per folder by default. However, you can change this default setting.

When you  run subsequent imports to import any newly created or edited articles from your BMC application, the import tool handles the folder structure in the following way: 

  • If some folders do not exist in

    WarningSome content is unavailable due to permissions.

    , the Sync changes only option creates them too.
  • If some subfolders haven't reached their full capacity during the initial import, new articles are copied to these subfolders. Otherwise, new subfolders will be created in

    WarningSome content is unavailable due to permissions.

    . For information about the number of articles that are by default imported into one subfolder and how to change this setting, see To modify the number of articles to be imported into subfolders.
  • If article groups have been changed in

    WarningSome content is unavailable due to permissions.

    or

    WarningSome content is unavailable due to permissions.

    after the initial import, new folders are created in

    WarningSome content is unavailable due to permissions.

    . The articles are then copied to subfolders under these folders. 
Success

Best practice
We recommend that you avoid changing the names of the folders until you have confirmed that the import process is complete and that you do not intend to re-run the import utility. If you change the folder names after the initial knowledge base import and then re-run the import utility to import any newly created or edited articles, the articles that were previously imported into BMC Helix Knowledge Management by ComAround are not updated in the renamed folder. Instead, a new folder is created with the default name, and the articles are imported to that folder.

 

Knowledge articles that are imported

During the knowledge base import, the following knowledge article templates, states and attributes are imported from your BMC application to

WarningSome content is unavailable due to permissions.

:

imported_articles_25.2.png

 

How article states are mapped

The following image shows the state of knowledge articles after the import from your BMC application to

WarningSome content is unavailable due to permissions.

:

22.1.01_State-status mapping.png

Warning

Important

By default, cancelled and retired knowledge articles from your BMC application are not imported to

WarningSome content is unavailable due to permissions.

. To modify the default query, see To modify the query to import knowledge articles. For more information about creating new state mappings or modifying the default mappings, see To map an article status from your BMC application with an article state in BMC Helix Knowledge Management by ComAround.

 

How localizations are imported

The import tool supports multilanguage import for the locales that exist in both

WarningSome content is unavailable due to permissions.

and your BMC application. The tool checks the article locale set in your BMC application and automatically imports localized articles to the corresponding translation language in

WarningSome content is unavailable due to permissions.

.

Warning

Important

The import tool does not translate localized articles while importing them from BMC applications to

WarningSome content is unavailable due to permissions.

. It copies article content as is to the corresponding translation in

WarningSome content is unavailable due to permissions.

However, the import tool can't import localized articles from BMC applications to

WarningSome content is unavailable due to permissions.

in the following cases:

  • If

    WarningSome content is unavailable due to permissions.

    doesn't support a translation language for the article locale set in your BMC application.
  • If

    WarningSome content is unavailable due to permissions.

    supports a translation language for the article locale set in your BMC application, but this language isn't configured for a

    WarningSome content is unavailable due to permissions.

    portal.
Information
Example

If a portal in

WarningSome content is unavailable due to permissions.

is configured to support only English and German translations, localized articles in Polish in

WarningSome content is unavailable due to permissions.

won't be imported to

WarningSome content is unavailable due to permissions.

. To enable import of these articles to Polish, the portal in

WarningSome content is unavailable due to permissions.

must be configured to support the Polish translation as well. 

In these cases, the import tool returns the Invalid portal culture exception, skips the localized articles in that language, and moves to other articles.

However, you can define a custom mapping for the locales that either don't exist in

WarningSome content is unavailable due to permissions.

or aren't supported by a

WarningSome content is unavailable due to permissions.

portal. This mapping will enable the import tool to import localized articles into the translation language of your choice. For more information about defining a custom locale mapping, see To create a custom locale mapping.

 

How localized metadata fields are imported

If the article locale is set to a different language than English in your BMC application, metadata fields are copied as article tags to the respective translation in

WarningSome content is unavailable due to permissions.

, in the following format:

  • Field value is copied as is. If it is localized in your BMC application, it remains localized in

    WarningSome content is unavailable due to permissions.

    .
  • Field name is always presented in the English language in

    WarningSome content is unavailable due to permissions.

    , regardless of:
    • its localization in your BMC application
    • the translation language to which an article is imported in

      WarningSome content is unavailable due to permissions.

Information
Examples

Field value import

The Department metadata field is set to Customer Service for a localized article in the Polish language in

WarningSome content is unavailable due to permissions.

. After this article is copied to the Polish translation in

WarningSome content is unavailable due to permissions.

, the corresponding tag will be Department=Customer Service. However, if the value of the Department metadata field is set to Obsługa klienta in

WarningSome content is unavailable due to permissions.

, the tag will be Department=Obsługa klienta in

WarningSome content is unavailable due to permissions.

.

Field name import

If the system locale is set to the Polish language in

WarningSome content is unavailable due to permissions.

, the name of the Department field may be displayed in Polish, which will be Dział in this case. However, it will be copied in the English language to

WarningSome content is unavailable due to permissions.

, regardless of the

WarningSome content is unavailable due to permissions.

locale. For example, the metadata field Dział that is set to the value Obsługa klienta will be imported from

WarningSome content is unavailable due to permissions.

to

WarningSome content is unavailable due to permissions.

as Department=Obsługa klienta.

 

How links are imported

If knowledge articles in your BMC application contain links to other articles in the same application, the import tool imports these links to

WarningSome content is unavailable due to permissions.

. When end users click these links in

WarningSome content is unavailable due to permissions.

, they are redirected to the corresponding knowledge articles in

WarningSome content is unavailable due to permissions.

Information
Example

In

WarningSome content is unavailable due to permissions.

, the article How to create a work order contains a link to the article How to update a work order. When Jordon, the administrator, runs the import tool, both articles are imported from

WarningSome content is unavailable due to permissions.

to

WarningSome content is unavailable due to permissions.

. When Britney, an end user, opens the article How to create a work order in

WarningSome content is unavailable due to permissions.

and clicks the link to the article How to update a work order, the article How to update a work order opens in

WarningSome content is unavailable due to permissions.

Import of links ensures information integrity and a seamless user experience after the knowledge base import. End users can effortlessly navigate and explore the content in

WarningSome content is unavailable due to permissions.

and are not redirected to the BMC application, from where the knowledge articles were imported. For the import of links to work properly, make sure that BMC Helix, Inc. has specified Helix Knowledge Management main URL. For more information, see Configuring-BMC-Helix-Knowledge-Management-by-ComAround-as-a-knowledge-provider.

Warning

Important

When a knowledge article that contains a link is imported, but the referenced article has not been imported for some reason, the link is present in

WarningSome content is unavailable due to permissions.

. However, when end users click this link, they are redirected to the original knowledge article outside

WarningSome content is unavailable due to permissions.

. For imported links to work, both articles must be successfully imported to

WarningSome content is unavailable due to permissions.

.

 

How article votes are imported

When the import tool imports article votes to

WarningSome content is unavailable due to permissions.

, it considers the Third-party mail service setting, which is configured in your

WarningSome content is unavailable due to permissions.

portal. This setting determines whether to send email notifications for user actions. For more information about the Third-party mail service setting, see the Configuring portal settings - Settings (ComAround) help article. To learn how to access help articles for

WarningSome content is unavailable due to permissions.

, see Accessing product documentation provided by help articles in the

WarningSome content is unavailable due to permissions.

documentation.  

ComAround_portal_settings.png

If the Third-party mail service setting is enabled during the knowledge base import, article authors receive email notifications for each article vote imported to 

WarningSome content is unavailable due to permissions.

To prevent email notifications when article votes are imported,

WarningSome content is unavailable due to permissions.

automatically adjusts the Third-party mail service setting by using the following two rules. These rules are added in BMC Helix Innovation Studio > Workspace > Knowledge Sync > Rules tab. 

  • Disable HKM Email Notifications on Migration Job Start—When the import process begins, this rule verifies whether the Third-party mail service setting is turned on or off. If the setting is enabled, the rule turns it off. If the setting is disabled, it remains turned off. 

    Warning

    Important

    During the knowledge base import, article authors won't receive email notifications for any votes, not only the imported ones. For example, if an article is voted on while the import tool is running, no email notifications will be sent. 

     

  • Restore HKM Email Notifications on Migration Job End—After the import process is complete or fails, this rule restores the original state of the Third-party mail service setting. For example, if the Third-party mail service setting was enabled before the import, this rule turns it on after the import is complete. 

rules_disable_emails.png

Success

Best practice
These rules automatically handle the Third-party mail service setting to increase the import tool's performance and ensure that article authors receive only relevant and valuable email notifications. We strongly recommend not disabling or modifying these rules because such changes will cause the import tool to send email notifications while importing votes.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Helix Innovation Suite 25.2