deleteCompletedProcessInstances.py administrative script

IBM BPM, V8.0.1, All platforms > Reference > Commands and scripts > Business Process Choreographer administrative scripts
deleteCompletedProcessInstances.py administrative script

Use the deleteCompletedProcessInstances.py administrative script to selectively delete from the Business Process Choreographer database any top-level process instances that have reached an end state of finished, terminated, expired, or failed.

Prerequisites
The following conditions must be met:

Run the script in the connected mode, that is, the application server must be running.
If Business Process Choreographer is configured on a cluster, then at least one cluster member must be running.
If WebSphere administrative security is enabled, and your user ID does not have operator authority, include the wsadmin -user and -password options to specify a user ID that has operator authority.
If you are not working with the default profile, use the wsadmin -profileName profile option to specify the profile.

Location

The deleteCompletedProcessInstances.py administrative script is in the Business Process Choreographer admin directory.

Syntax
 –f deleteCompletedProcessInstances.py 
  (([-node  nodeName] -server  server_name) | (-cluster  cluster_name))
  (-all | [-finished] [-terminated] [-failed] )
  [-templateName  templateName 
  [-validFromUTC  timestamp]]
  [-startedBy  userID]
  [(-completedAfterLocal  timestamp)|(-completedAfterUTC  timestamp)]
  [(-completedBeforeLocal  timestamp)|(-completedBeforeUTC  timestamp)]
Parameters

-node nodeName

The name of the node where Business Process Choreographer is configured. This is optional when specifying the server name. The default is the local node.

-server serverName

The name of the server where Business Process Choreographer is configured. This is required if a cluster is not specified.

-cluster clusterName

The name of the cluster where Business Process Choreographer is configured. This is required if Business Process Choreographer is configured on a cluster.

-all | [-finished] [-terminated] [-failed] [-expired]

Specifies which task instances are to be deleted according to their state. The -all option means all end states: finished, terminated, failed, and expired. If you do not specify -all, you must specify one or more of the end states.

-templateName templateName

Optionally, specifies the name of the task template whose instances will be deleted. If you specify this option you must also specify the nameSpace parameter. If there are multiple task templates sharing the same name but with different validFromUTC dates the instances for all task templates with that name are deleted unless you use the validFromUTC parameter to specify a particular template.

-validFromUTC timestamp

The date and time from which the template is valid in Coordinated Universal Time (UTC). The string must have the following format: 'yyyy-MM-ddThh:mm:ss' (year, month, day, T, hours, minutes, seconds).
For example, 2005-01-31T13:40:50

-startedBy userID

Optionally, only deletes completed process instances that were started by the given User ID.

-completedAfterLocal timestamp

Optionally, specifies that only instances that completed after the given local time on the server are deleted. The format for the timestamp string is the same as for -validFromUTC, except that the time part is optional for this parameter. If you only specify a date, the time defaults to 00:00:00 local time on the server.

-completedAfterUTC timestamp

Optionally, specifies that only instances that completed after the given UTC time are deleted. The format for the timestamp string is the same as for -validFromUTC, except that the time part is optional for this parameter. If you only specify a date, the time defaults to 00:00:00 local time on the server.

-completedBeforeLocal timestamp

Optionally, specifies that only instances that completed before the given local time on the server are deleted. The format for the timestamp string is the same as for -validFromUTC, except that the time part is optional for this parameter. If you only specify a date, the time defaults to 00:00:00 local time on the server.

-completedBeforeUTC timestamp

Optionally, specifies that only instances that completed before the given UTC time are deleted. The format for the timestamp string is the same as for -validFromUTC, except that the time part is optional for this parameter. If you only specify a date, the time defaults to 00:00:00 local time on the server.

Examples

For example, to delete all of the process instances running on node myNode in server myServer that are in the state finished, and were started by the user Anita: Enter the following command:
wsadmin.sh –f deleteCompletedProcessInstances.py 
        -node  myNode -server  myServer 
        -finished
        -startedBy Anita
wsadmin.sh –f deleteCompletedProcessInstances.py 
        -node  myNode -server  myServer 
        -finished
        -startedBy Anita
wsadmin –f deleteCompletedProcessInstances.py 
        -node  myNode -server  myServer 
        -finished
        -startedBy Aita
Business Process Choreographer administrative scripts

Related tasks:
Delete BPEL process instances