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.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. |
java.lang.String | AdminURLPrefix The Administrator URL prefix. |
java.lang.String | BPCExplorerURLPrefix The Business Process Choreographer Explorer URL prefix. |
java.lang.String | EscalationURLPrefix The Escalation Details URL prefix. |
java.lang.String | SenderEMailAddress The sender email address. |
java.lang.String | TaskURLPrefix The Task Details URL prefix. |
java.lang.String | StaffQueryRefreshDaemonRunInterval The staff query refresh interval. |
java.lang.String | StaffQueryResultTimeout The result timeout of staff queries. |
java.lang.String | StaffQueryRefreshDaemonNextRun The date of the next run of the Staff Query Refresh daemon. |
boolean | GroupWorkItemsEnabled Indicates if the usage of 'Group WorkItems' is enabled. |
boolean | SubstitutionEnabled Indicates if the 'Staff Substitution' feature is enabled. |
boolean | RestrictSubstituteManagementToAdminsEnabled Indicates if the 'Substitute Management ' is restricted to administrators. |
boolean | AuditLoggingEnabled Indicates whether or not logging to state observers is enabled. |
boolean | CEILoggingEnabled Indicates whether or not if logging logging to CEI is enabled. |
java.lang.String[] | stateObservers The active Task Manager state observers. |
Operation Summary | |
void | deleteInvalidTaskTemplate( Cancelling the installation of a human task application results to an invalid task template in the human task managers database. |
int | deleteCompletedTaskInstances( Delete completed task instances that belong to a task template. |
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. |
void | refreshStaffQuery( This method refreshs staff query results for a task template after a staff directory change. |
void | refreshStaffQuery( This method refreshs staff query results where the specified users are in. |
void | refreshStaffQuery() This method refreshs all staff query results. |
int | cleanupUnusedStaffQueryInstances() This method deletes unused staff query instance data. |
int | deleteAuditLog( This method deletes audit log entries whereby the parameters are specifying which audit log entries and how much audit log entries to delete. |
void | addStateObserver( This method adds a state observer to the list of state observer plugins. |
void | removeStateObserver( This method removes a state observer from the list of state observer plugins. |
void | registerApplicationComponent( This method registers an Application Component identified by its name and specifies some default values for that Application Component. |
void | unregisterApplicationComponent( This method unregisters an application component identified by its name. |
void | forceDeleteAll( This method deletes an application component identified by its name. |
java.lang.String | updateStaffQueryRefreshDaemonRunInterval( Sets a new Staff Query refresh interval . |
java.lang.String | updateGroupWorkItemsEnabled( Enable or disable the usage of 'Group WorkItems'. |
void | updateSubstitutionEnabled( Enable or disable the Staff Substitution' feature. |
void | cleanupSharedWorkItems() This method deletes unused shared work items. |
Attribute Detail |
public java.lang.Integer numberOfMessagesInHoldQueue
public java.lang.String AdminURLPrefix
public java.lang.String BPCExplorerURLPrefix
public java.lang.String EscalationURLPrefix
public java.lang.String SenderEMailAddress
public java.lang.String TaskURLPrefix
public java.lang.String StaffQueryRefreshDaemonRunInterval
public java.lang.String StaffQueryResultTimeout
public java.lang.String StaffQueryRefreshDaemonNextRun
public boolean GroupWorkItemsEnabled
public boolean SubstitutionEnabled
public boolean RestrictSubstituteManagementToAdminsEnabled
public boolean AuditLoggingEnabled
public boolean CEILoggingEnabled
public java.lang.String[] stateObservers
Operation Detail |
public void deleteInvalidTaskTemplate(java.lang.String templateName,
java.lang.String validFrom,
java.lang.String nameSpace
)
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.
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
)
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)
public void replayHoldQueueMessages()
public void refreshStaffQuery(java.lang.String taskTemplateName,
java.lang.String nameSpace
)
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)
public void refreshStaffQuery(java.lang.String[] userIDs
)
userIDs
-
Array of user IDs.
public void refreshStaffQuery()
public int cleanupUnusedStaffQueryInstances()
public int deleteAuditLog(java.lang.String operation,
java.lang.String time,
java.lang.Integer slice
)
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'.
public void addStateObserver(java.lang.String stateObserver
)
stateObserver
-
Name of the state observer to be added.
public void removeStateObserver(java.lang.String stateObserver
)
stateObserver
-
Name of the state observer to be removed.
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
)
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).
public void unregisterApplicationComponent(java.lang.String applicationComponentName
)
applicationComponentName
-
Name of the application component to be unregistered.
public void forceDeleteAll(java.lang.String applicationComponentName
)
applicationComponentName
-
Name of the application component to be deleted.
public java.lang.String updateStaffQueryRefreshDaemonRunInterval(java.lang.String newRunInterval
)
newRunInterval
-
new run interval (CRON like) or null.
public java.lang.String updateGroupWorkItemsEnabled(boolean enabled
)
enabled
-
true to enable, false to disable
public void updateSubstitutionEnabled(boolean enabled
)
enabled
-
true to enable, false to disable
public void cleanupSharedWorkItems()