glossary bi2bg command

Use the istool command glossary bi2bg to generate categories and terms from business intelligence (BI) models that are in the metadata repository.

Purpose

Use this command to convert BI model elements in the metadata repository to terms and categories. You can also use this command when you want to schedule a category and term generation.

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 bi2bg 
authentication parameters
-config-file pathname
[-log pathname]
[generic parameters]

Parameters

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

-config-file | -cfg pathname: Specifies the directory path to the configuration file that defines how business glossary content is generated from a BI model. If the pathname contains space characters, enclose the pathname in double quotation marks (").; For details about the parameters in the configuration file, see Configuration file.
-log pathname: Specifies the directory path where you want the log file to be placed. If the pathname contains space characters, enclose the pathname 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 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.

Configuration file

A configuration file defines additional command parameters. The file is a text file with the extension .ini that you create. It can contain the parameters that are 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
ModelsToProcess	Specifies the names of the models to be processed. To process all models, set parameter value to an asterisk (*).	Comma-separated names of models.	*
MemberTypeRegular	When a term is created from BI collection members, a string that indicates the member type is listed in the Example attribute of the term. For BI collection members whose type is "Regular," specifies the string to be displayed.	User-specified string.	Regular
MemberTypeMeasure	For BI collection members whose type is "Measure," specifies the string to be displayed in the Example attribute of the corresponding term.	User-specified string.	Measure
ClassifyMemberTargetSource	If TRUE, BI collection members are assigned to the terms that are created from them.	TRUE/FALSE	TRUE
CategoriesToExclude	Specifies the categories to be excluded. You can choose not to create some of the parent categories that are generated from the namespace. If a category is excluded, its subcategories and terms are also excluded. The configuration file must include this parameter even if you do not specify a value for it.	Comma-separated names of categories. Use the full path of the category, starting from the top-level category. You can obtain the full path of the categories from the preview file.
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
IsModifier	If TRUE, sets the value of the IsModifier attribute of all imported terms to "Yes".	TRUE/FALSE	FALSE
Status	Specifies the status attribute of all imported terms.	CANDIDATE/ACCEPTED/ DEPRECATED/STANDARD	CANDIDATE
Type	Specifies the type attribute of all imported terms.	PRIMARY/SECONDARY/ NONE	NONE
CreateBusinessGlossaryPreview	If TRUE, creates a preview of the business glossary content in a CSV file or in the log file instead of importing the categories and terms.	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 full path to the preview CSV file to be created. 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	If TRUE, the first field on the preview file contains the column names.	TRUE/FALSE	TRUE
ImportToTopCategory	If TRUE, imports the business glossary content under a top category that is specified by the TopCategoryName parameter. Use this setting if you want to use an existing top category to contain the imported content, or to avoid merge issues by creating a new top category.	TRUE/FALSE	FALSE
TopCategoryName	If you set ImportToTopCategory to TRUE specifies the name of a top-level category to contain the generated business glossary content. You can use an existing category name or specify a new category to be created.	TRUE/FALSE	FALSE
CheckForDuplicateTerms	If TRUE, then when terms with duplicate names are created, output the list of duplicates to a text file.	TRUE/FALSE	TRUE
DuplicateTermsFileName	Specifies the path of the output file for a list of duplicate terms if CheckForDuplicateTerms is TRUE. Important: If you include a backslash (\) in the path of the output file, the glossary bi2bg command will fail. To prevent this failure, escape the backslash characters. For example, change C:\tmp\dup.txt to C:\\tmp\\dup.txt.		c:\\Duplicates.txt

Example

The following command creates categories and terms from a BI model that was imported into the metadata repository on localhost. The command uses the configuration file BIGlossaryBuilder.ini. No preview file is created. The categories and terms are contained by the parent category BI.

istool> glossary bi2bg –domain localhost:9443 –u isadmin –p isadminpwd
-cfg c:\temp\BIGlossaryBuilder.ini -log c:\temp\bi.log

The configuration file BGLossaryBuilder.ini contains the following text:

ModelsToProcess = *
MemberTypeRegular = Dimension
MemberTypeMeasure = Measure
CategoriesToExclude = test

ClassifyMemberTargetSource = FALSE

MergeOption = MERGE_SOURCE_BIAS
IsModifier = FALSE
Status = CANDIDATE
Type = NONE

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

TopCategoryName = BI
ImportToTopCategory = TRUE 
DuplicateTermsFileName= c:\\tmp\\dup.txt
CheckForDuplicateTerms=TRUE

The log file shows the status messages. On success:

bi2bg completed successfully!
n categories created
n terms created
n categories updated
n terms updated
n categories deleted
n terms delete
Glossary preview file is generated!

On failure:

Building glossary from BI failed, Error Occurred: error_message

where error_message is a more specific message.