ReportMagic

[Dictionary.Item:]

Retrieves an item from a dictionary.

Purpose

Use the Dictionary.Item macro to retrieve the keyed item from a dictionary of items stored in a string, which can be specified as valid JSON or not. If the key is not present in the dictionary, you will receive an error.

Compatibility

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

Usage

For non-JSON values, the input format must take the form: key1^value1;key2^value2;key3^value4 etc. Note: backticks (`) MUST be used around JSON examples, or the macro will not be recognised.

Parameters (30)

Grouped View

Mandatory (2)

Parameter	Type	Purpose	Options	Default
key	String	The key.	N/A	N/A
value	String	The value.	N/A	N/A

Behaviour (3)5 additional

Parameter	Type	Presence	Purpose	Options	Default
calculate	String	Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
hidden	Boolean	Optional	Whether to hide the macro output.	true false	false
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

Additional (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

Colours (3)

Parameter	Type	Presence	Purpose	Options	Default
colorTableCell	Boolean	Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
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
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

Formatting (2)1 additional

Parameter	Type	Presence	Purpose	Options	Default
fontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fontSize	Double	Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A

Additional (1)

Parameter	Type	Presence	Purpose	Options	Default
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

Output (7)2 additional

Parameter	Type	Presence	Purpose	Options	Default
columnDelimiter	Char	Optional	The delimiter to use between the key and value, for parsing the input (non-JSON dictionary only).	N/A	^
outputListsAsJarray Normal mode	Boolean	Optional	Any macros that output lists can optionally (in Normal mode) output a jArray instead.	true false	true
rowDelimiter	Char	Optional	The delimiter character to use between each key value pair, for parsing the input (non-JSON dictionary only).	N/A	;
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=abcd, 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

Additional (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 (3)4 additional

Parameter	Type	Presence	Purpose	Options	Default
key	String	Mandatory	The key.	N/A	N/A
value	String	Mandatory	The value.	N/A	N/A
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

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	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

Examples (3)

Example 1

Get the item for key 'a' from a JSON dictionary:

[Dictionary.Item: value=`{ "a": { "x": 1 }, "b": { "x": 2 } }`, key=a, storeAs=Item]

Outputs: { "x": 1 }

Example 2

Get the item for key 'a.x' from a non-JSON dictionary

[Dictionary.Item: value="a.x^1;b.x^2", key=a.x]

Outputs: 1

Example 3

Get the item for key 'a.x' from a non-JSON dictionary, but using an asterisk to delimit each key value pair (a 'row'), and a dash to delimit the key and the value (a 'column'):

[Dictionary.Item: value="a.x-1*b.x-2", rowDelimiter="*", columnDelimiter="-", key=a.x]