---

Macro Compatibility

---

Usage

Only supports HTML input / output files (and not Report Studio).

---

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
file	String	Deprecated	fileName		The file path and name. Files must be located in the Schedule's input folder (or its sub-folders), i.e. it is not possible to specify a file that exists in any other folder, or the library folder.	N/A	N/A
fileName	String	Use instead of: file		Mandatory	The file path and name. Files must be located in the Schedule's input folder (or its sub-folders), i.e. it is not possible to specify a file that exists in any other folder, or the library folder.	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 (3)

Example 1:

[File.Insert: fileName="demo.svg"]

---

Example 2:

[File.Insert: fileName="subfolder/demo.svg"]

---

Example 3:

Conditionally insert the file, only when 1 is less than 3 (in this case it succeeds):

[File.Insert: fileName="demo.svg", if=`1 < 3`]