Importing business terms for the business glossary

You can modify glossary assets outside of the catalog and import them from a file that is in CSV (comma-separated value) format. This file can be generated from another software application such as a spreadsheet program. Or, you can import a CSV file that you originally exported from IBM InfoSphere Information Governance Catalog. You can then edit the CSV export file to contain the glossary assets that you want to import.

To import business terms you must be assigned the Admin role for the Watson Knowledge Catalog app.

For a start, you can download and view a sample CSV file provided for import on the Import new terms page.

To import business glossary terms:

  1. Open Catalog > Business Glossary.
  2. Click Import or Add terms > Import.
  3. Use drag and drop to import a file or click browse to select the required files.
    If you click Cancel while file import is in progress, the import action stops and the terms that have already been imported successfully are listed for you to decide how to proceed.
  4. Check the Review import summary to see if the import was successful. You can also download the report for further analysis.

You can import existing business models as glossary assets using one of the following file formats:

  • CSV
    A Comma-Separated Values (CSV) file saves data in a table structured format. It is a text file that uses a comma to separate the information.
  • XMI
    The glossary archive file is stored in XML Metadata Interchange (XMI) format.
    To import an XMI file with glossary assets from Information Governance Catalog, refer to the glossary export command.

For more information on file formats refer to Import and export file formats.

Consider the following restrictions when importing business terms using a CSV file:

  • The content-type in the http request must be text/csv. By default, UTF-8 character encoding is used for CSV files. If the file does not use UTF-8, enter the encoding type as part of the content type specification, for example: Content-Type: text/csv;charset=windows-1252
  • Files must be comma-delimited. Other delimiters are ignored.
    • The last row of data must have an end-of-line character (carriage return). If it doesn’t, the row is dropped.
    • Two consecutive commas in a row indicate an empty column.
    • If a row ends with a comma, an extra column is created.
  • Files can’t be larger than 1 MB with some rows ending with null values and some columns containing values that are enclosed in double quotation marks.
  • The CSV file must comply with the Common Format and MIME Type for Comma-Separated Values (CSV) Files.
  • For more information on how to import business terms refer to the IBM Watson API docs (see Integrate IBM Watson APIs in your apps) and search for Business Glossary Imports in the Reference section.
  • The header row must consist of the following columns. Column names are case-sensitive:
Column Name Description
Name This column name is required. This column contains the names of the business terms.
Display Name This column name is optional. If not defined, the display value of Name is used.
Description Describes the business term to be imported.
Business Definition Provides the business definition for the business term.
Owner Contains the name or email address of the owner of the business term.
Note: The owner must have an IBM Cloud account email address.
State Identifies the status of the business term (If the state is specified as ACTIVE, the business term is shown on the Published page of the Business Glossary).
Tags Contains a comma-delimited list of tags in the term. Any tags that contain commas need to have those commas escaped by doubling the comma.

This is a code example for a CSV file:

Name,Display Name,Description,Business Definition,Owner,State,Tags
Order Reason Code,Order Reason Code,Used with distribution channel to determine internal order.,Used with distribution channel to determine internal order.,,ACTIVE,SupplyChain
Term 1,Term Number One,The first term to import.,imported term,,DRAFT,tag1
Term 2,Term Number Two,The second term to import.,imported term,Fred User<Fred.User@mycompany.com>,DRAFT,"tag1,tag2"

Next steps

Learn more