BPMEPVHistoryCleanup command

To reduce the performance impact of having a large number of exposed process variables (EPVs), use this command to delete EPV values that are no longer required. This command deletes the EPV values that match the specified command parameters, but you cannot delete the current or future EPV values. The progress of the command is logged to the standard SystemOut.log file.

The BPMEPVHistoryCleanup command is run using the AdminTask object of the wsadmin scripting client.

Important: In an environment with multiple security domains configured, use the PALService MBean instead of this wsadmin command. See The Process Application LifeCycle (PAL) MBean.

Prerequisites

The following conditions must be met:

Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.
You can run the command from any cluster member in a network deployment environment. However, you must first establish the wsadmin session to the SOAP port of the cluster member from where you are running the command.
To access the wsadmin command, the ID being used must have a WebSphere® Application Server role with more privileges than the monitor role. See Administrative roles for information about roles.
To access the IBM® BPM API used by this command, the ID being used must belong to either the bpmAdminGroup or bpmAuthorGroup. The default name for the bpmAdminGroup is tw_admins and the default name for the bpmAuthorGroup is tw_authors. See IBM Business Process Manager default group types for information about groups.
Tip: By default, only the DeAdmin user has both the WebSphere Application Server administrator role and membership in the bpmAdminGroup.

Location

Start the command from the install_root/bin directory.

Syntax

BPMEPVHistoryCleanup
[-containerAcronym process_application_acronym]
[-containerSnapshotAcronym process_application_snapshot_acronym]
[-transactionSlice number_of_EPV_values_to_delete_in_a_transaction]

Parameters

-containerAcronym process_application_acronym: A parameter that identifies the acronym that specifies the process application to perform EPV values cleanup for. For example, the BillingDispute process application might have an acronym of BILLDISP. This parameter is required if the parameter containerSnapshotAcronym is specified, otherwise it is optional.
containerSnapshotAcronym process_application_snapshot_acronym: An optional 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, see BPMShowProcessApplication command.
Tip: If you specify the special value Tip only the Tip snapshots are considered.
-transactionSlice number_of_EPV_values_to_delete_in_a_transaction: An optional parameter that specifies the number of EPV values to delete in each transaction. The default value is 1000. Specify the value 0 to perform the delete operation in one transaction.
Important: If the number of EPV values to be deleted is large, you might run out of transaction log space.
You should check the SystemOut.log file for exceptions if the cleanup service adjusted your value for transactionSlice. Adjusting the number of instances that are deleted in a transaction can improve the cleanup operation time.

Examples

The following examples show how to use the BPMEPVHistoryCleanup command.

Important: In a network deployment environment, use the port number that is configured for the application cluster member that runs the Process Server or IBM Process Center applications. To determine the correct port number, see the administrative console Ports collection page by clicking Servers > Server Types > WebSphere application servers > server_name > Communications > Ports then locate the value for SOAP_CONNECTOR_ADDRESS.

Deleting the complete EPV history of all snapshots of all process applications.

wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython 

wsadmin>AdminTask.BPMEPVHistoryCleanup()

Deleting the complete EPV history of a particular snapshots of a specific process application using the default transaction slice of 1000.

wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython 

wsadmin>AdminTask.BPMEPVHistoryCleanup('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1]')

Deleting the EPV history of all snapshots of a particular process application and using a transaction slice of 10000.

wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython 

wsadmin>AdminTask.BPMEPVHistoryCleanup('[-containerAcronym BILLDISP -transactionSlice 10000]')

The command returns with the number of deleted EPV values. In the standard SystemOut.log file it also logs a similar message for each completed transaction slice.