TaskManager MBean

Partial ObjectName:
WebSphere:*,type=TaskManager


MBean TaskManager

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


Attribute Summary
java.lang.IntegernumberOfMessagesInHoldQueue
           If one of the JMS messages on the internal Task Manager message queue cannot be processed, it is moved to the hold queue.
java.lang.StringAdminURLPrefix
           The Administrator URL prefix.
java.lang.StringBPCExplorerURLPrefix
           The Business Process Choreographer Explorer URL prefix.
java.lang.StringEscalationURLPrefix
           The Escalation Details URL prefix.
java.lang.StringSenderEMailAddress
           The sender email address.
java.lang.StringTaskURLPrefix
           The Task Details URL prefix.
java.lang.StringStaffQueryRefreshDaemonRunInterval
           The staff query refresh interval.
java.lang.StringStaffQueryResultTimeout
           The result timeout of staff queries.
java.lang.StringStaffQueryRefreshDaemonNextRun
           The date of the next run of the Staff Query Refresh daemon.
booleanGroupWorkItemsEnabled
           Indicates if the usage of 'Group WorkItems' is enabled.
booleanSubstitutionEnabled
           Indicates if the 'Staff Substitution' feature is enabled.
booleanRestrictSubstituteManagementToAdminsEnabled
           Indicates if the 'Substitute Management ' is restricted to administrators.
booleanAuditLoggingEnabled
           Indicates whether or not logging to state observers is enabled.
booleanCEILoggingEnabled
           Indicates whether or not if logging logging to CEI is enabled.
java.lang.String[]stateObservers
           The active Task Manager state observers.

Operation Summary
voiddeleteInvalidTaskTemplate(java.lang.String templateName, java.lang.String validFrom, java.lang.String nameSpace)
           Cancelling the installation of a human task application results to an invalid task template in the human task managers database.
intdeleteCompletedTaskInstances(java.lang.String[] states, java.lang.String templateName, java.lang.String nameSpace, java.lang.String validFrom, java.lang.String completedAfter, java.lang.String completedBefore, java.lang.String originator)
           Delete completed task instances that belong to a task template.
voidreplayHoldQueueMessages()
           If one of the JMS messages on the internal Task Manager message queue cannot be processed, it is moved to the hold queue.
voidrefreshStaffQuery(java.lang.String taskTemplateName, java.lang.String nameSpace)
           This method refreshs staff query results for a task template after a staff directory change.
voidrefreshStaffQuery(java.lang.String[] userIDs)
           This method refreshs staff query results where the specified users are in.
voidrefreshStaffQuery()
           This method refreshs all staff query results.
intcleanupUnusedStaffQueryInstances()
           This method deletes unused staff query instance data.
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.
voidregisterApplicationComponent(java.lang.String name, java.lang.String instanceCreatorQuery, java.lang.Boolean autoClaim, java.lang.Boolean businessRelevance, java.lang.String calendarJNDIName, java.lang.String calendarName, java.lang.String staffPluginProviderJNDIName, java.lang.String eventHandlerName, java.lang.Boolean supportsDelegation, java.lang.Boolean supportsSubtask, java.lang.Boolean supportsFollowonTask, java.lang.Boolean allowClaimWhenSuspended, java.lang.Integer substitutionPolicy)
           This method registers an Application Component identified by its name and specifies some default values for that Application Component.
voidunregisterApplicationComponent(java.lang.String applicationComponentName)
           This method unregisters an application component identified by its name.
voidforceDeleteAll(java.lang.String applicationComponentName)
           This method deletes an application component identified by its name.
java.lang.StringupdateStaffQueryRefreshDaemonRunInterval(java.lang.String newRunInterval)
           Sets a new Staff Query refresh interval .
java.lang.StringupdateGroupWorkItemsEnabled(boolean enabled)
           Enable or disable the usage of 'Group WorkItems'.
voidupdateSubstitutionEnabled(boolean enabled)
           Enable or disable the Staff Substitution' feature.
voidcleanupSharedWorkItems()
           This method deletes unused shared work items.

