Human Task Manager settings

Use this panel to manage the Human Task Manager for a given server.

A Human Task Manager provides services to run human tasks within an application server. To view this administrative console page, click Servers > Clusters > WebSphere application server clusters > cluster name, then on the Configuration tab, in the Business Process Manager section, expand Business Process Choreographer, click Human Task Manager, and select the Configuration tab.

Note: Changes made on this page do not affect the server until after it is restarted. To make changes that affect the server without having to restart the server, select the Runtime tab.

E-mail session JNDI name

The Java Naming and Directory Interface (JNDI) name of the Simple Mail Transfer Protocol (SMTP) email session resource that will be used by the Human Task Manager to send escalation mails.

Type Value
Data type Read-only string
Value mail/HTMNotification_clusterName

Sender e-mail address

The address that is used as the sender for escalation emails.

Type Value
Data type String
Default taskmanager.emailservice@htm.companydomain

Escalation URL prefix

This prefix can be used to provide a link in escalation emails for more details about the escalation.

Type Value
Data type String
Default None
Example http://myServer:9080/EscalationDetailsView.jsp
Example that works with the default configuration of the Business Process Choreographer Explorer http://myServer:9080/bpc/faces/pages/layouts/views/EscalationDetailsView.jsp
If you have an application named EscalationDetailsViewer installed on your IBM Business Process Manager, which can display the details of a Human Task Manager task escalation instance, and myServer is the host name of the IBM Business Process Manager server that has the Business Process Choreographer Explorer installed, then you can include the following HTML link in the body of an escalation email to allow the recipient of the email to access the details of the escalation:
<a href="%htm:escalation.URLPrefix%?id=%htm:escalation.instanceID%">Escalation details</a>

Task URL prefix

The prefix for the URL that can be included in emails for more details about a task.

Type Value
Data type String
Default None
Example http://myServer:9080/TaskInstanceDetailsView.jsp
Example that works with the default configuration of the Business Process Choreographer Explorer http://myServer:9080/bpc/faces/pages/layouts/views/TaskInstanceDetailsView.jsp
If you have an application named TaskDetailsViewer installed on your IBM Business Process Manager, which can display the details of a Human Task Manager task instance, and myServer is the host name of the IBM Business Process Manager server that has the Business Process Choreographer Explorer installed, then you can include the following HTML link in the body of an escalation email to allow the recipient of the email to access the details of the task:
<a href="%htm:task.URLPrefix%?id=%htm:task.instanceID%">Task details</a>

Administrator URL prefix

The prefix for the URL that can be included in the escalation email that is sent to people who perform the task administrator role.

Type Value
Data type String
Default None
Example http://myServer:9080/AdministratorTaskDetailsViewer
Example that works with the default configuration of the Business Process Choreographer Explorer http://myServer:9080/bpc/faces/pages/layouts/views/TaskInstanceDetailsView.jsp
If you have an application named AdministratorTaskDetailsViewer installed on your IBM Business Process Manager, which can be used by administrators to display the details of a Human Task Manager task instance, and myServer is the host name of the IBM Business Process Manager server that has the Business Process Choreographer Explorer installed, then you can include the following HTML link in the body of an escalation email to allow the recipient of the email to access the details of the task:
<a href="%htm:task.URLPrefixAdmin%?id=%htm:task.instanceID%">Task details</a>

Process Explorer URL prefix

The prefix for the URL for the Business Process Choreographer Explorer.

Type Value
Data type String
Default None
Example http://myServer:9080/bpc

Enable Common Event Infrastructure logging

Common Event Infrastructure (CEI) logging can be enabled or disabled.

Type Value
Data type Check box
Default Not selected

Enable audit logging

Audit logging can be enabled or disabled.

Type Value
Data type Check box
Default Not selected

Enable task history

Select this check box to display task history data in Business Space, or to retrieve task history data using the Task Instance History Representational State Transfer (REST) interface.

Type Value
Data type Check box
Default Not selected

People query refresh schedule

The schedule for refreshing people queries. If you are using people substitution, a people query refresh must be performed after changing a person's "is absent" status for the people assignment to take their new status into account.

Type Value
Data type String
Format This field uses the WebSphere crontab format <Seconds> <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> according to com.ibm.websphere.scheduler.UserCalendar
Example To refresh the people queries once per hour on Thursdays, use the schedule 0 0 * * * 4
Default 0 0 1 * * ? (every night at one o'clock)
Note: Each staff query refresh can have a significant impact on performance, so it is best not to perform the refresh too often.

Timeout for people query result

The duration in seconds that the results of a people query are considered to be valid. After this duration, the people query results will expire.

Type Value
Data type Integer
Default 3600
Units Seconds

Enable group work items

Select this check box to if you want Human Task Manager queries and API methods to consider group work items. Queries are faster if group work items are not enabled.

Any applications that were written for a version before Version 6.0.2 that use one or both of the interfaces com.ibm.bpe.api.StaffResultSet or com.ibm.task.api.StaffResultSet should be modified in order to cope with group work items before you enable group work items.

Type Value
Data type Check box
Default Not selected (group work items are not enabled to ensure compatibility with applications written before Version 6.0.2)

Enable substitution

Select this check box if people are allowed to perform a substitution action for a user ID that is not their own.

Type Value
Data type Check box
Default Not selected

Restrict substitute management to administrators

Select this check box if only administrators can perform staff substitution. If this option is selected, an exception is generated if a non-administrator attempts to perform a substitution action for a user ID that is not her own.

Type Value
Data type Check box
Default Not selected (substitution is not restricted to administrators)

Enable work basket-based people assignment and routing

Select this check box to use work baskets to assign tasks to people.

Type Value
Data type Check box
Default Not selected

Enable business categories

Select this check box to use business categories to classify tasks according to business criteria

Type Value
Data type Check box
Default Not selected

Shared work item cleanup schedule

The schedule for deleting shared work items and unused cached people query results.

Do not use the same schedule as the people query refresh schedule.

Type Value
Data type String
Format This field uses the WebSphere crontab format <Seconds> <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> according to com.ibm.websphere.scheduler.UserCalendar
Example To delete unused shared work items and unused cached people queries once per hour on Thursdays, use the schedule 0 0 * * * 4
Default 0 0 3 * * ? (every night at three o'clock)

Duration until deletion of unused shared work items

The duration in hours that a shared work item must be unused before it is eligible for deletion.

Type Value
Data type Integer
Default 24
Units Hours

Shared work item cache size

The size of the cache for shared work items.

Type Value
Data type Integer
Default 1000
Units Work items