Produces a list of summary values for instances.
Compatibility
The macro can be used in all input document types and in Report Studio.
Usage
In Normal mode, the output variable is a JArray.
Updates
A list can now be passed to deviceIds, as well as semicolon-separated text, for example deviceIds={=DeviceIds}.
History (2)
Added 'excludeDeletedResources', which leaves out any device that no longer exists in LogicMonitor instead of failing, and 'deletedResourceIdsVariable', which stores the IDs of the devices left out.
Added the 'outputDateTimes' parameter which lists date ranges were the condition matched (PercentConditionMet only).
Mandatory (2)
| Parameter | Type | Purpose | Options | Default |
| List<String> | Various macros can use aggregations to summarise the data, such as counting a list of values, averaging them, and so on. This can be useful in your reports as it enables you to easily obtain daily, weekly, or monthly values to use in your charts and tables. For more information about using aggregations, see: using aggregations in the help. NOTE: when using PercentUpTime, the dataSourceInstanceName must be set to 'SNMP_Host_Uptime', and the dataPoint set to 'Uptime', or the macro will fail. |
|
N/A | |
| List<String> | A list of DataPoint specs, each consisting unique DataSource name/id, Graph name/id and DataPoint name/id in the format DataSourceName/Id^GraphName/GraphId^DataPointName/DataPointId. Note that using Ids is faster. Use a graph ID of -1 to access raw data. e.g.: DataSource1^-1^DataPoint1;DataSource2^GraphName2^DataPoint2. | N/A | N/A |
Behaviour (2)12 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| Int32 | Optional | The maximum number of attempts when requesting data via the LogicMonitor API. |
|
N/A | |
| Boolean | Optional | Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses). |
|
N/A |
Additional (12)
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | If 'true', the reporting period will be the last calendar month and neither startDate nor endDate parameters may be used. |
|
false | |
| String | Optional | Post processing formula. Use {value} to substitute the macro's output into the formula as text, e.g. {value}/1024, or the bare word value to use the output itself, e.g. jPath(value, 'id') to read a property from an object. If the result is fractional it is shown to two decimal places unless you also set format, e.g. format=G to show it in full; a value kept by storeAs always retains its full precision. | N/A | N/A | |
| 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' and 'Stopped'. |
|
N/A | |
| Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
| 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 | |
| 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 | |
| Boolean | Optional | Whether to hide the macro output. |
|
false | |
| 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 | |
| MacroMode | Optional | The mode in which variables are stored. In legacy mode (default for Schedules), the variable created is a string and formatted. In normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a JArray etc., rather than a formatted string. |
|
Legacy | |
| 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 | |
| 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). |
|
false | |
| 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 (21)
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | Whether to color table cells if thresholds are breached, rather than color the text. |
|
true | |
| Color | Optional | The critical font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The critical font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The critical table cell background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The error font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The error font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The error table cell background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The fatal font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The fatal font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The fatal table cell background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The font background color to use. |
|
N/A | |
| Color | Optional | The font color to use. |
|
N/A | |
| Color | Optional | The info font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The info font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The info table cell background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The normal font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The normal font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The normal table cell background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The warning font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The warning font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The warning table cell background color to use. If omitted, no change is made. |
|
N/A |
Formatting (15)
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | Change the critical font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the critical font size in points. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the error font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the error font size in points. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the fatal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the fatal font size in points. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The format to apply to each output value. | N/A | F2 | |
| Boolean | Optional | Change the info font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the info font size in points. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the normal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the normal font size in points. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the warning font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the warning font size in points. If omitted, no change is made. |
|
N/A |
Conditional Formatting (35)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | The macro is considered 'critical' if the output is equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'critical' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is not equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'error' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is not equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'fatal' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is not equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'info' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is not equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'warning' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is not equal to this value. | N/A | N/A |
Time & Date (3)
| Parameter | Type | Presence | Purpose | Options | Default |
| DateTimeOffset | Optional | The end date in the format YYYY-MM-DD. | N/A | Midnight on the first day of this month | |
| Int32 | Optional | If set, sets 'endDate' to the 'start' plus the specified number of months. | N/A | N/A | |
| DateTimeOffset | Optional | The start date in the format YYYY-MM-DD. | N/A | Midnight on the first day of last month |
Filtering & Sorting (6)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Conditional | The applies to function that the included devices match. Provide either this or 'deviceIds'. | N/A | N/A | |
| Boolean | Optional | Whether to leave out any device that no longer exists in LogicMonitor, rather than failing. Every other device is still evaluated, and each device left out is named in a warning, not in the report. If none of the devices exists, the macro still fails. Instances that exist but have no data are left out by 'excludeNoDataInstances' instead. |
|
false | |
| Boolean | Optional | Whether to exclude instances that have no data for the entire reporting period. |
|
true | |
| Boolean | Optional | Whether to exclude periods of SDT from the macro results. Only works for Devices (not Websites, etc.). |
|
false | |
| Int32 | Optional | The number of items to skip. | N/A | 0 | |
| Int32 | Optional | The number of items to take. | N/A | 2147483647 |
Output (3)7 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | The name of a variable to receive the IDs of the devices left out by 'excludeDeletedResources', as a list, which is empty when none were. | N/A | N/A | |
| Char | Optional | The delimiter to use between multiple items in the output. | N/A | ; | |
| Boolean | Optional | Relevant only for the PercentConditionMet aggregation. In Legacy mode, this outputs the date time ranges that the condition, rather than the aggregation values, and in Normal mode these are added onto the 'Aggregations' object as a jArray (of strings) in the 'PercentConditionMetDateRanges' property. |
|
false |
Additional (7)
| Parameter | Type | Presence | Purpose | Options | Default |
| 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 | |
| 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 | |
Normal mode |
Boolean | Optional | Any macros that output lists can optionally (in Normal mode) output a jArray instead. |
|
true |
| String | Optional | The variable to store the result as. If the variable name ends 'Json' (any casing) its value is wrapped in json tags. That marks the value as JSON so it can be passed straight into a parameter that expects json content, and the RMScript editor also displays it with JSON highlighting. When several variables are stored at once each one is judged by its own name. | N/A | N/A | |
| String | Optional | The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'. | N/A | N/A | |
| Char | Optional | The delimiter used by storeAs to split a TEXT value, 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=*]. If splitting on this delimiter does not produce one value per variable, the '^' character is tried instead; that applies whatever this parameter is set to, and is what allows a single variable to hold a value containing a ';'. Note this delimiter is only used for a TEXT value. A list or a JSON array is instead shared out one element per variable, and a JSON object by its property values in order, so storing jObject('a',1,'b',2) as two variables gives 1 and 2. Any other type cannot be split across several variables at all. | N/A | ; | |
| 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. As with 'storeAs', a name ending 'Json' has its value wrapped in json tags. | N/A | N/A |
General (5)2 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| List<String> | Mandatory | Various macros can use aggregations to summarise the data, such as counting a list of values, averaging them, and so on. This can be useful in your reports as it enables you to easily obtain daily, weekly, or monthly values to use in your charts and tables. For more information about using aggregations, see: using aggregations in the help. NOTE: when using PercentUpTime, the dataSourceInstanceName must be set to 'SNMP_Host_Uptime', and the dataPoint set to 'Uptime', or the macro will fail. |
|
N/A | |
| List<String> | Mandatory | A list of DataPoint specs, each consisting unique DataSource name/id, Graph name/id and DataPoint name/id in the format DataSourceName/Id^GraphName/GraphId^DataPointName/DataPointId. Note that using Ids is faster. Use a graph ID of -1 to access raw data. e.g.: DataSource1^-1^DataPoint1;DataSource2^GraphName2^DataPoint2. | N/A | N/A | |
| List<Int32> | Conditional | The list of device IDs, e.g. 1234;5678. A list can also be passed, e.g. deviceIds={=DeviceIds}. Provide either this or 'matchAppliesToQuery'. | N/A | N/A | |
| String | Optional | The name of the LogicMonitor Connection. | N/A | N/A | |
| PrecisionType | Optional | The data precision. Use 'High' to fetch data in 8-hour chunks, which fetches many more data points. Note: this option may be very slow, so use with caution. |
|
Normal |
Additional (2)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | Add a comment to make your document template more readable. The comment is discarded in the output document. | N/A | N/A | |
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. |
|
false |
Deprecated (3)
| Parameter | Type | Preferred Parameter | Purpose | Options | Default |
| List<String> | aggregations | Various macros can use aggregations to summarise the data, such as counting a list of values, averaging them, and so on. This can be useful in your reports as it enables you to easily obtain daily, weekly, or monthly values to use in your charts and tables. For more information about using aggregations, see: using aggregations in the help. NOTE: when using PercentUpTime, the dataSourceInstanceName must be set to 'SNMP_Host_Uptime', and the dataPoint set to 'Uptime', or the macro will fail. |
|
N/A | |
| List<String> | dataPointSpecs | A list of DataPoint specs, each consisting unique DataSource name/id, Graph name/id and DataPoint name/id in the format DataSourceName/Id^GraphName/GraphId^DataPointName/DataPointId. Note that using Ids is faster. Use a graph ID of -1 to access raw data. e.g.: DataSource1^-1^DataPoint1;DataSource2^GraphName2^DataPoint2. | N/A | N/A | |
| List<Int32> | deviceIds | The list of device IDs, e.g. 1234;5678. A list can also be passed, e.g. deviceIds={=DeviceIds}. Provide either this or 'matchAppliesToQuery'. | N/A | N/A |
Examples (4)
Example 1
[LogicMonitor.SummaryValueList: matchAppliesToQuery=`isWindows() && displayName != "dev.panoramicdata.com"`, dataPointSpecs=WinCPU^-1^CPUBusyPercent, aggregations=Max]Example 2
This example outputs 2 aggregations:
[LogicMonitor.SummaryValueList: matchAppliesToQuery=`isWindows() && displayName != "dev.panoramicdata.com"`, dataPointSpecs=WinCPU^-1^CPUBusyPercent, aggregations=Max;PercentConditionMet(value>10)]Example 3
This example outputs 2 PercentConditionMet aggregations. It's similar to the previous example, however because we are using 2 aggregations with the same name (but different value conditions), we can name the properties differently (Normal mode output) by using the 'as XYZ' notation in the 'aggregations' parameter to avoid JObject/JArray errors:
[LogicMonitor.SummaryValueList: matchAppliesToQuery=`isWindows() && displayName != "dev.panoramicdata.com"`, dataPointSpecs=WinCPU^-1^CPUBusyPercent, aggregations=PercentConditionMet(value>5) as PercentConditionMet5;PercentConditionMet(value>15) as PercentConditionMet15]Example 4
This example leaves out any device that no longer exists in LogicMonitor, rather than failing, and stores the IDs of the devices left out in the DeletedIds variable:
[LogicMonitor.SummaryValueList: deviceIds=1234;5678, dataPointSpecs=WinCPU^-1^CPUBusyPercent, aggregations=Max, excludeDeletedResources=true, deletedResourceIdsVariable=DeletedIds]