Configuring a Distributed Cache

Step

Description

If you have not already installed and configured your Terracotta Server Array, do this first. For procedures, see the product documentation for the Terracotta Server Array.

Note:

The Terracotta Server Array must be running a version of Terracotta that is compatible with the Terracotta client libraries installed on your Integration Server. To check which versions of the Terracotta Server Array are compatible with your Integration Server, see the Terracotta Compatibility with other Software AG Products on the Software AG documentation website at http://documentation.softwareag.com.

If you have not done so already, edit the tc-config file on the Terracotta Server Array and add the parameters that Integration Server requires. For procedures, see Configuring tc-config.xml on the Terracotta Server Array .

Review the points listed in Considerations for Configuring a Distributed Cache.

Verify that Integration Server is equipped with a license to use a Terracotta Server Array. For procedures, see Installing, Viewing, and Changing the Terracotta License.

Decide how much memory you will use for the on-heap portion of the cache on Integration Server and adjust the Java heap size if necessary. For information about changing the heap size used by Integration Server, see Changing the JVM Heap Size Used by Integration Server .

Note:

The size of the on-heap portion of a distributed cache must be the same on all Integration Servers that use the cache.

If the cache manager to which you want to add the cache does not already exist, create it. For information about creating a cache manager, see Creating a Cache Manager.

Note:

Be sure that the cache manager that you are using is configured to use the Terracotta Server Array.

Create the cache using the procedure in Creating a Cache. When you create the cache, be sure to do the following:

Enable the Distributed setting in the Distributed Cache Configuration section of the page.

In the Maximum Elements in Memory field, specify the number of elements that you want to maintain in the on-heap memory at the Integration Server.

In the Maximum Entries in Cache field, specify the maximum size (in number of elements) to which this cache can grow on the Terracotta Server Array.

Note:

Although Integration Server permits you to set Maximum Elements in Memory and Maximum Entries in Cache to 0, which indicates that the number of elements is restricted only by the availability of resources, Software AG strongly recommends that you always specify an upper limit in these fields. Unlimited caches grow indefinitely and can cause performance problems or system failures if they exhaust the available resources on the machine.

Verify that the parameters for the cache are set as you want them and enable the cache as described in Enabling a Cache.

If this is the first Integration Server on which you have created the distributed cache, the Integration Server creates the distributed cache on the Terracotta Server Array during this step.

If other Integration Servers will use this distributed cache, repeat steps 4 through 8 on each of them.

Note:

Instead of manually specifying the new cache on each of the other Integration Servers in step 7, you can optionally create the cache by copying the cache manager configuration file from this Integration Server to the others. You can do this by 1) using webMethods Deployer to deploy the cache manager from this Integration Server to the others or 2) manually copying the cache manager configuration file from this Integration Server to the others. For information about using webMethods Deployer, see the webMethods Deployer User’s Guide. For information about copying a cache manager configuration file to another Integration Server, see Adding a Cache Manager Configuration File to Integration Server .