This chapter explains about caching and how it can be managed. It contains the following sections:
Oracle Identity Manager allows caching of metadata, which reduces DB activities. This results in reduced network load and improved performance.
By default, caching for most of the configurations are disabled (set to false) so that the configuration changes are reflected immediately without having to restart the application servers in the development environments.
Caching is configured in the /db/oim-config.xml configuration file, which is located in MDS. See Chapter 18, "Using Enterprise Manager for Managing Oracle Identity Manager Configuration" for information about how to make changes to this file.
Oracle recommends the following settings for the production environments for optimal and better performance.
Set the caching to true for all the components except the following two sections:
threadLocalCacheEnabled="false"
"StoredProcAPI" enabled="false"
Set clustered="false" for non-clustered installation and clustered="true" for clustered installation.
Example 26-1 shows a snippet from the /db/oim-config.xml file, with all the caching enabled for production systems.
Example 26-1 Recommended Cache Values for oim-config.xml in a Clustered Production Environment
<cacheConfig clustered="true" enabled="true" expirationTime="144000" provider="oracle.iam.platform.utils.cache.OSCacheProvider" threadLocalCacheEnabled="false"> <cacheCategoriesConfig> <cacheCategoryConfig name="DataObjectEventHandlers" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="ProcessDefinition" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="EmailDefinition" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="RuleDefinition" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="FormDefinition" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="ColumnMap" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="UserDefinedColumns" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="ObjectDefinition" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="StoredProcAPI" enabled="false" expirationTime="600"/> <cacheCategoryConfig name="NoNeedToFlush" enabled="true" expirationTime="-1"/> <cacheCategoryConfig name="MetaData" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="User" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="AdapterInformation" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="OrgnizationName" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="Reconciliation" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="SystemProperties" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="LookupDefinition" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="UserGroups" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="LookupValues" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="ITResourceKey" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="RecordExists" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="ServerProperties" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="ColumnMetaData" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="API" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="CustomResourceBundle" enabled="true" expirationTime="-1"/> <cacheCategoryConfig name="CustomDefaultBundle" enabled="true" expirationTime="-1"/> <cacheCategoryConfig name="ConnectorResourceBundle" enabled="true" expirationTime="-1"/> <cacheCategoryConfig name="LinguisticSort" enabled="true" expirationTime="-1"/> <cacheCategoryConfig name="GenericConnector" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="GenericConnectorProviders" enabled="true" expirationTime="-1"/> <cacheCategoryConfig name="AccessPolicyDefinition" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="UserConfig" enabled="true" expirationTime="-1"/> <cacheCategoryConfig name="OESDefinition" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="RoleContainerToDescrMap" enabled="true" expirationTime="-1"/> <cacheCategoryConfig name="PluginFramework" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="CallbackConfiguration" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="SchedulerTaskDefinition" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="UserStatus" enabled="true" expirationTime="14400"/> <cacheCategoryConfig name="LocaleCodeLanguageMapping" enabled="true" expirationTime="14400"/> </cacheCategoriesConfig>
If you want to purge the cache, use the PurgeCache utility in the OIM_HOME/server/bin/ directory. This utility purges all elements in the cache.
Note:
Purging is required when caching is enabled and if you make any system configuration changes. It is not required if caching is disabled.
Before running the PurgeCache utility, navigate to the OIM_HOME/server/bin/ directory.
Before running the PurgeCache utility, you must run the DOMAIN_HOME/bin/setDomainEnv.sh script.
To use the PurgeCache utility, run PurgeCache.bat CATEGORY_NAME on Microsoft Windows or PurgeCache.sh CATEGORY_NAME on UNIX. The CATEGORY_NAME argument represents the name of the category that must be purged. For example, the following commands purge all FormDefinition entries from a system and its clusters:
PurgeCache.bat FormDefinition PurgeCache.sh FormDefinition
To purge all Oracle Identity Manager categories, pass a value of "All" to the PurgeCache utility. It is recommended to clear all the categories.
Note:
The wlfullclient.jar file must be in the classpath for the PurgeCache utility to run correctly.