Enabling browser caching to improve web Process Designer performance

In IBM BPM, there are two settings that control whether browser caching is enabled for resources in the snapshots of toolkits. When browser caching is enabled, it reduces the number of network calls for resources that are needed by editors. This improves the scalability of the editor and enhances performance. To override the default value for these settings, you can use the updateBPMConfig command to add or modify the settings in the 100Custom.xml file.

About this task

The following settings control whether browser caching is enabled for resources in toolkits:

enable-browser-cache-for-snapshot: Specifies whether the browser cache is enabled for snapshots of all toolkits. The default value is false. This setting should only be set to true when your client machine is single-user and secured or the content of your toolkits does not contain sensitive personal data or confidential data. Note that by enabling browser-side caching, users might see toolkit contents in a shared-browser environment even though they do not have access permission to the toolkit.
enable-browser-cache-for-system: Specifies whether the browser cache is enabled for the snapshots of system toolkits. The default value is false. If the enable-browser-cache-for-snapshot setting is set to true, caching of snapshots of system toolkits is also enabled and changing the enable-browser-cache-for-system setting to false has no effect.

If you want to change the value for one or both settings, you can override the value by adding or updating the settings in your 100Custom.xml files. For example, to add the settings to a 100Custom.xml file, you would add the following elements under the <properties> element and modify the values as needed:

<web-pd>
   <enable-browser-cache-for-snapshot merge="replace">false</enable-browser-cache-for-snapshot>    
   <enable-browser-cache-for-system merge="replace">true</enable-browser-cache-for-system>
</web-pd>

For information about the individual 100Custom.xml files that need to be updated and their locations, see the topic Location of configuration files.

However, to consistently and reliably change the value of the two settings in all of the 100Custom.xml files in your IBM® BPM deployment environment, it is recommended that you use the updateBPMConfig command as described in the following procedure:

Procedure

Stop the servers for Process Server and Process Center.
Start the scripting client in disconnected mode as described in the topic updateBPMConfig command.

Run the following commands to simultaneously update all affected servers:

wsadmin> AdminTask.updateBPMConfig( [ '-create', '/web-pd' ] )
wsadmin> AdminTask.updateBPMConfig( [ '-create', '/web-pd/enable-browser-cache-for-snapshot', '-xNodeValue', 'true_or_false' ] )
wsadmin> AdminTask.updateBPMConfig( [ '-create', '/web-pd/enable-browser-cache-for-system', '-xNodeValue', true_or_false ] )
wsadmin> AdminConfig.save()

Replace the true_or_false variable with either true or false.

Restart the servers.

Results

The recommended way of updating the 100Custom.xml files is by running the updateBPMConfig command. However, if the updates are unsuccessful, you can manually update the files by following the steps in the topic Setting configuration properties using 100Custom.xml.