---

Purpose

Sets a cache value for the given scope. Globally-scoped cached values are available to all Schedules. Locally-scoped variables are only available to this Schedule. For more information on using caches, click here.

---

Macro Compatibility

---

Parameter	Type	Presence	Purpose	Options	Default
expires	DateTimeOffset	Mandatory	The expiry date-time in UTC.	N/A	N/A
key	String	Mandatory	The key.	N/A	N/A
scope	CachedValueScope	Mandatory	The scope, determining whether only this report schedule can get the value, or whether it is available to all reports.	Global Local	N/A
value	String	Mandatory	The value.	N/A	N/A
comment	String	Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
failureText	String	Optional	The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message.	N/A	N/A
if	String	Optional	The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z').	N/A	true
mode	MacroMode	Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
obfuscation	ObfuscationType	Optional	Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen.	None UkTown DeviceName Company IpAddress PrivateIpAddress	None
warning	String	Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A

---

Examples (1)

Example 1:

[Cache.Set: key=abc, value=def, scope=Global, expires=2026-07-10][Cache.Unset: key=abc][Cache.IsSet: key=abc]

Outputs:

false