glossary import command

Use the istool command glossary import to import categories, terms, information governance policies, and information governance rules from a file of previously archived assets. You can also use this command to import a glossary model (*.ndm) file from IBM® InfoSphere® Data Architect.

Purpose

Use this command to import assets from files that are in an XML, XMI, CSV, or NDM format. You can also use this command when you want to schedule an import.

For a complete list of what you can export to a file that is in an XML, XMI, or CSV format, see Import and export file formats.

Requirements

You must have the Information Governance Catalog Glossary Administrator role.

Information Governance Catalog must be installed on the same IBM WebSphere® Application Server.

The version of istool command framework must be the same version as InfoSphere Information Governance Catalog.

Run the command from the client tier, or from the engine tier if InfoSphere Information Governance Catalog was installed there.

Command syntax

The preferred way to run this command is in the istool command-line window. If you run this command in your operating system command-line window or in scripts, you must add istool before the command name.

istool>  glossary import 
authentication parameters
-filename pathname
[-format XML | XMI |CSV | NDM]
[-mergemethod  overwrite  | ignore | mergeignore | mergeoverwrite]
[-mappingfile pathname]
[generic parameters]

Parameters

These parameters are specific to the glossary import command for istool. For authentication parameters and generic parameters, see Common commands and parameters.

-filename | -f pathname

Specifies the file to import glossary assets from. If pathname contains space characters, you must enclose the pathname in double quotation marks (").

-format | -fm XML | XMI | CSV | NDM

Specifies the format of the import file. By default the format is XML.

Files that are in an XML or XMI format must contain glossary content that adheres to the format required by IBM InfoSphere Information Governance Catalog. For more information about format, download the sample files that are available in the InfoSphere Information Governance Catalog Import and Export wizards.

Files that are imported with the NDM option must be glossary model files (*.ndm) that were created with, or imported into, InfoSphere Data Architect. The glossaries and words in the glossary model file are converted into categories and terms according to the mapping that is described in the topic Generating glossary content from InfoSphere Data Architect glossary models.

-mergemethod | -mrg overwrite | ignore | mergeignore | mergeoverwrite

Only applies when assets are imported from XML or XMI files. Specifies one of the following merge methods:

overwrite: Specify this option to overwrite assets that exist in the target repository with imported assets.
ignore: This is the default option. Assets that exist in the target repository are not overwritten.
mergeignore: Specify this option to merge the asset and ignore imported attributes that cannot be merged.
mergeoverwrite: Specify this option to merge the asset and overwrite existing attributes that cannot be merged.

-mappingfile | -map pathname

Applies only when assets are imported from XMI files. Specifies a mapping file to use to modify the imported assets. If the pathname contains space characters, you must enclose the pathname in double quotation marks ("). A mapping file enables you to change attributes of exported glossary content before you import it.

Importing multiple types of assets

Archive files can contain assets from multiple exports of multiple tools. For best performance, when you import from an archive file, or when you migrate assets of varying types in multiple archive files, run separate commands to import the following types of assets in the following order:

Import users and groups with the -sec option.
Import common metadata with the -cm option. Use the -lm option for logical models.
Import InfoSphere DataStage® and QualityStage® projects with the -ds option.
Import reports with the -rep and -replace options.
Import IBM InfoSphere Information Analyzer projects with the -ia option.
Import IBM InfoSphere FastTrack assets with the -fasttrack option.
Import InfoSphere Information Governance Catalog extended data source assets with the appropriate -type option. In versions before 11.3, these assets are created by IBM InfoSphere Metadata Workbench.
Import InfoSphere Information Governance Catalog extension mappings in extension mapping documents with the -overwrite option. In versions before 11.3, these assets are created by InfoSphere Metadata Workbench.
Import InfoSphere Information Governance Catalog glossary assets with the appropriate -mergemethod option. In versions before 11.3, these assets are created by InfoSphere Business Glossary.
Import custom attributes for extended data sources and extension mappings:
- Import custom attributes from Administration > Catalog Management > Custom Attributes in InfoSphere Information Governance Catalog. In versions before 11.3, these assets were created by InfoSphere Metadata Workbench.
- Import custom attribute values from Catalog > Information Assets > Manage > Import Custom Attribute Values in InfoSphere Information Governance Catalog. In versions before 11.3, these assets are created by InfoSphere Metadata Workbench.

Note: When you import reports from an archive, you must use the -replace option. If you do not want to use the -replace option for other types of assets in the archive, you must use a separate command to import the reports. If you import glossary assets without the -mergemethod option and import their related reports with the -replace option, some of the reports might not be accurate for assets that were not overwritten in the target environment. Check the reports and run them again in the new environment if necessary.

If a user or user group that is assigned as a steward exists in the target repository, the steward relationship is established. Otherwise, the relationship between an asset and the steward is not established. Therefore, before you import a file that contains links to stewards, make sure that you import the users and groups who are the stewards.

Assets and reports that are not imported by using istool

The istool command glossary import does not import these assets and reports into the metadata repository:

Lineage reports and configuration: Workaround: Run lineage after import to establish lineage relationships between assets.
Queries: Workaround: In the Queries tab, export published queries to a file in XMI format and then reimport them.

Output

A return value of 0 indicates successful completion; any other value indicates failure. The reason for the failure is displayed in a screen message.

For further details, see the system log file in either of the following directories:

For Microsoft Windows operating system environment: C:\Documents and Settings\username\istool_workspace\.metadata\.log; where username is the name of the operating system account of the user who runs this command.
For UNIX or Linux operating system environment: user_home/username/istool_workspace/.metadata/.log; where user_home is the root directory of all user accounts, and username is the name of the operating system account of the user who runs this command.

Example

The following command imports all the glossary assets contained in the XML format file named bg x imp.xml. If assets with the same name are encountered in the target repository, they are overwritten with the imported assets:

istool> glossary import -dom ABC:9443 -u xmetauser -p xmetapwd 
-filename "c:\bg x imp.xml"  -format XML -mergemethod overwrite