Configure the Process Portal task index

IBM BPM, V8.0.1, All platforms > Administer the IT infrastructure > Administer the Process Portal task index
Configure the Process Portal task index

You can change the location where the index is stored by modifying an environment variable. To change the index update interval, include completed tasks in the index, or turn off the task indexing, you must edit the 100Custom.xml configuration file.
The task index allows process participants in IBM Process Portal to search for tasks that contain particular metadata or instance data.
Because the task indexing is enabled by default, the following configuration actions are optional.

Setting the location of the task index
Changing the index behavior

Setting the location of the task index

The location of the task index is determined by the value of the environment variable BPM_SEARCH_TASK_INDEX. This variable has cell scope on a stand-alone server, and cluster scope on a cluster.

On a cluster

The default location is $<BPM_SEARCH_TASK_INDEX_ROOT>/ cluster_name. Using this default results in one index per cluster on each node, so that all cluster members on the same node share the same index.
To reduce the additional task indexing being incurred by all cluster members, cluster members can share the index across nodes. Only one cluster member is responsible for maintaining the task index at a time. This is enforced by a locking strategy on the index. To set up the task index, use a shared network storage solution for your task index and change the value of the cell scoped BPM_SEARCH_TASK_INDEX_ROOT variable to point to the common location.
If you want particular cluster members to have their own index you can change the value of the cell scoped BPM_SEARCH_TASK_INDEX_ROOT variable to point to a different location.
To locate the environments variables in the administrative console, click Environment > WebSphere Variables.

On a stand-alone server

The default location of the task index is $<BPM_SEARCH_TASK_INDEX_ROOT>/$<WAS_SERVER_NAME>.
If the BPM_SEARCH_TASK_INDEX variable is not set, the location defaults to $<USER_INSTALL_ROOT>/searchIndex/task/$<WAS_SERVER_NAME>, which results in one index per server.
To change the task index location, in the administrative console, click Environment > WebSphere Variables. If the BPM_SEARCH_TASK_INDEX variable does not exist, define it with cell scope then set the value to the wanted location.

Changing the task index behavior

By default, the task index configuration provides the following settings:

Task indexing is enabled.
The task index is updated every 10 seconds.
The task index is only updated for open tasks; it is not updated for completed tasks.
To change the task index behavior, perform the following actions:
Edit the 100Custom.xml file for the appropriate server:

<process_center_profile>\config\cells\<Cell>\nodes\<node>\servers\<server>\process-server\config\system\100Custom.xml

<process_center_profile>/config/cells/<Cell>/nodes/<node>/servers/<server>/process-server/config/system/100Custom.xml
Add or edit the following code snippet as required:
<search-index>            
    <task-index-enabled>true</task-index-enabled>            
    <task-index-update-interval>10</task-index-update-interval>
    <task-index-update-completed-tasks>false</task-index-update-completed-tasks>
    <task-index-store-fields>false</task-index-store-fields>
</search-index>
Within the <search-index> section, modify the appropriate task index tags for the configuration settings that you want to change.

XML tags that can be used to change the task index configuration settings
XML tag Configuration setting description
<task-index-enabled> To enable task indexing, set this Boolean value to true; if the task index does not exist, it will be created. To turn off task indexing, use the value false; if the index does not exist it is not created. When this setting is set to the value false, the search field in the Process Portal user interface is hidden.
<task-index-update-interval> This integer value specifies the time interval between task index updates in seconds. The specified interval determines when the state of the instance variables is captured for tasks that completed since the last index update. Only those tasks that are completed during the current interval are searchable using the latest instance data.
The default value for the update interval is 10 seconds. The minimum value is one second.
<task-index-update-completed-tasks> This Boolean value controls whether the task index is updated for completed tasks. The default value is false, which means that only information about open tasks is updated. If you change the value to true, instance-level updates, such as business data that is updated later in the process, is propagated to completed tasks.
<task-index-store-fields> This Boolean value controls whether the actual field values are stored as separate fields. The default value is false, which means that the actual field values are not stored as separate fields. You might want to change the value to true for debugging purposes because it improves the readability for humans, or because it allows queries by other search tools.

Save your changes.
Restart the server to activate the changes.
Administer the Process Portal task index

Related concepts:
Update the Process Portal task index
Search tips for Process Portal

Related tasks:
Making variables available for Process Portal searches

Related information:
The 99Local.xml and 100Custom.xml configuration files

XML tag	Configuration setting description
<task-index-enabled>	To enable task indexing, set this Boolean value to true; if the task index does not exist, it will be created. To turn off task indexing, use the value false; if the index does not exist it is not created. When this setting is set to the value false, the search field in the Process Portal user interface is hidden.
<task-index-update-interval>	This integer value specifies the time interval between task index updates in seconds. The specified interval determines when the state of the instance variables is captured for tasks that completed since the last index update. Only those tasks that are completed during the current interval are searchable using the latest instance data. The default value for the update interval is 10 seconds. The minimum value is one second.
<task-index-update-completed-tasks>	This Boolean value controls whether the task index is updated for completed tasks. The default value is false, which means that only information about open tasks is updated. If you change the value to true, instance-level updates, such as business data that is updated later in the process, is propagated to completed tasks.
<task-index-store-fields>	This Boolean value controls whether the actual field values are stored as separate fields. The default value is false, which means that the actual field values are not stored as separate fields. You might want to change the value to true for debugging purposes because it improves the readability for humans, or because it allows queries by other search tools.