workbench extension source import command

Use the istool command workbench extension source import to import extended data sources from a file in a comma-separated value (CSV) format into the metadata repository.

Purpose

Use this command to import extended data sources or when you want 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

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> workbench extension source import
authentication parameters
-filename import_file 
-output log_file_name
[-overwrite] true_or_false
[generic parameters]

Parameters

These parameters are specific to the workbench extension source import command. For authentication parameters and generic parameters, see Common commands and parameters.

-filename | -f import_file: Specifies the name and directory path of the file that contains the extended data source objects for import into the metadata repository. The file must be in a CSV format for extended data sources.; Alternatively, you can specify the name of a directory to import all CSV files in that directory.
-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 true_or_false: By default, the value is true and the import overwrites the extended data source object in the metadata repository. If the value is false, the existing extended data source object in the metadata repository remains.

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.

For extended data sources, the workbench extension source 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 source import command.

If the extended data source assets were exported according to major type (Application, StoredProcedure, and Files) into separate export files, the correct hierarchy of the extended data source assets is maintained during the import. Therefore, you can import these export files in any order. However, if the extended data sources were exported according to members of a major type, for example, ResultColumn, then you must use the following order to import:

Application

ObjectType
Method
The order does not matter: InputParameter, OutputValue

StoredProcedure

The order does not matter: InParameter, OutParameter, InOutParameter, ResultColumn

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

Example 1: Importing major types of extended data sources

You want to import extended data sources from the CSV files in the directoryE:\CLI\files. The CSV files are the export files of the three major types of extended data source assets: Application, StoredProcedure, and File. The log file is C:\IBM\InformationServer\logs\EDS_all_import.log. You can import all three CSV files in the directory with the command:

istool> workbench extension source import 
-f E:\CLI\files 
-o C:\IBM\InformationServer\logs\EDS_all_import.log
-dom mysys
-u myid -p mypassword

In this case, because each CSV import file has a major type of extended data source, the order of import does not matter.

Example 2: Importing members of a major type of extended data sources

You want to import ResultColumn, which is an extended data source asset member of type StoredProcedure. You must first import StoredProcedure if it does not exist in the target repository. Then, you import ResultColumn, which is in the CSV file called ResultColumn_for_import.csv:

istool> workbench extension source import 
-f E:\CLI\files\ResultColumn_for_import 
-o C:\IBM\InformationServer\logs\ResultColumn_import.log
-dom mysys
-u myid -p mypassword