Configuring the Federated Portal Cache

Applicable to: remote role assignment, remote delta link

Use

SAP NetWeaver Portal provides a dedicated caching service for the consumer portals running in a federated portal scenario. Its purpose is to reduce network traffic to the producer by storing semantic objects on the consumer-side for reuse.

This topic describes how to define consumer-side cache settings.

Note the following:

·        Once remote-based content has been cached on the consumer, any changes made to their source objects on the producer are only updated on the consumer after its cache has been updated. Cache updates occur after a scheduled synchronization, manual synchronization, or if the cache validity expires.

·        In remote delta link mode, the producer portal also caches objects to reduce the number round-trips between the producer and consumer. There are no cache settings on the producer that administrators can configure to change this behavior.

·        The settings described below are global settings; you cannot define a different configuration for each producer portal.

More information:

●      Federated Portal Caching (for general information about caching)

●      Optimizing Your Consumer Profile 

Prerequisites

●      You have access to the SAP NetWeaver Administrator tool.

●      You have access to the federated portal administration tools in the standard System Admin role on your portal.

Procedure

Configuring Content Cache Settings on the Consumer

The cache settings described here determine the size of the content cache, where the cache is stored, and the length of time objects cached. These cache settings apply to the following:

●      Runtime content that has been cached on the consumer through the use of the remote role assignment mode.

●      Content viewed through a remote Portal Catalog on a consumer portal (refers to the remote delta link mode). See Copying Remote Content to Your Consumer.

●      Specific remote delta link use cases, such as SAP transaction iViews embedded in remote delta link pages, in which case the Application Integration service retrieves properties from objects located in the Portal Content Directory (PCD) of the remote producer.

To set the size and storage location of the federated portal cache:

...

       1.      In the SAP NetWeaver Administrator tool, access the following portal application and service:

○       Portal application: com.sap.portal.ivs.global.gpcache

○       Service: FederatedPortalCache

For information about accessing and configuring portal services in the SAP NetWeaver Administrator tool, see Accessing Portal Services in SAP NetWeaver Administrator.

       2.      Define the following properties:

Property	Description
maxCacheSize	Specifies the maximum number of Java objects that can be stored in memory cache. This setting also affects the caching of system IDs (see Configuring System ID Cache Settings on the Consumer below). Do not enter zero (0) or a negative value. The default value is 10,000. When the memory cache is full, the cache starts to clear out the oldest objects.
cachePersistency	Specifies if cached objects are stored in memory cache only or in both memory cache and persistence cache (in the database). Valid values are as follows: ·        true: Cached objects are stored in both memory cache and database cache. ·        false: Cached objects are stored in memory cache only. Note that setting also affects the caching of system IDs (see below). Use of the cache persistency is mandatory if you are supporting a clustered environment. The cache persistency is useful for other purposes. For more information, see Federated Portal Caching.

       3.      Save your changes.

To set the lifetime of content cached in the federated portal cache:

...

       1.      In the portal, navigate to System Administration → Federated Portal → Myself as Content Consumer → Cache Management.

       2.      Enter the maximum cache time (in seconds) in the Cache Lifetime property.

Do not enter zero (0) or a negative value.

Set a short validity time if you know the remote content on the producer is dynamic and changes frequently over a short period of time. Set a long validity time if you know the remote content on the producer is static and undergoes few changes over a long period of time.

       3.      Click Save.

For information about manually clearing the cache before the cache lifetime has been reached, refer to Clearing and Synchronizing the Federated Portal Cache.

Configuring System ID Cache Settings on the Consumer

The cache setting described here allows you to instruct the consumer to store system IDs mapped to federated portal aliases in the cache. This setting is relevant only to remote role assignment and remote delta link usage modes.

Do not activate this cache setting if you have implemented dynamic system resolution in your portal landscape. For this reason, the cache setting is deactivated by default. More information: Dynamic System Resolution.

The benefits of caching system IDs for federated portal network implementations are:

●      Decreased number of round-trips between a producer portal and consumer portal.

●      Reduced number of sessions opened on the producer portal.

●      Improved response times and overall system performance.

To activate caching of system IDs:

...

       1.      In the SAP NetWeaver Administrator tool, access the following portal application and service:

○       Portal application: com.sap.portal.ivs.global.jndibridge

○       Service: SLGP

For information about accessing and configuring portal services in the SAP NetWeaver Administrator tool, see Accessing Portal Services in SAP NetWeaver Administrator.

       2.      Set the SaveSystemIDAtCache property to true (set to false to deactivate caching).

       3.      Save your changes.

       4.      Restart the service

More information: Starting and Stopping Portal Services

To set the size, location, and lifetime of system ID caching:

...

       1.      In the SAP NetWeaver Administrator tool, access the following portal application and service:

○       Portal application: com.sap.portal.ivs.global.gpcache

○       Service: FederatedPortalCache

       2.      Define the following properties:

Property	Description
maxCacheSize	See description above for caching of content.
cachePersistency	See description above for caching of content.
maxValidityPeriodInSec	Specifies the maximum cache time (in seconds). Default value (seconds): 100,000

Setting the Synchronization Interval of Remote Delta Links Content

The cache settings in the OriginalContentSynConsumerService service define the frequency with which remote delta link content on the producer is updated when modifications are made to the source objects on a producer portal.

By default, the producer portal automatically updates content modifications made to source objects with their corresponding target delta link objects on the consumer portal once every 24 hours. A system administrator on the consumer can do the following:

●      Change the default interval at which remote delta link content is updated on the consumer portal (see below for instructions).

●      Manually synchronize remote delta link content with their corresponding source objects (see Clearing and Synchronizing the Federated Portal Cache for instructions).

An administrator on the producer portal cannot initiate a content update with its registered consumer portals. It can only be initiated from the consumer portal.

§         Synchronization can be a very time consuming process, especially if you are consuming large amounts of remote delta link content.

§         After synchronizing the cache, portal users must restart any live portal sessions to receive the latest updates.

To change the interval of automated remote delta link content synchronization:

...

       1.      In the SAP NetWeaver Administrator tool, access the following portal application and service:

○       Portal application: com.sap.portal.fpn.contentmanagement 

○       Service: OriginalContentSynConsumerService 

For information about accessing and configuring portal services in the SAP NetWeaver Administrator tool, see Accessing Portal Services in SAP NetWeaver Administrator.

       2.      In the sampleDelayMinutes property, enter the time delay in minutes from when the server starts up to when the first automatic synchronization takes place. The default value is 1,440 minutes (= 24 hours).

Enter a positive value only.

       3.      In the sampleRateMinutes property, enter the synchronization interval in minutes. The default value is 1,440 minutes (= 24 hours).

To turn off the automatic synchronization, enter 0 or -1.

       4.      Save your changes.