ProcessContainer MBean

Partial ObjectName:
WebSphere:*,type=ProcessContainer


MBean ProcessContainer

The Business Flow Manager MBean provides an interface to perform some admin functions without using the WebSphere administrative console


Attribute Summary
java.lang.IntegernumberOfMessagesInRetentionQueue
           If one of the JMS messages on the internal Process Container message queue cannot be processed, it is moved to the retention queue.
java.lang.IntegernumberOfMessagesInHoldQueue
           If one of the JMS messages on the Process Container retention message queue cannot be processed, it is moved to the hold queue.
java.lang.String[]stateObservers
           The active Business Flow Manager state observers.

Operation Summary
voiddeleteInvalidProcessTemplate(java.lang.String templateName, java.lang.String validFrom)
           Cancelling the installation of a business process application may result in an invalid process template in the Business Process Choreographer database.
voidreplayHoldQueueMessages()
           If one of the JMS messages on the Process Container retention message queue cannot be processed, it is moved to the hold queue.
voidreplayRetentionQueueMessages()
           If one of the JMS messages on the internal Process Container message queue cannot be processed, it is moved to the retention queue.
intdeleteCompletedProcessInstances(java.lang.String state, java.lang.String templateName, java.lang.String validFrom, java.lang.String completedBefore, java.lang.String startedBy)
           Deprecated.  As of 7.0, replaced by method 'deleteCompletedProcessInstances' that takes an array of states and additional parameter 'completedAfter'.
intdeleteCompletedProcessInstances(java.lang.String[] states, java.lang.String templateName, java.lang.String validFrom, java.lang.String completedAfter, java.lang.String completedBefore, java.lang.String startedBy)
           Delete completed process instances (and their child-processes) that belong to a process template.
java.lang.StringobserverRemoveDeletedInstancesData(java.lang.String datasourceName, java.lang.String dbSchemaName, java.lang.String completedBefore)
           Delete data corresponding to process instances which are deleted in the runtime from the Business Process Choreographer Observer's database
java.lang.StringobserverRemoveInstanceDataOfTemplate(java.lang.String datasourceName, java.lang.String dbSchemaName, java.lang.String templateName, java.lang.String validFrom)
           Delete data corresponding to process instances belonging to a specific process template from the Business Process Choreographer Observer's database
java.lang.StringobserverForceRemoveInstanceData(java.lang.String datasourceName, java.lang.String dbSchemaName, java.lang.String state, java.lang.String templateName, java.lang.String validFrom, java.lang.String completedBefore)
           Force delete data corresponding to process instances belonging to a specific process template from the Business Process Choreographer Observer's database.
intdeleteAuditLog(java.lang.String operation, java.lang.String time, java.lang.Integer slice)
           This method deletes audit log entries whereby the parameters are specifying which audit log entries and how much audit log entries to delete.
voidaddStateObserver(java.lang.String stateObserver)
           This method adds a state observer to the list of state observer plugins.
voidremoveStateObserver(java.lang.String stateObserver)
           This method removes a state observer from the list of state observer plugins.
voidmigrateProcessInstances(java.lang.String templateName, java.lang.String sourceValidFrom, java.lang.String targetValidFrom, java.lang.Integer slice)
           This method migrates all process instances of a given template to a new version.

Attribute Detail

numberOfMessagesInRetentionQueue

public java.lang.Integer numberOfMessagesInRetentionQueue
If one of the JMS messages on the internal Process Container message queue cannot be processed, it is moved to the retention queue. The messages are automatically retried until the retry count is reached. This property counts the messages that have been moved to the retention queue.
Since:
5.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

numberOfMessagesInHoldQueue

public java.lang.Integer numberOfMessagesInHoldQueue
If one of the JMS messages on the Process Container retention message queue cannot be processed, it is moved to the hold queue. This property counts the messages that have been moved to the hold queue.
Since:
5.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

stateObservers

public java.lang.String[] stateObservers
The active Business Flow Manager state observers.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Operation Detail

deleteInvalidProcessTemplate

public void deleteInvalidProcessTemplate(java.lang.String templateName, java.lang.String validFrom)
Cancelling the installation of a business process application may result in an invalid process template in the Business Process Choreographer database. Under certain conditions these templates can be seen in the Business Process Choreographer Explorer or can be returned by the Business Process Choreographer API. Use this method to delete those invalid templates. Parameters must be provided to identify the template in the database.
Parameters:
templateName - Name of the template as displayed in the administrative console.
validFrom - validFrom date of the template (in UTC) as displayed in the administrative console. The string should have the following format: 'yyyy-MM-ddThh:mm:ss'. For example, '2005-01-31T13:40:50'
Since:
6.0
Security Roles:
administrator
operator

replayHoldQueueMessages

public void replayHoldQueueMessages()
If one of the JMS messages on the Process Container retention message queue cannot be processed, it is moved to the hold queue. This method moves all messages accumulated on the hold queue to the internal Process Container message queue, in order to be processed again.
Since:
5.0.2
Security Roles:
administrator
operator

replayRetentionQueueMessages

public void replayRetentionQueueMessages()
If one of the JMS messages on the internal Process Container message queue cannot be processed, it is moved to the retention queue. This method moves all messages accumulated on the retention queue to the internal Process Container message queue, in order to be processed again.
Since:
5.0.2
Security Roles:
administrator
operator

deleteCompletedProcessInstances

public int deleteCompletedProcessInstances(java.lang.String state, java.lang.String templateName, java.lang.String validFrom, java.lang.String completedBefore, java.lang.String startedBy)
Deprecated.  As of 7.0, replaced by method 'deleteCompletedProcessInstances' that takes an array of states and additional parameter 'completedAfter'.

