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 (general information)

●      Optimizing Your Consumer Profile 

Prerequisites

●      You have access to the Service Configuration Editor.

●      You have permission in the portal to edit the com.sap.portal.ivs.global.gpcache application.

●      You have permission in the portal to edit the com.sap.portal.ivs.global.jndibridge application.

●      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:

●      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 consumer portal, navigate to System Administration → System Configuration → Service Configuration.

       2.      Navigate to the com.sap.portal.ivs.global.gpcache application.

       3.      Edit the FederatedPortalCache service.

       4.      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. 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. Note that setting also affects the caching of system IDs (see below).

       5.      Save and close the service.

       6.      Open the com.sap.portal.ivs.global.gpcache application and restart its services.

       7.      Close the editor.

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 a value in the Cache Lifetime property (in seconds).

Do not enter zero 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.

This rule of thumb also applies to the Cache Lifetime setting.

       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 roundtrips 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 the caching of system IDs:

...

       1.      In the consumer portal, navigate to System Administration → System Configuration → Service Configuration.

       2.      Navigate to the com.sap.portal.ivs.global.jndibridge application.

       3.      Edit the SLGP service.

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

       5.      Save and close the service.

       6.      Open the com.sap.portal.ivs.global.jndibridge application and restart its services.

       7.      Close the editor.

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

...

       1.      In the consumer portal, navigate to System Administration → System Configuration → Service Configuration.

       2.      Navigate to the com.sap.portal.ivs.global.gpcache application.

       3.      Edit the FederatedPortalCache service.

       4.      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 If you prefer the Portal Runtime (PRT) to control the cache validity for FPN-related content, set the maxValidityPeriodInSec to -1. The cache validity period defined by the PRT is then solely determined by the product of two PRT property values: caching.persistency.clean.period * caching.persistency.infinite.validity.clean.period.factor. The default value is 12 hours (from 5 min * 144 min). For more information, see Configuring the Portal Runtime.

       5.      Save and close the service.

       6.      Open thecom.sap.portal.ivs.global.gpcache application and restart its services.

       7.      Close the editor.

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 (refer to 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 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 set the interval of automated remote delta link content synchronization:

...

...

       1.      In the consumer portal, navigate to System Administration → System Configuration → Service Configuration.

       2.      Navigate to the com.sap.portal.fpn.rdl application.

       3.      Edit the OriginalContentSynConsumerService service.

       4.      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.

       5.      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.

       6.      Save and close the service.

       7.      Open the com.sap.portal.fpn.rdl application and restart its services.

       8.      Close the editor.

To set the cleanup interval of unresolved remote delta links on the consumer:

After content has been synchronized between a producer portal and a consumer portal, any source content that has been removed from a producer portal may result in corresponding unresolved remote delta links on a consumer portal.

If you replace the removed source content on the producer portal with new content that has the same object ID, functionality of the remote delta links on the consumer portal is restored. You can however, instruct the portal to delete the unresolved remote delta links if they have exceeded a predefined period of time. Doing so prevents unresolved content from congesting the Portal Content Directory (PCD) over time.

...

       1.      In the consumer portal, navigate to System Administration → System Configuration → Service Configuration.

       2.      Navigate to the com.sap.portal.fpn.rdl application.

       3.      Edit the OriginalContentSynConsumerService service.

       4.      In the UnresolvedKeepDays property, enter the maximum time period (in days) to keep a content object that is tagged as an unresolved remote delta link on the consumer portal. The default value is 365 days.

■       Enter a positive value only.

■       Enter 0 to delete unresolved remote delta link content immediately.

       5.      In the UnresolvedCleanupSampleRateMinutes property, enter the time interval (in minutes) at which the consumer portal checks if the source object of content, already tagged as an unresolved delta remote link, has been restored on the producer portal. The default value is 1,440 minutes (24 hours).

■       Enter a value equal to or higher than -1. Note that the lower the value, the greater the negative impact is on system performance.

■       Enter0 or  -1 to disable the deletion of unresolved remote delta links.

If after an unresolved remote delta link check has run and any unresolved content has exceeded the maximum keep time, then the content is permanently deleted from the consumer portal.

       6.      Save and close the service.

       7.      Open the com.sap.portal.fpn.rdl application and restart its services.

       8.      Close the editor.