ReportMagic

[SearchAndReplace:]

A global "Search and Replace" function

Purpose

Performs a case-sensitive "Search and Replace". Can be global (default) or can be limited to just the previous table. As with other macros, these are run in the order they appear in the template, so may affect each other. Note that the contents of the report at the time the macro is run are considered.

Compatibility

The macro can be used in all input document types and in Report Studio.

Parameters (15)

Grouped View

Mandatory (2)

Parameter	Type	Purpose	Options	Default
find	String	Text to find. Must be specified and cannot be empty.	N/A	N/A
replaceWith	String	Text to replace it with. Must be specified, but may be empty. To replace text with a double quote ("), use DOUBLEQUOTE.	N/A	N/A

Behaviour (5)

Parameter	Type	Presence	Purpose	Options	Default
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
if	String	Optional	An optional condition that must be true in order for the macro to execute. See [If:] macro for more information.	N/A	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 theObject, 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

Filtering & Sorting (2)

Parameter	Type	Presence	Purpose	Options	Default
find	String	Mandatory	Text to find. Must be specified and cannot be empty.	N/A	N/A
replaceWith	String	Mandatory	Text to replace it with. Must be specified, but may be empty. To replace text with a double quote ("), use DOUBLEQUOTE.	N/A	N/A

Output (2)

Parameter	Type	Presence	Purpose	Options	Default
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
failureVariable	String	Optional	The name of a variable to create should the macro fail to execute. The variable will be a text variable, and will contain either the failure text (only if the failureText parameter is set), otherwise it will contain the exception / failure message.	N/A	N/A

General (1)4 additional

Parameter	Type	Presence	Purpose	Options	Default
scope	String	Optional	Whether to search and replace in the entire document or just the previous table	document previousTable	document

Additional (4)

Parameter	Type	Presence	Purpose	Options	Default
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
desiredExecutionResult	List<ExecutionResult>	Optional	If specified, asserts the expected execution result of the macro. Accepts a single value or a semicolon-separated list of acceptable values (e.g. 'Success;Warning'). The macro executes normally; if the actual result matches any of the desired values, the result is converted to Success. If the actual result does not match, the result is converted to MacroError with a descriptive message. This is primarily used for testing and diagnostic purposes. Valid values are: Unknown, Success, MacroError, WorkerStopped, Running, Warning, NeverRun, Cancelled, Pending, Paused, SystemError, Deferred, Stopped.	Cancelled Deferred MacroError NeverRun Paused Pending Running Stopped Success SystemError Warning WorkerStopped	N/A
expectedType	String	Optional	If specified, asserts the expected output type of the macro result. The macro executes normally; if the actual type does not match, a macro error is generated. Requires 'storeAs', 'storeAsHidden', or 'storeFormattedValueAs' to be set for typed validation. Valid types include CLR names (e.g. Int32, Int64, Single, Double, Boolean, String, JArray, JObject) and C# keyword aliases (e.g. int, long, float, double, bool, string, uint, ulong, short, ushort, byte, sbyte, decimal, char, object). The special value 'Number' matches any numeric type.	N/A	N/A
expectedValue	String	Optional	If specified, asserts the expected output value of the macro result. The macro executes normally; if the actual value does not match, a macro error is generated. When 'storeAs' or 'storeAsHidden' is set, the stored variable value is compared. Otherwise, the document output text is compared.	N/A	N/A

Deprecated (1)

Parameter	Type	Preferred Parameter	Purpose	Options	Default
condition	String	if	An optional condition that must be true in order for the macro to execute. See [If:] macro for more information.	N/A	N/A

Examples (5)

Example 1

[SearchAndReplace: find=Total Logins, replaceWith=Login attempts]

Example 2

Search and replace only in the previous table:

[SearchAndReplace: find=Total Logins, replaceWith=Login attempts, scope=previousTable]

Example 3

Search and replace using the condition parameter and a table - note that you must put the first 2 lines below into a table:

[String: value=True, storeAsHidden=PleaseReplaceItems]
Router1 is here!
[SearchAndReplace: find=Router, replaceWith=Switch, scope=previousTable, if="'{PleaseReplaceItems}' == 'True' "]

Example 4

Search and replace using the condition parameter:

[String: value=True, storeAsHidden=PleaseReplaceItems]
Router1 is here!
[SearchAndReplace: find=Router, replaceWith=Switch, if="'{PleaseReplaceItems}' == 'True' "]

Example 5

Search and replace using an If/Else macro and condition parameter:

[String: value=Total Logins, storeAs=X] [SearchAndReplace: find=Total Logins, replaceWith=Login attempt] [If: condition="endsWith(X, 't')"]Yes.[Else:] no [EndIf:]

Purpose

Compatibility

Examples (5)

Example 1

Example 2

Example 3

Example 4

Example 5

Search

Reconnection

Reconnection

Reconnection