ReportMagic

[Object.UnpackVariables:]

Unpacks the top-level (i.e. not nested) properties of a JObject into variables.

Compatibility

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

Usage

This macro does not display anything in the output document. .

Parameters (13)

Grouped View

Mandatory (1)

Parameter	Type	Purpose	Options	Default
jObject	JObject	The input JSON object (JObject).	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	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 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

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 (6)

Parameter	Type	Presence	Purpose	Options	Default
jObject	JObject	Mandatory	The input JSON object (JObject).	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
desiredExecutionResult	ExecutionResult	Optional	If specified, asserts the expected execution result of the macro. The macro executes normally; if the actual result matches the desired value, 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
variableNamePrefix	String	Optional	Stores the variable using its name but prefixed by this value.	N/A	N/A

Examples (3)

Example 1

This example creates a JSON object (JObject) variable, then uses the [Object.UnpackVariables:] macro store all properties on the object as variables:

[LinearRegression: values=1970-01-01^1000;1971-01-01^2000;1972-01-01^3000, mode=Normal, =>Object]
[Object.UnpackVariables: jObject={=Object}]

Example 2

As the previous example, this example creates a JSON object (JObject) variable, then uses the [Object.UnpackVariables:] macro store all properties on the object as variables, but in this case it also prefixes the variable names with a specific value:

[LinearRegression: values=1970-01-01^1000;1971-01-01^2000;1972-01-01^3000, mode=Normal, =>Object]
[Object.UnpackVariables: jObject={=Object}, variableNamePrefix=Kryptonite_]

Example 3

This example takes in a JSON object (JObject), then creates 4 JArray variables named: BackgroundTraffic, BestEffortTraffic, VideoTraffic, and VoiceTraffic: