ReportMagic

[ForEach:]

Loops over a set of values.

Purpose

Use the [ForEach:] / [EndForEach:] macros to loop over a number of values, repeating a section of the input template as it does so.

Compatibility

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

Usage

The [Break:] and [Continue:] macros can also be used with the [ForEach:] / [EndForEach:] macros, to provide more control over your macro execution. The 'skip' and 'take' parameters limit the number of items returned.

Parameters (19)

Grouped View

Mandatory (1)1 additional

Parameter	Type	Purpose	Options	Default
storeAs	String	The iteration variable.	N/A	N/A

Additional (1)

Parameter	Type	Purpose	Options	Default
values	List<Object>	The values.	N/A	N/A

Behaviour (1)5 additional

Parameter	Type	Presence	Purpose	Options	Default
ifNoValues	String	Optional	The optional 'ifNoValues' parameter is used to specify the output text if the values parameter is empty (e.g. when using string replacement from previous macros in the document).	N/A	N/A

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

Filtering & Sorting (2)

Parameter	Type	Presence	Purpose	Options	Default
skip	Int32	Optional	The number of items to skip.	From 0 to 2147483647	0
take	Int32	Optional	The number of items to take.	From 1 to 2147483647	2147483647

Output (3)2 additional

Parameter	Type	Presence	Purpose	Options	Default
storeAs	String	Mandatory	The iteration variable.	N/A	N/A
columnDelimiter	Char	Optional	The character to use per item to delimit individual fields when assigning to multiple output variables. Likely value to use: '^'.	N/A
delimiter	Char	Optional	The delimiter to use to split the input values, e.g. item1;item2;item3.	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 (5)

Parameter	Type	Presence	Purpose	Options	Default
values	List<Object>	Mandatory	The values.	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

Deprecated (1)

Parameter	Type	Preferred Parameter	Purpose	Options	Default
storeAsHidden	String	storeAs	The iteration variable.	N/A	N/A

Examples (4)

Example 1

A simple [ForEach:] / [EndForEach:] macros (indenting for clarity, but not necessary):

[ForEach: storeAs=currentDevice, values=dev.panoramicdata.com;test.panoramicdata.com]
	***[String:value={currentDevice}]***
	[LogicMonitor.Graph: device={currentDevice}, graphName=CPU Usage, dataSourceName=WinCPU]
[EndForEach:]

Example 2

A nested [ForEach:] / [EndForEach:] macros (indenting for clarity, but not necessary):

[ForEach: storeAs=currentDevice, values=dev.panoramicdata.com;test.panoramicdata.com]
	***Host: [String:value={currentDevice}]***
	[ForEach: storeAs=currentDrive, values=C:]
		**[String: value={currentDrive}]**
		[ForEach: storeAs=currentGraph,values=Throughput;Latency]
			**[String:value={currentGraph}]**
			[LogicMonitor.Graph: device={currentDevice}, dataSourceName=WinLogicalDrivePerformance-, dataSourceInstanceName={currentDrive}, graphName={currentGraph}]
		[EndForEach:]
	[EndForEach:]
[EndForEach:]

Example 3

A simple [ForEach:] / [EndForEach:] macros (indenting for clarity, but not necessary) with missing values. Assume that {devices} is set by a previous macro but has evaluated to an empty string:

[String: value=, hidden=true, storeAs=Devices]
[ForEach: storeAs=Device, values={Devices}, ifNoValues=There are no devices.]
	This device is: [String: value={Device}]
[EndForEach:]

Example 4

Skip and Take mean that you can limit report sizes during development.

BC Only: [ForEach: values=A;B;C, skip=1, take=2, storeAs=Item][String:value={Item}][EndForEach:]
BC Only: [ForEach: values=A;B;C, skip=1, take=5, storeAs=Item][String: value={Item}][EndForEach:]
No items: [ForEach: values=A;B;C, skip=5, take=5, storeAs=Item][String: value={Item}][EndForEach:]