workbench purgeOMD command

Purpose

Use this command to delete operational metadata or when you want to schedule a delete.

You can purge operational metadata every month, based on the reporting needs of the enterprise and on the volume of information from job runs that you need to display in IBM InfoSphere Information Governance Catalog.

Requirements

• You must have the Information Governance Catalog Information Asset Administrator role.
• The version of istool command framework must be the same version as InfoSphere Information Governance Catalog.
• You must allocate more memory to the istool process. For details, see this technote.
• 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 purgeOMD
authentication parameters
[-beginDate early_date]
[-endDate late_date]
[-totalNumber number_to_keep] 
-all  
-assetID
[generic parameters] 

Parameters

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

-beginDate early_date

The date of the oldest operational metadata to delete. The date format is YYYY-MM-DD.

If the-endDate parameter is not used, all operational metadata from early_date to the current date is deleted.

If the -beginDate and -endDate parameters are not specified, all operational metadata is deleted.

-endDate late_date

The date of the newest operational metadata to delete. The date format is YYYY-MM-DD.

If the-beginDate parameter is not used, all operational metadata to late_date is deleted.

If the -beginDate and -endDate parameters are not specified, all operational metadata is deleted.

-totalNumber number_to_keep

The operational metadata from the number of job runs to keep, from the latest to the oldest job runs.

-all

All operational metadata is deleted.

If -all is not used, you must use either -beginDate with-endDate, or use -assetID.

-assetID | -id

Specifies the repository identification number of the engine, job, or transformation project whose operational metadata you want to delete.

To get the asset ID of a job, create a query for jobs and select the Display the asset ID in the query results check box.

If the ID is not specified, you must use either -beginDate with -endDate, or -all.

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.