---

Macro Compatibility

---

Usage

See dedicated help page.

---

Parameter	Type	Presence	Purpose	Options	Default
type	AgentRequestType	Mandatory	The requestType	Sql Powershell GroovyScript CSharp Internal Postgres MonitorMagic WebQuery	N/A
code	String	Conditional	The code to execute. You must provide either this or fileName.	N/A	N/A
fileName	String	Conditional	The file to execute. You must provide either this or code.	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
connectionName	String	Optional	The name of the Connection.	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
logLevel	AgentLogLevel	Optional	The level above which output is logged. See also the OutputLog and StoreLogAs parameters.	Information Debug Warning Error None	Information
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
outputLog	Boolean	Optional	Whether to output the log to the output document.	true false	false
serverType	SystemAccess.ServerType	Optional	The type of server.	Mssql None Postgres	Mssql
storeLogAs	String	Optional	The variable to put the log into as a list of strings.	N/A	N/A
timeoutMs	Int32	Optional	The timeout in milliseconds.	From 1000 to 2147483647	60000
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:

Use the report variable 'a', add 5 and return it as 'b'

[String: value="5", =>a]
[Agent.Execute: type=CSharp, code=`public static void Main(Context context) { context["b"] = int.Parse(context["a"].ToString()) + 5; }`]