---

Purpose

Uses Regular Expressions to extract strings from other strings. Match groups are stored delimiter-separated. Within each match group, individual entries are stored carat-separated. The "g" modifier, as used in Javascript and Perl languages is always applied to obtain multiple regex groups. Search the web for 'online regex tools' for practical assistance in constructing regular expressions.

---

Macro Compatibility

---

Parameter	Type	Presence	Purpose	Options	Default
pattern	String	Mandatory	The regular expression pattern.	N/A	N/A
value	String	Mandatory	The string value.	N/A	N/A
calculate	String	Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
colorTableCell	Boolean	Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
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
criticalAfter	DateTimeOffset	Optional	The macro is considered 'critical' if the output is after this DateTime UTC.	N/A	N/A
criticalBefore	DateTimeOffset	Optional	The macro is considered 'critical' if the output is before this DateTime UTC.	N/A	N/A
criticalEq	String	Optional	The macro is considered 'critical' if the output is equal to this value.	N/A	N/A
criticalFontBackgroundColor	Color	Optional	The critical font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
criticalFontColor	Color	Optional	The critical font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontSize	Double	Optional	Change the critical font size in points. If omitted, no change is made.	From 2 to 200	N/A
criticalGe	String	Optional	The macro is considered 'critical' if the output is greater than or equal to this value.	N/A	N/A
criticalGt	String	Optional	The macro is considered 'critical' if the output is greater than this value.	N/A	N/A
criticalIf	String	Optional	The macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
criticalLe	String	Optional	The macro is considered 'critical' if the output is less than or equal to this value.	N/A	N/A
criticalLt	String	Optional	The macro is considered 'critical' if the output is less than this value.	N/A	N/A
criticalNe	String	Optional	The macro is considered 'critical' if the output is not equal to this value.	N/A	N/A
criticalTableCellBackgroundColor	Color	Optional	The critical table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
delimiter	Char	Optional	When using selectDistinct or find/replaceWith or regexFind/regexReplaceWith, this specifies the delimiter character.	N/A	;
emitSingleMatch	Boolean	Optional	Whether to emit a single match.	true false	false
emitSingleMatchGroup	Boolean	Optional	Whether to emit a single match group.	true false	false
errorAfter	DateTimeOffset	Optional	The macro is considered 'error' if the output is after this DateTime UTC.	N/A	N/A
errorBefore	DateTimeOffset	Optional	The macro is considered 'error' if the output is before this DateTime UTC.	N/A	N/A
errorEq	String	Optional	The macro is considered 'error' if the output is equal to this value.	N/A	N/A
errorFontBackgroundColor	Color	Optional	The error font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontBold	Boolean	Optional	Change the error font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
errorFontColor	Color	Optional	The error font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontSize	Double	Optional	Change the error font size in points. If omitted, no change is made.	From 2 to 200	N/A
errorGe	String	Optional	The macro is considered 'error' if the output is greater than or equal to this value.	N/A	N/A
errorGt	String	Optional	The macro is considered 'error' if the output is greater than this value.	N/A	N/A
errorIf	String	Optional	The macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
errorLe	String	Optional	The macro is considered 'error' if the output is less than or equal to this value.	N/A	N/A
errorLt	String	Optional	The macro is considered 'error' if the output is less than this value.	N/A	N/A
errorNe	String	Optional	The macro is considered 'error' if the output is not equal to this value.	N/A	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
errorTableCellBackgroundColor	Color	Optional	The error table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
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
fatalAfter	DateTimeOffset	Optional	The macro is considered 'fatal' if the output is after this DateTime UTC.	N/A	N/A
fatalBefore	DateTimeOffset	Optional	The macro is considered 'fatal' if the output is before this DateTime UTC.	N/A	N/A
fatalEq	String	Optional	The macro is considered 'fatal' if the output is equal to this value.	N/A	N/A
fatalFontBackgroundColor	Color	Optional	The fatal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontBold	Boolean	Optional	Change the fatal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fatalFontColor	Color	Optional	The fatal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontSize	Double	Optional	Change the fatal font size in points. If omitted, no change is made.	From 2 to 200	N/A
fatalGe	String	Optional	The macro is considered 'fatal' if the output is greater than or equal to this value.	N/A	N/A
fatalGt	String	Optional	The macro is considered 'fatal' if the output is greater than this value.	N/A	N/A
fatalIf	String	Optional	The macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
fatalLe	String	Optional	The macro is considered 'fatal' if the output is less than or equal to this value.	N/A	N/A
fatalLt	String	Optional	The macro is considered 'fatal' if the output is less than this value.	N/A	N/A
fatalNe	String	Optional	The macro is considered 'fatal' if the output is not equal to this value.	N/A	N/A
fatalTableCellBackgroundColor	Color	Optional	The fatal table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
find	List<String>	Optional	The string value(s) to find in the value.	N/A	N/A
fontBackgroundColor	Color	Optional	The font background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fontColor	Color	Optional	The font color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontSize	Double	Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A
format	String	Optional	The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings.	N/A	N/A
hidden	Boolean	Optional	Whether to hide the macro output.	true false	false
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
infoAfter	DateTimeOffset	Optional	The macro is considered 'info' if the output is after this DateTime UTC.	N/A	N/A
infoBefore	DateTimeOffset	Optional	The macro is considered 'info' if the output is before this DateTime UTC.	N/A	N/A
infoEq	String	Optional	The macro is considered 'info' if the output is equal to this value.	N/A	N/A
infoFontBackgroundColor	Color	Optional	The info font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontBold	Boolean	Optional	Change the info font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
infoFontColor	Color	Optional	The info font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontSize	Double	Optional	Change the info font size in points. If omitted, no change is made.	From 2 to 200	N/A
infoGe	String	Optional	The macro is considered 'info' if the output is greater than or equal to this value.	N/A	N/A
infoGt	String	Optional	The macro is considered 'info' if the output is greater than this value.	N/A	N/A
infoIf	String	Optional	The macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
infoLe	String	Optional	The macro is considered 'info' if the output is less than or equal to this value.	N/A	N/A
infoLt	String	Optional	The macro is considered 'info' if the output is less than this value.	N/A	N/A
infoNe	String	Optional	The macro is considered 'info' if the output is not equal to this value.	N/A	N/A
infoTableCellBackgroundColor	Color	Optional	The info table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
listDelimiter	Char	Optional	In Legacy Mode the delimiter character to use between multiple outer items in the output.	N/A	;
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
modifiers	String	Optional	The regular expression modifiers (currently, only the "i" modifier is supported to perform case-insensitive matching)	N/A	N/A
normalFontBackgroundColor	Color	Optional	The normal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontBold	Boolean	Optional	Change the normal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
normalFontColor	Color	Optional	The normal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontSize	Double	Optional	Change the normal font size in points. If omitted, no change is made.	From 2 to 200	N/A
normalTableCellBackgroundColor	Color	Optional	The normal table cell background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
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
outputListsAsJarray Normal mode	Boolean	Optional	Any macros that output lists can optionally (in Normal mode) output a jArray instead.	true false	true
propertyDelimiter	Char	Optional	In Legacy Mode the delimiter character to use between multiple inner items in the output.	N/A	^
redact	Boolean	Optional	Whether substituted variables are hidden from macro results (and the word 'REDACTED' will appear in progress screens and elsewhere in the web UI).	true false	false
regexFind	List<String>	Optional	The Regex pattern(s) to find in the value.	N/A	N/A
regexReplaceWith	List<String>	Optional	The Regex string value(s) to use to replace the string specified in the regexFind parameter. Ignored if the regexFind parameter is not specified. Mandatory if the regexFind parameter is specified and the number of replacements must match the number of regexFinds.	N/A	N/A
replaceWith	List<String>	Optional	The string value(s) to use to replace the string specified in the find parameter. Ignored if the find parameter is not specified. Mandatory if the find parameter is specified and the number of replacements must match the number of finds.	N/A	N/A
selectDistinct	Boolean	Optional	Whether to select distinct values in a string list.	true false	false
singleValueList Normal mode	Boolean	Optional	In Normal Mode and for macros that output JArrays only, whether to convert a JArray of single-property jObjects into a flat JArray of values.	true false	false
storeAs	String	Optional	The variable to store the result as.	N/A	N/A
storeAsHidden	String	Optional	The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'.	N/A	N/A
storeAsVariableDelimiter	Char	Optional	The delimiter used by storeAs to split the input (Legacy mode only), when there are multiple stored variables. For example, in this macro, we indicate that the value to be stored should be split by the asterisk when being stored: [String:value=a*b*c*d, storeAs=var1;var2;var3;var4, storeAsVariableDelimiter=*]	N/A	;
storeFormattedValueAs	String	Optional	The name of the STRING variable to store the result as and output (both will use the same format) into the report. Note that if you also use 'storeAsHidden' in the same macro, you should not expect the output to be hidden, as this parameter overrides that.	N/A	N/A
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
warningAfter	DateTimeOffset	Optional	The macro is considered 'warning' if the output is after this DateTime UTC.	N/A	N/A
warningBefore	DateTimeOffset	Optional	The macro is considered 'warning' if the output is before this DateTime UTC.	N/A	N/A
warningEq	String	Optional	The macro is considered 'warning' if the output is equal to this value.	N/A	N/A
warningFontBackgroundColor	Color	Optional	The warning font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontBold	Boolean	Optional	Change the warning font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
warningFontColor	Color	Optional	The warning font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontSize	Double	Optional	Change the warning font size in points. If omitted, no change is made.	From 2 to 200	N/A
warningGe	String	Optional	The macro is considered 'warning' if the output is greater than or equal to this value.	N/A	N/A
warningGt	String	Optional	The macro is considered 'warning' if the output is greater than this value.	N/A	N/A
warningIf	String	Optional	The macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
warningLe	String	Optional	The macro is considered 'warning' if the output is less than or equal to this value.	N/A	N/A
warningLt	String	Optional	The macro is considered 'warning' if the output is less than this value.	N/A	N/A
warningNe	String	Optional	The macro is considered 'warning' if the output is not equal to this value.	N/A	N/A
warningTableCellBackgroundColor	Color	Optional	The warning table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A

