Cache Remove

You can use the Cache Remove transform to remove a key-value pair from the global cache.

Overview

The Cache Remove 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.

You can add a Cache Return transform to your Cache Remove transform group if you want to perform some mapping after a successful Cache Remove transform. The Cache Remove transform provides the value of the entry that has been removed. You can then map this value in the Cache Return transform; see Cache Return.

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

For more information, see Removing a key-value pair from the global cache by using a Mapping node.

Note: The Cache Remove transform does not have any conditional properties. To configure conditional execution, you must embed the Cache Remove transform inside an If transform.

Parameters

The Cache Remove 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 Remove 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.