Retired BPEL Package Cleanup

This topic expands on the command line tool used to selectively cleanup RETIRED BPEL packages. This tool can be used to completely remove unwanted process instances along with the RETIRED package(s).

Warning: Do not retire the last active version of the BPEL when using the cleanup tool.

Update the following configuration settings in the process-cleanup.properties file which is located in the <BPS_HOME>/repository/conf directory.

##BPS database connection information as defined in datasources.properties file
database.url=jdbc:mysql://localhost/bps
database.username=root
database.password=root
database.driver=com.mysql.jdbc.Driver
user.timezone=GMT
clientTrustStorePath=/home/wso2bps/repository/resources/security/wso2carbon.jks
clientTrustStorePassword=wso2carbon
clientTrustStoreType=JKS
#tenat context eg: tenant mode; tenant.context=https://localhost:9443/t/abc.com
tenant.context=https://localhost:9443
#BPS super admin's login credentials
wso2.bps.username=admin
wso2.bps.password=admin
## Set this option true if instances need to be removed along with processes
delete.instances=false
## Available Filters for Instance States : ACTIVE, COMPLETED, SUSPENDED, TERMINATED, FAILED
## Listing process instances having the defined filter state
process.filterStates=COMPLETED,TERMINATED,FAILED

Execute the processcleanuptool.sh (processcleanuptool.bat for Windows) script which is located in the BPS_HOME/bin directory to run the tool.

List of instances shown in instance information page

Running the package cleanup tool

BPS server should be in running state until the cleanup job is fully completed. I.e., if the filter states are defined as "process.filterStates=COMPLETED,TERMINATED,FAILED" and if a retired package contains instances in ACTIVE or SUSPENDED state, the package will not be listed.

Database settings in the process-cleanup.properties file and in the datasources.properties file should match.

The cleanup tool can be configured to delete the instances along with the package or delete only the package and keep the instance data by configuring the delete.instances property. This is done in order to prevent important instance data loss.

Currently this tool supports only Oracle, MySQL and Microsoft SQL Server database types. You need to restart the server after running a cleanup task.

Use the user.timezone property to configure the correct time zone. This is particularly necessary when Oracle is used as the BPS database. You can find the DB timezone settings by executing the query select sessiontimezone from dual in Oracle.