Integration Server 10.3 | Built-In Services Reference Guide | Cache Folder | Summary of Elements in this Folder | pub.cache:remove
 
pub.cache:remove
WmPublic. Removes the cached element associated with the specified key.
Input Parameters
cacheManagerName
String Name of the cache manager that manages the cache. This parameter is case sensitive.
cacheName
String Name of the cache from which to remove the element. This parameter is case sensitive.
key
Object Key of the element to remove.
useWriter
String Optional. Indicates whether to use a cache writer to remove the value of the cached element from the system-of-record (SOR). Set to:
*true to use a cache writer to remove the value from the cached element and the SOR.
*false to remove the value to the cached element without using a cache writer. This is the default setting.
Output Parameters
removed
String Indicates whether the element was removed.
*true indicates that the element was removed from the cache.
*false indicates that the element was not removed from the cache.
Usage Notes
If the element associated with the specified key does not exist, pub.cache:remove returns false for removed.
Integration Server issues a ServiceException in the following cases:
*If you do not specify all required input parameters.
*If Integration Server cannot find the specified cache manager or cache.
*If a cache operation fails.