Configure the Portlet Cache

Portal Services can cache the portlet markup fragments that are used to quickly regenerate recent views of the portlets in pages. These markup fragments are compressed and stored on the server computer as part of the session object.

The basic cache unit represents markup fragments created per page, per one user session. The portlet markup is not always cached. Disabling markup caching saves memory usage, but has a negative impact on performance.

Use the following parameters to control the use of the portlet cache at run-time:

  • CPSMaxCacheSizePerPortlet

    Specifies the number of markup fragments cached for each portlet, per page, per user. For example, a value of 5 with 1000 users, 10 pages, and 4 portlets per page can generate a maximum of 200000 entries in the cache (1000 x 10 x 4 x 5).

    This parameter can have the following values:

    Parameter

    Value

    -1 (default)

    Saves unlimited number of portlet markups

    0

    Disables markup caching

    1 or an integer greater than 1

    Limits the number of markups to a specified number

    You must provide run-time values for this parameter for every application server that runs the presentation service.

  • properties.config.cps.cache.timeToIdleSeconds

    Specifies the length of time, in seconds, to keep the page markup fragments in the cache during a period of inactivity. If the page is not accessed during that time, its cache contents are deleted.

    The default value is 1800 (30 minutes).

  • properties.config.cps.cache.timeToLiveSeconds

    Specifies the length of time, in seconds, to keep the page markup fragments in the cache. After this time, the markup is deleted even if the cache is still active.

    The default value is 86400 (24 hours).

  • properties.config.cps.cache.checkExpiryIntervalSeconds

    Specifies the length of time, in seconds, that represents the frequency with which the system checks for expired markup fragments in the cache.

    The default value is 300 (5 minutes).

To enable or disable encryption of the portlet markup fragments, use the parameter encryptTemporaryFiles of the Environment category in IBM® Cognos® Configuration. For more information, see the IBM Cognos Installation and Configuration Guide.

Procedure

  1. In IBM Cognos Connection, click Launch, IBM Cognos Administration.
  2. On the Configuration tab, click Dispatchers and Services.
  3. Click the dispatcher you want.
  4. For PresentationService, click the set properties button.
  5. Click the Settings tab.
  6. For the Environment category, next to Advanced settings, click the Edit link.
  7. If it appears, select the Override the settings acquired from the parent entry check box. Otherwise, proceed to the next step.
  8. In the Parameter column, type the required parameter specified in this section. For example, type CPSMaxCacheSizePerPortlet.
  9. In the Value column, type the required value for the parameter.
  10. Click OK.
  11. Click OK again.
  12. Click the Configuration link in the path at the top of the page.

    You return to the list of dispatchers.

  13. If you have more than one dispatcher configured, perform steps 3 to 12 for each remaining dispatcher.
  14. Restart the IBM Cognos service.
Parent topic: Portlets