glossary ldm2bg command

You can create categories and terms from logical data models that are in the metadata repository by using the istool glossary ldm2bg command.

Purpose

Use this command to convert logical data model elements to terms and categories. You can also use this command when you want to schedule a conversion.

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

Optional parameters and optional values in the syntax are enclosed in brackets [ ].

glossary ldm2bg 
authentication parameters
[generic parameters]
-config-file-sample   | -config-file pathname
[-log-file pathname]

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.

-config-file-sample | -cfg-sample pathname or -config-file | -cfg pathname

The parameter config-file-sample specifies the path in which to place a generated sample configuration file. This command generates a sample configuration file but does not generate any terms or categories that correspond to the logical data model. You can edit the sample configuration file to specify the options that you want to use, and then run the command with the -config-file option to create categories and terms. If the path contains space characters, enclose the path in double quotation marks (").

The parameter -config-file specifies the path to the configuration file that defines how business glossary content is generated from a logical data model. If the path contains space characters, enclose the path in double quotation marks ("). For details about the parameters in the configuration file, see Configuration file.

Note:

The config-file-sample and -config-file parameters are mutually exclusive. You must use either parameter.
Either config-file-sample or -config-file must be the first parameter in the command.

-log-file pathname

Specifies the path where you want the log file to be placed. If the path contains space characters, enclose the path in double quotation marks (").

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 more information, see the system log file:

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.

Configuration file

A configuration file defines more command parameters. The file is a text file with the extension .ini that you create. The configuration file can contain the parameters shown in the following table. Each parameter name is a single string with no spaces.

Table 1. Configuration file command parameters
Parameter name	Description	Valid values	Default value
ModelsToProcess	Specifies the names of the models to be processed. To process all models, specify an asterisk (*).	Comma-separated names of models.	*
ClassifyMemberTargetSource	Specifies whether logical data model assets are assigned to the terms that are created from them.	TRUE, FALSE	FALSE
TopCategoryName	Specifies the name of a top-level category that you want to contain the generated business glossary content. You can use an existing category name or specify a new category, which is created. If multiple models are specified, multiple top-level categories are created that each correspond to a model.	Any string	Name of parent logical data model or models.
MergeOption	Specifies the merge option to use when the categories and terms are imported. MERGE_TARGET_BIAS Merge the asset and ignore imported attributes that cannot be merged. MERGE_SOURCE_BIAS Merge the asset and overwrite existing attributes that cannot be merged.	MERGE_SOURCE_BIAS, MERGE_TARGET_BIAS	MERGE_TARGET_BIAS
CreateBusinessGlossaryPreview	Specifies whether a preview of the business glossary content is created instead of importing the categories and terms. Use the BusinessGlossaryPreviewFormat parameter andoptionally, the BusinessGlossaryPreview parameter with this option to specify the location and format of the preview file.	TRUE, FALSE	FALSE
BusinessGlossaryPreviewFormat	Specifies whether to write the preview to a CSV file or to the log file (SYSTEMOUT).	CSV, SYSTEMOUT	SYSTEMOUT
BusinessGlossaryPreviewCSVFilePath	Specifies the full path for the preview CSV file. The CSV file cannot be imported. To import the content, run the command again with CreateBusinessGlossaryPreview set to FALSE in the configuration file.		c:\\Default.csv
FirstRowColumnNames	Specifies whether the preview file contains column headings corresponding to IBM InfoSphere Information Governance Catalog properties.	TRUE, FALSE	FALSE
Status	Sets the value as the default status for all the terms created.	CANDIDATE, ACCEPTED, STANDARD, DEPRECATED	CANDIDATE

Example

The following command creates categories and terms from a logical data model that was imported into the metadata repository on localhost. The command uses configuration file LDMGlossaryBuilder.ini. The categories and terms are contained by the parent category LDMTestTopCat. The terms and categories have candidate status. No preview file is created. If the CreateBusinessGlossaryPreview option is later set to true, a CSV preview file is created in the file preview.csv.

On Windows operating systems, issue this command:

glossary ldm2bg -cfg c:\temp\LDMlossaryBuilder.ini –domain localhost:9443 
–username isadmin –password isadminpwd -log c:\temp\bi.log

On UNIX operating systems, issue this command:

glossary ldm2bg -cfg /temp/LDMGlossaryBuilder.ini  -domain localhost:9443 
-username isadmin –password isadminpwd -log /temp/ldm.log

The configuration file LDMGlossaryBuilder.ini contains the following text:

ModelsToProcess = *

ClassifyMemberTargetSource = TRUE

MergeOption = MERGE_SOURCE_BIAS
Status = CANDIDATE

CreateBusinessGlossaryPreview= FALSE
BusinessGlossaryPreviewCSVFilePath = c:\\tmp\\preview.csv
FirstRowColumnNames = TRUE
TopCategoryName = LDMTestTopCat

When the istool glossary ldm2bg command completes successfully, the following status messages are included in the log file:

ldm2bg completed successfully!
n categories created
n terms created
n categories updated
n terms updated
n categories deleted
n terms deleted

When the istool glossary ldm2bg command with the CreateBusinessGlossaryPreview option completes successfully, the following status messages are included:

Glossary preview file is generated!

If the istool command completes with errors, the following status messages are included:

Building glossary from LDM failed, Error Occurred: error_message

where error_message is a more specific message.