glossary import command
You can import categories, terms, information governance policies, and information governance rules from a file of previously archived assets by using the istool glossary import command. 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.
Prerequisites
You must have the Information Governance Catalog Glossary Administrator role.
IBM InfoSphere Information Governance Catalog must be installed on the same server as 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.
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 to the command name.
Command syntax
glossary import
authentication parameters
-filename pathname
[-format XML | XMI |CSV | NDM]
[-mergemethod overwrite | ignore | mergeignore | mergeoverwrite]
[-mappingfile pathname]
[-allowduplicateidentity]
[-workflow skip | individual]
[generic parameters]
Parameters
- authentication parameters
- Required. All asset interchange commands use authentication parameters to connect to a specific installation of InfoSphere Information Server.
- generic parameters
- The generic parameters are available to all asset interchange commands. Use the generic parameters to request help on command syntax, to specify silent or verbose operation, and to use a script to run commands.
- -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. This option has no affect on term history. 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 ("). Use a mapping file to change attributes of exported glossary content before you import it.
- -allowduplicateidentity | -adi
-
Applies only when assets are imported from XMI files. Allows to import term history events with the same timestamps.Note: Use this parameter with caution. Although it allows to import events with the same timestamps, it might also import duplicated events, which is considered an error.
- -workflow | -wfl
- Applies only when workflow is enabled. Specifies one of the following methods to manage assets:
- skip
- Workflow is ignored, and all assets are published to catalog after the import. This is the default option, when workflow in Information Governance Catalog New is enabled. Skipping is only possible when importing new assets to the catalog. If assets that already exist in the catalog are imported, it modifies those existing assets. In this case skipping is not possible, and a task gets created for each of those assets
- individual, ind
- Workflow process is applied for all assets that were added, deleted, or modified during the import. In the Information Governance Catalog New, a task is created for each change. In the Information Governance Catalog classic, all assets that are impacted by the import are in Glossary Development in the draft state.
Importing multiple types of assets
- 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 InfoSphere Information Governance Catalog. In versions before 11.3, these assets were created by InfoSphere Metadata Workbench. in
- Import custom attribute values from InfoSphere Information Governance Catalog. In versions before 11.3, these assets are created by InfoSphere Metadata Workbench. in
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
- 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 the Workbench Query (WBQ) 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 Microsoft Windows operating system environment
- C:\Documents and Settings\username\istool_workspace\.metadata\.log
- For UNIX or Linux® operating system environment
- user_home/username/istool_workspace/.metadata/.log
Example
glossary import -dom ABC:9443 -u xmetauser -p xmetapwd
-filename "c:\bg x imp.xml" -format XML -mergemethod overwrite