Attribute Detail

numberOfMessagesInHoldQueue

public java.lang.Integer numberOfMessagesInHoldQueue
If one of the JMS messages on the internal Task Manager 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:
6.0
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

AdminURLPrefix

public java.lang.String AdminURLPrefix
The Administrator URL prefix.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

BPCExplorerURLPrefix

public java.lang.String BPCExplorerURLPrefix
The Business Process Choreographer Explorer URL prefix.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

EscalationURLPrefix

public java.lang.String EscalationURLPrefix
The Escalation Details URL prefix.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

SenderEMailAddress

public java.lang.String SenderEMailAddress
The sender email address.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

TaskURLPrefix

public java.lang.String TaskURLPrefix
The Task Details URL prefix.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

StaffQueryRefreshDaemonRunInterval

public java.lang.String StaffQueryRefreshDaemonRunInterval
The staff query refresh interval.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

StaffQueryResultTimeout

public java.lang.String StaffQueryResultTimeout
The result timeout of staff queries.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

StaffQueryRefreshDaemonNextRun

public java.lang.String StaffQueryRefreshDaemonNextRun
The date of the next run of the Staff Query Refresh daemon. If the daemon is not running, an empty string is returned.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

GroupWorkItemsEnabled

public boolean GroupWorkItemsEnabled
Indicates if the usage of 'Group WorkItems' is enabled.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

SubstitutionEnabled

public boolean SubstitutionEnabled
Indicates if the 'Staff Substitution' feature is enabled.
Since:
6.1
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

RestrictSubstituteManagementToAdminsEnabled

public boolean RestrictSubstituteManagementToAdminsEnabled
Indicates if the 'Substitute Management ' is restricted to administrators. If it's restricted to administrator, true is returned. If everybody may manage the substitution, false is returned.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

AuditLoggingEnabled

public boolean AuditLoggingEnabled
Indicates whether or not logging to state observers is enabled.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

CEILoggingEnabled

public boolean CEILoggingEnabled
Indicates whether or not if logging logging to CEI is enabled.
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

stateObservers

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

Operation Detail

deleteInvalidTaskTemplate

public void deleteInvalidTaskTemplate(java.lang.String templateName, java.lang.String validFrom, java.lang.String nameSpace)
Cancelling the installation of a human task application results to an invalid task template in the human task managers database. Under certain conditions these template 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'
nameSpace - Namespace of the template as displayed in the administrative console.
Since:
6.0
Security Roles:
administrator
operator

deleteCompletedTaskInstances

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

replayHoldQueueMessages

public void replayHoldQueueMessages()
If one of the JMS messages on the internal Task Manager 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 Task Manager message queue, in order to be processed again.
Since:
6.0
Security Roles:
administrator
operator

refreshStaffQuery

public void refreshStaffQuery(java.lang.String taskTemplateName, java.lang.String nameSpace)
This method refreshs staff query results for a task template after a staff directory change.
Parameters:
taskTemplateName - The name of the task template. If it is 'null', all entries are refreshed.
nameSpace - Namespace in that the template exists (can be null)
Since:
6.0
Security Roles:
administrator
operator

refreshStaffQuery

public void refreshStaffQuery(java.lang.String[] userIDs)
This method refreshs staff query results where the specified users are in.
Parameters:
userIDs - Array of user IDs.
Since:
6.0
Security Roles:
administrator
operator

refreshStaffQuery

public void refreshStaffQuery()
This method refreshs all staff query results.
Since:
6.0
Security Roles:
administrator
operator

cleanupUnusedStaffQueryInstances

public int cleanupUnusedStaffQueryInstances()
This method deletes unused staff query instance data.
Since:
6.0
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: 'all', 'time' or 'tasktime'.
time - In case of 'time' or 'tasktime' 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:
6.0
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

registerApplicationComponent