Parameters:
state - The to be considered state as a String. Allowed values are: 'finished', 'terminated', 'failed' and null. If null is specified no restriction based on the state occurs, i.e process instances in the state finished, failed and terminated will be deleted.
templateName - The name of the process template (optional - can be null)
validFrom - The validFrom timestamp (UTC) in format 'yyyy-MM-ddThh:mm:ss' of the process template (optional - can be null).
completedBefore - The time (UTC) in format 'yyyy-MM-dd[Thh:mm:ss]' before the process must have been completed (optional - can be null)
startedBy - The Id of the starter (optional - can be null)
Since:
6.1
Security Roles:
administrator
operator

deleteCompletedProcessInstances

public int deleteCompletedProcessInstances(java.lang.String[] states, java.lang.String templateName, java.lang.String validFrom, java.lang.String completedAfter, java.lang.String completedBefore, java.lang.String startedBy)
Delete completed process instances (and their child-processes) that belong to a process template. The qualifying process instances can be further restricted with either the time after or/and the time before they must have been completed or/and with the starter of the process instance. The considered states are: finished, failed, terminated.
Parameters:
states - List of states to be considered as 'completed'. Allowed values are: 'finished', 'terminated', 'failed' and null. If null is specified no restriction based on the state occurs, i.e process instances in the state finished, failed and terminated will be deleted.
templateName - The name of the process template (optional - can be null)
validFrom - The validFrom timestamp (UTC) in format 'yyyy-MM-ddThh:mm:ss' of the process template (optional - can be null).
completedAfter - The time (UTC) in format 'yyyy-MM-dd[Thh:mm:ss]' after which the process must have been completed (optional - can be null)
completedBefore - The time (UTC) in format 'yyyy-MM-dd[Thh:mm:ss]' before the process must have been completed (optional - can be null)
startedBy - The Id of the starter (optional - can be null)
Since:
7.0
Security Roles:
administrator
operator

observerRemoveDeletedInstancesData

public java.lang.String observerRemoveDeletedInstancesData(java.lang.String datasourceName, java.lang.String dbSchemaName, java.lang.String completedBefore)
Delete data corresponding to process instances which are deleted in the runtime from the Business Process Choreographer Observer's database
Parameters:
datasourceName - The name of the datasource to be used.
dbSchemaName - The schema name used in the Observer database.
completedBefore - The time (UTC) in format 'yyyy-MM-ddThh:mm:ss' before the process must have been deleted
Since:
6.1
Security Roles:
administrator
operator

observerRemoveInstanceDataOfTemplate

public java.lang.String observerRemoveInstanceDataOfTemplate(java.lang.String datasourceName, java.lang.String dbSchemaName, java.lang.String templateName, java.lang.String validFrom)
Delete data corresponding to process instances belonging to a specific process template from the Business Process Choreographer Observer's database
Parameters:
datasourceName - The name of the datasource to be used.
dbSchemaName - The schema name used in the Observer database.
templateName - The name of the process template.
validFrom - The validFrom timestamp (UTC) in format 'yyyy-MM-ddThh:mm:ss' of the process template..
Since:
6.1
Security Roles:
administrator
operator

observerForceRemoveInstanceData

public java.lang.String observerForceRemoveInstanceData(java.lang.String datasourceName, java.lang.String dbSchemaName, java.lang.String state, java.lang.String templateName, java.lang.String validFrom, java.lang.String completedBefore)
Force delete data corresponding to process instances belonging to a specific process template from the Business Process Choreographer Observer's database.
Parameters:
datasourceName - The name of the datasource to be used.
dbSchemaName - The schema name used in the Observer database.
state - The to be considered state as a String. Allowed values are: 'finished', 'terminated', 'failed'
templateName - The name of the process template (optional - can be null)
validFrom - The validFrom timestamp (UTC) in format 'yyyy-MM-ddThh:mm:ss' of the process template (optional - can be null).
completedBefore - The time (UTC) in format 'yyyy-MM-ddThh:mm:ss' before the process must have been completed
Since:
6.1
Security Roles:
administrator
operator

deleteAuditLog

public int deleteAuditLog(java.lang.String operation, java.lang.String time, java.lang.Integer slice)
This method deletes audit log entries whereby the parameters are specifying which audit log entries and how much audit log entries to delete.
Parameters:
operation - Possible operations to execute: One of the strings 'all', 'time', 'processtime'. Any other exception will cause an IllegalArgumentException.
time - In case of 'time' or 'processtime' the time (UTC) in format 'yyyy-MM-ddThh:mm:ss'. The time parameter defines that all audit log entries older than the specified time are deleted.
slice - Maximum number of entries to delete. In case of operation 'all' that number must be greater than '0'.
Since:
5.1
Security Roles:
administrator
operator

addStateObserver

public void addStateObserver(java.lang.String stateObserver)
This method adds a state observer to the list of state observer plugins.
Parameters:
stateObserver - Name of the state observer to be added.
Since:
6.0
Security Roles:
administrator
operator

removeStateObserver

public void removeStateObserver(java.lang.String stateObserver)
This method removes a state observer from the list of state observer plugins.
Parameters:
stateObserver - Name of the state observer to be removed.
Since:
6.0
Security Roles:
administrator
operator

migrateProcessInstances

public void migrateProcessInstances(java.lang.String templateName, java.lang.String sourceValidFrom, java.lang.String targetValidFrom, java.lang.Integer slice)
This method migrates all process instances of a given template to a new version.
Parameters:
templateName - Name of process template.
sourceValidFrom - Valid-from (UTC) of the source process template in format 'yyyy-MM-ddThh:mm:ss'.
targetValidFrom - Valid-form (UTC) date of the target process template in format 'yyyy-MM-ddThh:mm:ss'.
slice - Maximum number of process instances to migrate in one transaction.
Since:
7.0
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005