workbench extension mapping import command

You can import extension mappings from a file that is in a comma-separated value (CSV) format into the metadata repository. Use the istool workbench extension mapping import command.

Purpose

Use this command to import the extension mappings from extension mapping documents or to schedule an import.

Requirements

You must have the Information Governance Catalog Information Asset 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

Optional parameters and optional values in the syntax are enclosed in brackets [ ]. 
workbench extension mapping import
authentication parameters
[generic parameters]
-filename import_file
-output log_file_name
[-overwrite] 
[-description description_of_mapping_doc]
[-type]
[-config configuration_file]
[-folder folder_structure]
[-srcprefix prefix_sources]
[-trgprefix prefix_targets]

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 import_file
Specifies the name of the file with the extension mappings to be imported to the metadata repository.
If the name of the file has an embedded space, enclose the name in double quotation marks (").
The file must be in a CSV format and use valid syntax. If the syntax is not correct, the import fails.
If a source or a target asset used in a mapping row is not valid, the extension mapping is imported, but a message is displayed about the asset.
-output | -o log_file_name
Specifies the name of the log file that contains the output, including errors, of the command that was run. Include the directory path in log_file_name.
If the directory does not exist, the command fails.
The log file is created if it does not exist. If the log file does exists, the output is appended to the file. If the command is automated to run at different times, the log file displays the ongoing output of each command that was run.
-overwrite | -ov
If you specify this parameter, the import overwrites an existing extension mapping document file with the same name in the same folder.
-description description_of_mapping_doc
Describes the function or purpose of the imported extended mappings. Enclose the description in double quotation marks.
-type | -t type_of_mapping_doc
Describes the type of extended mapping document. Enclose the text in double quotation marks ("). For example, the type might be "Relational" or "Custom defined".
-config | -c configuration_file
Uses the configuration file that describes the column header information of the extended mapping document.
-folder | -fldr folder_structure
Describes the complete folder structure that contains the extension mapping document to be imported. If the folder structure contains a space, enclose the text in double quotation marks (").
The folder is created if it does not exist.
-srcprefix prefix_sources, -trgprefix prefix_targets
If the context for source assets or target assets is not specified in the extension mappings, specify a single context for all source assets or all target assets that you are importing.
Type a context in the prefix_targets or the prefix_sources only if you meet both conditions:
  • All target or all source assets in all extension mappings that you are importing have the same context
  • The context is not specified for any of the target or source assets

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:
  1. Import users and groups with the -sec option.
  2. Import common metadata with the -cm option. Use the -lm option for logical models.
  3. Import InfoSphere DataStage® and QualityStage® projects with the -ds option.
  4. Import reports with the -rep and -replace options.
  5. Import IBM InfoSphere Information Analyzer projects with the -ia option.
  6. Import IBM InfoSphere FastTrack assets with the -fasttrack option.
  7. 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.
  8. 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.
  9. 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.
  10. 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.

Both extension mapping documents and the extension mappings within the documents can have custom attributes with custom attribute values.

For extension mappings, the workbench extension mapping import command imports custom attribute values, but not custom attributes, into the metadata repository. You must import the custom attributes on the Administration tab of InfoSphere Information Governance Catalog before you run the workbench extension mapping import command.

For extension mapping documents, the custom attributes and the custom attribute values are not imported by the workbench extension mapping import command. You must import both custom attributes and custom attribute values on the Administration tab of InfoSphere Information Governance Catalog.

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 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

You can import all extension mapping documents in E:\CLI\import\a into the metadata repository and create the log file C:\IBM\InformationServer\logs\import_mappings.log. The context for all source assets in the mappings is fully qualified. None of the target assets in any of the extension mapping documents has a context. The prefix JWC.34C.Americas.Customer is assigned to all target assets of all import files.
workbench extension mapping import 
-filename E:\CLI\import\a 
-o C:\IBM\InformationServer\logs\import_mappings.log
-tp JWC.34C.Americas.Customer 
-dom mysys
-u myid -p mypassword
The output of the istool command might be the following text:
Starting importing mappings matching 'E:\CLI\import\a'
Error occurred while parsing extension mapping document Billing.csv
        The heading for the Sources column is missing.
Successfully saved extension mapping document Billing.csv
Completed importing mappings from Billing.csv
Parent topic: Extension mapping commands
Related information:
Using the istool command line
Commands and common parameters
Mappings in extension mapping documents