public void registerApplicationComponent(java.lang.String name, java.lang.String instanceCreatorQuery, java.lang.Boolean autoClaim, java.lang.Boolean businessRelevance, java.lang.String calendarJNDIName, java.lang.String calendarName, java.lang.String staffPluginProviderJNDIName, java.lang.String eventHandlerName, java.lang.Boolean supportsDelegation, java.lang.Boolean supportsSubtask, java.lang.Boolean supportsFollowonTask, java.lang.Boolean allowClaimWhenSuspended, java.lang.Integer substitutionPolicy)
This method registers an Application Component identified by its name and specifies some default values for that Application Component. Every application component that creates task instances or templates must be registered this way. Human Task Manager (HTM) and Business Flow Manager (BFM) are registered by default.
Parameters:
name - Name of the application component to be registered.
instanceCreatorQuery - Staff verb used to authorize creation of task instances. Can be overwritten by each task template.
autoClaim - Auto claim of tasks (true or false) (can be null, then false is used).
businessRelevance - Specifies if the task is 'business relevant' (true or false) (can be null, then false is used).
calendarJNDIName - Calendar JNDI name (can be null when the calendar name is null too).
calendarName - Name of the calendar (can be null).
staffPluginProviderJNDIName - Staff plugin provider JNDI name.
eventHandlerName - Name of the event handler (can be null).
supportsDelegation - Specifies if work items may be created/transferred/deleted (true or false) (can be null, then true is used).
supportsSubtask - Specifies if subtasks can be created (true or false) (can be null, then true is used).
supportsFollowonTask - Specifies if follow-on tasks can be created (true or false) (can be null, then true is used).
allowClaimWhenSuspended - Specifies if tasks can be claimed when they are suspended (true or false) (if null, then false is used).
substitutionPolicy - Specifies the substitution policy for the tasks (0 = no substitution, 1 = substitute if absent, 2 = select user if present) (if null, 'no substitution' is used).
Since:
6.1.0
Security Roles:
administrator
operator

unregisterApplicationComponent

public void unregisterApplicationComponent(java.lang.String applicationComponentName)
This method unregisters an application component identified by its name. To unregister an application component, the following conditions must be met: 1. all task templates must be stopped 2. there must not be any tasks running for that application component 3. there must not be any task template that have task instances used by another application component Note: The default application components 'BFM' and 'HTM' can not be deleted.
Parameters:
applicationComponentName - Name of the application component to be unregistered.
Since:
6.0
Security Roles:
administrator
operator

forceDeleteAll

public void forceDeleteAll(java.lang.String applicationComponentName)
This method deletes an application component identified by its name. The force the deletion of an application Component, the following conditions must be met: 1. there must not be any task template that have task instances used by another application component Note: The default application components 'BFM' and 'HTM'' cannot be deleted.
Parameters:
applicationComponentName - Name of the application component to be deleted.
Since:
6.0
Security Roles:
administrator
operator

updateStaffQueryRefreshDaemonRunInterval

public java.lang.String updateStaffQueryRefreshDaemonRunInterval(java.lang.String newRunInterval)
Sets a new Staff Query refresh interval . 'newRunInterval' is a CRON string. If the interval is null or empty, the daemon will be stopped. In this case, null is returned. If the daemon is not running yet, it will be started using the the passed interval. If the interval was successfully updated, the date of the next run is returned.
Parameters:
newRunInterval - new run interval (CRON like) or null.
Since:
6.0.2
Security Roles:
administrator
operator

updateGroupWorkItemsEnabled

public java.lang.String updateGroupWorkItemsEnabled(boolean enabled)
Enable or disable the usage of 'Group WorkItems'. Returns null if everything went well, if not a message key is returned indicating the failure.
Parameters:
enabled - true to enable, false to disable
Since:
6.0.2
Security Roles:
administrator
operator

updateSubstitutionEnabled

public void updateSubstitutionEnabled(boolean enabled)
Enable or disable the Staff Substitution' feature.
Parameters:
enabled - true to enable, false to disable
Since:
6.1
Security Roles:
administrator
operator

cleanupSharedWorkItems

public void cleanupSharedWorkItems()
This method deletes unused shared work items.
Since:
7.0.0.3
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005