workbench extension source export command

Use the istool command workbench extension source export to export extended data source assets from the metadata repository to a file that is in a comma-separated value (CSV) format.

Purpose

Use this command to export extended data sources or when you want to schedule an export.

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 export
authentication parameters
-directory directory_for export_file
-filename export_file_name
-pattern string_to_match
-type type_of_extension_source
-output log_file_name
[generic parameters]

Parameters

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

-directory | -dir directory_for export_file: Specifies the name of the directory that contains the export file. The export file can be a single file in a CSV format. Alternatively, the export file can contain multiple files in a CSV format that are combined into a single file in a compressed format.
-filename | -f export_file_name: Specifies the name and directory path of the export file. The export file is in a CSV format. If the file already exists, the export overwrites the file.
-pattern | -pt string_to_match: Specifies the text pattern to match in the name of the extended data sources. Use the percent sign (%) as a wildcard character.; If no pattern is specified, all assets of the type specified in -type are exported.
-type | -t type_of_extension_source: Specifies the type of extended data sources to export. The parameter is case-sensitive.; The possible values for type_of_extension_source are: Application, File, StoredProcedure, InParameter, OutParameter, InOutParameter, ResultColumn, ObjectType, Method, InputParameter, OutputValue.; You can export only one type at a time.
-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.

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:

You can export extended data source objects of type Method to a file in a CSV format in directory E:\CLI\files. The log file is C:\IBM\InformationServer\logs\amount_due_export.log:

istool> workbench extension source export 
-dir E:\CLI\files 
-o C:\IBM\InformationServer\logs\amount_due_export.log
-dom mysys
-u myid 
-p mypassword
-pt %
-t Method

Example 2:

You can export extended data source objects of type Application whose file name begins with the string "myApp" to a file in a CSV format in directory E:\CLI\files. The log file is C:\IBM\InformationServer\logs\amount_due_export.log:

istool> workbench extension source export 
-dir E:\CLI\files 
-o C:\IBM\InformationServer\logs\amount_due_export.log
-dom mysys
-u myid 
-p mypassword
-t Application  
-pt myApp%

Example 3:

To export all extended data source objects, you must export each of the three major types of extended data source (Application, StoredProcedure, and Files) separately. In this example, the individual export files will be located in directory E:\CLI\all_files. The log results of each export will be appended to the log file C:\IBM\InformationServer\logs\all_EDS_files_export.log.

istool> workbench extension source export 
-dir E:\CLI\all_files 
-f App
-o C:\IBM\InformationServer\logs\all_EDS_files_export.log
-dom mysys
-u myid 
-p mypassword
-pt %
-t Application 

istool> workbench extension source export 
-dir E:\CLI\all_files 
-f StoredProcedure
-o C:\IBM\InformationServer\logs\all_EDS_files_export.log
-dom mysys
-u myid 
-p mypassword
-pt %
-t StoredProcedure

istool> workbench extension source export 
-dir E:\CLI\all_files 
-f File
-o C:\IBM\InformationServer\logs\all_EDS_files_export.log
-dom mysys
-u myid 
-p mypassword
-pt %
-t File