Remove Key From Cache

Updated on 19 Mar 2025
1 Minute to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Step Details
Introduced in Version	4.0.0
Last Modified in Version	9.6.0
Location	System > Caching

The Remove Key From Cache step removes a user-specified Key from a specified Cache location. To use this step, select an option from the TypeName drop-down to determine what type of Cache is being evaluated. Then input the Cache Instance Name and Cache Type Name to determine which Cache the Key is being removed from. Lastly, the Key Input defines which Key is removed from the Cache. Running the step will remove the designated Key from the specified Cache.

In newer versions the Cache Name and Definition is established at the Project level.

Properties (v9.6+)

Cache

Property	Description	Data Type
Cache Name	Project level cache instances.	---
Selected Cache Definition	Displays the definition of the chosen cache instance.	---
Item Type	Data type of the items to be added to the list.	---
Select Cache at Runtime	Runtime selecting a cache is an advanced action and may create problems if the cache selected is not valid. Instead of this feature, we recommend using multiple cache steps with paths to each so that the configuration of your process is very clear.	Boolean

Inputs

Property	Description	Data Type
Key	The key of the object to be removed from the Cache.	String

Properties (prior to v9.6)

Cache Setup

Property	Description	Data Type
Type Name	Select the Data type of the cache value.	---

Settings

Property	Description	Data Type
Get Cache Type at Runtime	Set whether the Cache Type Name can be selected at Runtime or Design Time.	Boolean
Cache Type	Pick the cache type. This is established in System > Administration > Cache.	---

Inputs

Property	Description	Data Type
Cache Instance Name	Define the name that will be associated with this cache.	String
Key	The value by which the cache was accessible. The Key to remove from the Cache.	String