BPMProcessInstancesCleanup command

Using this command deletes the BPD instance and its associated tasks and documents for the instances that are specified by the command parameters. It also logs data to a standard SystemOut.log file to track which process applications were selected for deleting instance data and associated documents.

Prerequisites

Location

Start the wsadmin scripting client from the install_root/bin directory.

Syntax

BPMProcessInstancesCleanup 
-containerAcronym process_application_acronym
-containerSnapshotAcronym process_application_snapshot_acronym
-instanceStatus instance_status 
[-endedAfterLocal local_time_on_the_server]
[-endedBeforeLocal local_time_on_the_server]
[-instanceID instance_IDs]
[-maximumDuration number_of_minutes]
[-outputFile file_path]
[-transactionSlice number_of_instances_to_delete_in_a_transaction]

Parameters

-containerAcronym process_application_acronym

A required parameter that identifies the acronym that specifies the process application to perform process instance cleanup against. For example, the BillingDispute process application might have an acronym of BILLDISP.

-containerSnapshotAcronym process_application_snapshot_acronym

A required parameter that identifies the snapshot acronym for the process application. The snapshot acronym can be different from the snapshot name. To find the snapshot acronym, run the BPMShowProcessApplication command. Refer to the topic in the related link.

-instanceStatus instance_status

A required parameter that identifies the status of process instances to clean up.

• COMPLETED - Removes all completed process instances
• FAILED - Removes all failed process instances
• CANCELED - Removes all terminated process instances
• ALL - Removes all completed, failed, and canceled process instances

Tip: You cannot delete an instance that is currently running.

-endedAfterLocal local_time_on_the_server

An optional parameter of type String that identifies the local time on the server. The string must have the following format:yyyy-MM-ddThh:mm:ss (year, month, day, T, hours, minutes, seconds). Only instances that completed, failed, or canceled after the specified time period by this parameter are processed. If you use this parameter with the endedBeforeLocal parameter, only instances that completed, failed, or canceled during the specified time period by this parameter are processed.

-endedBeforeLocal local_time_on_the_server

An optional parameter of type String that identifies the local time on the server. The string must have the following format: yyyy-MM-ddThh:mm:ss (year, month, day, T, hours, minutes, seconds). Only instances that completed, failed, or canceled before the specified time period are processed. If you use this parameter with the endedAfterLocal parameter, only instances that completed, failed, or canceled during the specified time period by this parameter are processed.

-instanceID instance_IDs

An optional parameter of type String[] that identifies a list of instance IDs that are being removed. If there is more than one instance ID, each instance ID must be delimited by a space for Jython format commands or a semicolon for JACL format commands. You can also use this parameter with endedAfterLocal or endedBeforeLocal. See the examples in this topic.

-maximumDuration number_of_minutes

An optional parameter that specifies the maximum deletion time in minutes. If the cleanup takes longer than the time specified here, the current transaction slice for the current cleanup job is completed, and then the current cleanup job is stopped. The default is 0 (that is, no limit) if not specified.

-outputFile file_path

An optional parameter that specifies the file path to write the log messages that result from running the command. The path to the file can be absolute or relative but the directory structure must already exist. If you do not provide this parameter, the message are written to the SystemOut.log file.

-transactionSlice number_of_instances_to_delete_in_a_transaction

An optional parameter that specifies the number of instances in the transaction for the delete operation. The default value is 1 if not specified.

You should check the SystemOut.log file for exceptions if the cleanup service adjusted your transactionSlice. Adjusting the number of instances to be deleted in a transaction can improve the cleanup operation time.