workbench extension mapping delete command

Use the istool command workbench extension mapping delete to delete extension mapping documents from the metadata repository.

Purpose

Use this command to delete an extension mapping document or when you want to schedule a deletion. When you delete an extension mapping document from the metadata repository, you do not delete the source and target assets that are in the mappings.

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 mapping delete 
authentication parameters
-pattern matching_text_pattern
-output log_file_name
[generic parameters]

Parameters

These parameters are specific to the workbench extension mapping delete command for istool. For authentication parameters and generic parameters, see Common commands and parameters for a list of common parameters for istool.

-pattern | -pt matching_text_pattern: Specifies the text pattern to match in the name of the extension mapping document.; Include the file extension in the text pattern. Use the percent sign (%) as a wildcard character. The pattern matching is not case-sensitive. If the extension mapping document name has an embedded space, enclose the name in double quotation marks (").
-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

You can delete multiple extension mapping documents by using the wildcard character (%). This sample deletes extension mapping documents that are named Northwest_billing.csv and Northeast_billing.csv from the metadata repository and creates the log file C:\IBM\InformationServer\logs\Northwest_billing_delete_mappings.log:

istool> workbench extension mapping delete 
-pt North%_billing.csv 
-o C:\IBM\InformationServer\logs\Northwest_billing_delete_mappings.log
-dom mysys
-u myid -p mypassword

The output of the istool command would be:

Deleting mapping documents matching 'North%_billing.csv'
Found 2 matching mapping documents
Deleted Northwest_billing.csv
Deleted Northeast_billing.csv
Completed deletion of mapping documents