---

Examples (10)

Example 1:

A single group.

[Regex: value=abcd, pattern=(abcd), =>Output1]

Outputs:

[ [ "abcd" ] ]

---

Example 2:

Outputs a single group and match group.

[Regex: value=abcd, pattern=(abcd),emitSingleMatch=true, emitSingleMatchGroup=true, =>Output2]

Outputs:

abcd

---

Example 3:

Multiple matches and match groups.

[Regex: value=abc1abc2, pattern=(ab)(c\d), =>Output3]

Outputs:

[ [ "ab", "c1" ], [ "ab", "c1" ] ]

---

Example 4:

Multiple matches and match groups in legacy mode.

[Regex: value=abc1abc2, pattern=(ab)(c\d), mode=legacy, =>Output4]

Outputs:

ab^c1;ab^c2

---

Example 5:

A single match group:

[Regex: value=abcd, pattern=(abcd), emitSingleMatchGroup=true, =>Output5]

Outputs:

[ "abcd" ]

---

Example 6:

Two groups:

[Regex: value=abcd, pattern=(ab)(cd), =>Output6]

Outputs:

[ ["ab", "cd" ] ]

---

Example 7:

Two groups:

[Regex: value=abcd, pattern=(ab)(cd), emitSingleMatch=true, =>Output7]

Outputs:

[ "ab", "cd" ]

---

Example 8:

A single group. Using square brackets requires quotes around the pattern parameter:

[Regex: value=abcd, pattern="([^-]+)", =>Output8]

Outputs:

[ [ "abcd" ] ]

---

Example 9:

Two groups with greedy matching. Using square brackets requires quotes around the pattern parameter:

[Regex: value=abcd, pattern="([^-]+)([^-]+)", =>Output9]

Outputs:

[ [ "abc", "d" ] ]

---

Example 10:

Outputs a single group, then uses the 'calculate' parameter to convert the output to uppercase:

[Regex: value=abcd, emitSingleMatch=true, emitSingleMatchGroup=true, pattern=(abcd), calculate=toUpper(value), =>Output10]

Outputs:

ABCD