IDOL View Component 24.4
IDOL View Component Help

# Configure the View Cache

When the View service converts a document to HTML, it caches the results. If it receives a request for the same document again, it retrieves the version from the cache, rather than converting it again.

You can use an internal View cache, or you can cache documents on a memcached server instance. For details about memcached servers, refer to http://memcached.org.

You can also share a cache between multiple View services.

## Configure the Internal View Cache

By default, the View service uses an internal cache, stored on disk. You can configure how this cache behaves.

To configure the internal View cache

1. Open the IDOL View component configuration file in a text editor.

2. In the `[Viewing]` section, set CacheType to `Internal`. For example:

       CacheType=Internal

3. In the `[Viewing]` section, set CacheExpirySeconds to the length of time (in seconds) that you want to keep the cache. Use a large value to ensure that the View service does not have to regularly convert the same documents. For example:

       CacheExpirySeconds=604800

4. In the `[Paths]` section, set ViewCacheDirectory to the directory in which you want the View service to store the cache. The View service must have write access to this directory. For example:

       ViewCacheDirectory=C:\IDOL\IDOLServer\IDOL\view\Cache

5. Save and close the configuration file.

6. Restart the IDOL View component for your changes to take effect.

## Use a Memcached Server View Cache

The View service can store cache documents in a memcached server instance.

NOTE: By default, the memcached program has a maximum entry size limit of 1 megabyte, so it cannot process files bigger than 1 megabyte.

To configure View to use a memcached cache

1. Open the IDOL View component configuration file in a text editor.

2. Find the `[Viewing]` section.

3. Set CacheType to `Memcached`. For example:

       CacheType=Memcached

4. Set CacheServers to a comma-separated list of `host:port` pairs, where:

   `host` | is the host name or IP address of the memcached server.
   `port` | is the port that View must use to contact the memcached server.

   For example:

       CacheServers=localhost:11211,cacheserver:21532

5. Save and close the configuration file.

6. Restart the IDOL View component for your changes to take effect.

## Use a Shared View Cache

You can share a View cache between multiple IDOL View component. To use a shared cache, you must have a memcached server instance that each IDOL View component can access. This memcached server stores information about where to find the converted cache documents, so that each IDOL View component can retrieve them.

When you use a shared cache, the `ResetCache` action and automatic cache expiration are unavailable. The CacheExpirySeconds parameter specifies only how often to delete old, duplicate job files, but it does not automatically delete the newest instance of a job.

To use a shared View cache

1. Open the IDOL View component configuration file in a text editor.

2. Find the `[Viewing]` section.

3. Set CacheType to `Internal`. For example:

       CacheType=Internal

4. Set SharedCache to `True`. For example:

       SharedCache=True

5. Set CacheServers to a comma-separated list of `host:port` pairs, where:

   `host` | is the host name or IP address of the memcached server.
   `port` | is the port that View must use to contact the memcached server.

6. In the `[Paths]` section, set ViewCacheDirectory to the directory to use to store the cache. For example:

       ViewCacheDirectory=C:\View\Cache

7. Save and close the configuration file.

8. Restart the IDOL View component for your changes to take effect.

9. Repeat Step 1 to Step 7 for each IDOL View component that must share the cache.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL IDOL View Component 24.4

Topic Title: Configure the View Cache