Cache Get

You can use the Cache Get transform to get a value from the global cache, by providing the key that is associated with the value.


The Cache Get transform accepts only input connections, which provide values for the parameters in the nested mapping.

You can assign or map only single values of type simple value to the key. If a mapped element is not of the appropriate data type, you can use the Cast type (xs:type) transform to assign the data type. If the element can contain multiple values, set the Cardinality property to ensure that a single value is mapped to the key; see Configuring the cardinality of a user-defined element.

When you add a Cache Get transform to your graphical map, a Cache Return transform is automatically included; see Cache Return. The Cache Return transform provides a single predefined input element, which contains the value from the key-value pair that is associated with the key that is mapped to the Cache Get transform. You can connect the Cache Return transform to any output element to map the data that is returned from the cache. You can also map elements from the input tree to the Cache Return transform, and connect the Cache Return transform to one or more output elements. You can then use the nested map to create or transform values and map them to the output elements that you connected to the Cache Return transform.

You can also add a Cache Failure transform to your Cache Get transform if you want to handle exceptions that might occur if the Cache Get transform fails; see Cache Failure.

For more information, see Retrieving a value from the global cache by using a Mapping node.
Note: The Cache Get transform does not have any conditional properties. To configure conditional execution, you must embed the Cache Get transform inside an If transform.


The Cache Get nested mapping has a number of parameters that you configure by mapping values or assigning fixed values. The following table describes the parameters that you can set when you use the Cache Get transform:

Parameter Mandatory Description Result if no value is configured
Key Yes The name of the key in the key-value pair that is contained in the global cache map. Error
MapName You must specify a value for this parameter if you specify a value for the CacheName parameter. The name of the global cache map that contains the key-value pair. The default map in the cache is used. If you are using the embedded cache, the default map is SYSTEM.BROKER.DEFAULTMAP.
CacheName No. But if you specify this parameter, you must also specify the MapName parameter. The name of a configurable service that specifies how to connect to the global cache. The embedded cache in the integration node is used as the cache.