Improving Data Mapper Performance with Caching

Omnistudio also offers Metadata Cache, which is for internal use only. It’s not configurable by users. It stores Omnistudio component metadata or definitions, and not the actual data. You can configure the data to remain in the cache (time to live) for a maximum of 48 to 72 hours.

Omnistudio caches two different types of content:

• Metadata: The definition that includes the structure and configuration of Integration Procedures and Data Mappers, such as steps, mappings, and formulas. This is stored in Metadata Cache and is used to improve load times.
• Data: The response of a Data Mapper or an Integration Procedure that is cached in the Session Cache or Org Cache. Every time, when the same request input is entered or provided, the cached data is returned.

Types of data cache in Data Mappers include:

• Org Cache: The cached data is shared among all users in the same org. The org cache is recommended only if the data is non-sensitive or not user-specific. For example, picklists, configurations, or object data without any access restrictions. You can configure the data to remain in the cache (time to live) for a maximum of 48 hours.
  

  Important

  Use org cache only for non-sensitive data.

• Session Cache: It stores user-specific data and is limited to active user sessions. It is safer for personalized data and helps reduce redundant processing for data that varies by user profile or permissions. You can configure the data to remain in the cache (time to live) for a maximum of 8 hours.

You can use caching with Data Mappers in three ways:

• Data Mapper metadata is automatically cached. If you use the Scale Cache, this automatic caching occurs unless you turn off the Scale Cache. If you use the Platform Cache, you must allocate space in the VlocityMetadata cache partition to enable this automatic caching.

• You can configure data caching on the Options tab of Data Mapper Extracts, Turbo Extracts, and Transforms.

• If you call a Data Mapper from an Integration Procedure that uses caching, the Data Mapper data is cached along with the Integration Procedure data.

You can also perform a record-level security check for cached data. See Security for Omnistudio Data Mappers and Integration Procedures.

Methods to Clear Metadata from Data Mapper Cache

You can clear metadata from the cache for a Data Mapper or all Data Mappers at once.

1. Go to the Developer Console.
2. Click the user menu and select Developer Console from the menu.
3. Select Debug | Open Execute Anonymous Window.
4. To clear metadata cache for a Data Mapper, in the Apex code window, execute this code:

   ConnectApi.DatamapperCacheInputParamRepresentation finalInput = new ConnectApi.DatamapperCacheInputParamRepresentation();
   ConnectApi.DataMapperParamRepresentation param = new ConnectApi.DataMapperParamRepresentation();
   param.dataMapperName = 'DataMapperName';
   finalInput.dataMapperList = new List<ConnectApi.DataMapperParamRepresentation>();
   finalInput.dataMapperList.add(param);
   finalInput.cacheStorageType = ConnectApi.CacheStorageType.Metadata;
   ConnectApi.DatamapperClearCacheOutputRepresentation response = ConnectApi.OmniDesignerConnect.clearDatamapperCache(finalInput);

   

   Note Starting with Summer ‘25, replace the namespace.DRGlobal.clearCacheForDataRaptor('DataMapperName') method with this Connect API.
5. To clear the metadata cache for all Data Mappers, in the Apex code window, execute this code:

   ConnectApi.DatamapperCacheInputParamRepresentation finalInput = new ConnectApi.DatamapperCacheInputParamRepresentation();
   finalInput.cacheStorageType = ConnectApi.CacheStorageType.Metadata;
   ConnectApi.DatamapperClearCacheOutputRepresentation response = ConnectApi.OmniDesignerConnect.clearDatamapperCache(finalInput);

   

   Note Starting with Summer ‘25, replace the namespace.DRGlobal.clearCacheForAllDataRaptor() method with the Connect API to clear cache for all Data Mappers.