ReportMagic

[LogicMonitor.AlertMap:]

Inserts a map with alerts displayed at their location.

Purpose

Inserts a map with the worst alert at each location displayed (red for Critical, orange for Error and yellow for Warning). For alerts to appear on the map:

the devices being alerted on must have the location parameter set (as per the LogicMonitor documentation)
the devices must be in an alerting state as per the LogicMonitor.PercentageAvailability's way of filtering alerts

Compatibility

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

Usage

More details about alert macros can be found at https://reportmagic.blogspot.com/p/reportmagic-alert-macros.html.

Parameters (59)

Grouped View

Behaviour (2)8 additional

Parameter	Type	Presence	Purpose	Options	Default
maxAttempts	Int32	Optional	The maximum number of attempts when requesting data via the LogicMonitor API.	From 1 to 2147483647	N/A
waitDuringUpgrades	Boolean	Optional	Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses).	true false	N/A

Additional (8)

Parameter	Type	Presence	Purpose	Options	Default
auto	Boolean	Optional	If 'true', the reporting period will be the last calendar month and neither startDate nor endDate parameters may be used.	true false	false
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
recurseDeviceGroups	Boolean	Optional	Whether to recurse device groups. Specify true to include alerts from child device groups.	true false	true
useCache	Boolean	Optional	Whether to use the cache (where supported).	true false	false
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

Time & Date (3)

Parameter	Type	Presence	Purpose	Options	Default
endDate	DateTimeOffset	Optional	The end date in the format YYYY-MM-DD.	N/A	Midnight on the first day of this month
monthsToReport	Int32	Optional	If set, sets 'endDate' to the 'start' plus the specified number of months.	N/A	N/A
startDate	DateTimeOffset	Optional	The start date in the format YYYY-MM-DD.	N/A	Midnight on the first day of last month

Filtering & Sorting (7)

Parameter	Type	Presence	Purpose	Options	Default
level	AlertLevel	Conditional	Only include alerts at this level or above.	Error All Warning Critical DoMapping Any	Error
ackFilter	AckFilter	Optional	All: Both non-acknowledged alerts and acknowledged alerts will be returned. Acked: Alerts that have been acknowledged will be returned. Nonacked: Alerts that have not been acknowledged will be returned.	All Acked Nonacked	All
includeInactive	Boolean	Optional	true: Historical alert records will be returned (i.e. both active and inactive alert details). false: Only active alert details will be returned.	true false	true
orderBy	String	Optional	The order the alerts should be retrieved in.	N/A	StartOnSeconds
orderDirection	OrderDirection	Optional	The direction of the order the alerts should be retrieved in.	Desc Asc	Desc
skip	Int32	Optional	The number of items to skip.	N/A	N/A
take	Int32	Optional	The maximum number to take.	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 (23)

Parameter	Type	Presence	Purpose	Options	Default
resourceTemplateId	Int32	Conditional	Only include alerts relating to a LogicModule with this Id. WARNING! Multiple LogicModules could have the same Id. Only use with useCache=true.	N/A	N/A
ackCommentMatchesRegex	Regex	Optional	If present, only alerts with acknowledgement comments matching the regular expression are included.	N/A	N/A
alertTypes	List<String>	Optional	The semicolon-separated list of alertTypes to fetch. Options are: 'AlertThrottled', 'BatchJob', 'CollectorDown', 'CollectorFailBack', 'CollectorFailover', 'DataSource', 'EventSource', 'Log', 'ResourceCluster', 'Unknown' or 'Website'.	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
connectionName	String	Optional	The name of the Connection.	N/A	N/A
dataPoint	String	Optional	The name of the dataPoint that you want to retrieve alert data for.	N/A	N/A
dataSource	String	Optional	The DataSource unique name.	N/A	N/A
dataSourceInstance	String	Optional	The Datasource Instance e.g. WinVolumeUsage-F:	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
id	String	Optional	The specific unique alert ID to fetch.	N/A	N/A
minimumDurationMinutes	Int32	Optional	Filter alerts where the alert has been active for more than the specified number of minutes.	N/A	N/A
monitorObjectDisplayName	String	Optional	The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId.	N/A	N/A
monitorObjectId	Int32	Optional	Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary.	N/A	N/A
monitorObjectType	MonitorObjectType	Optional	Determines whether the monitored object in question is a Device or a Website, when specifying the Monitor Object ID and 'useCache=false'. This is necessary because there are specific LogicMonitor API calls to fetch alerts that are used in each case, in order to ensure that, for example, a Device that has had its name changed can still be queried for all alerts by its ID. Just specifying the Monitor Object ID alone is insufficient to determine the type.	Device Other Website	Device
problemSignature	String	Optional	Only include alerts matching this problem signature (InternalId).	N/A	N/A
resourceGroupName	String	Optional	Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder.	N/A	N/A
resourceTemplateDisplayName	String	Optional	Only include alerts relating to a LogicModule with this Display Name (NOT unique name). WARNING! Multiple LogicModules (even of the same type) could have the same display name.	N/A	N/A
resourceTemplateDisplayNameMatchesRegex	Regex	Optional	If present, only alerts with a resource template name matching the regular expression are included.	N/A	N/A
sdted	SdtFilter	Optional	Filter alerts by SDT status where SDT means only include alerts created during SDT in the results, NonSdt means only include alerts created outside SDT in the results and All shows all alerts.	All Sdt NonSdt	All
serviceId	Int32	Optional	DEPRECATED	N/A	N/A
serviceName	String	Optional	DEPRECATED	N/A	N/A

Deprecated (14)

Parameter	Type	Preferred Parameter	Purpose	Options	Default
alertType	List<String>	alertTypes	The semicolon-separated list of alertTypes to fetch. Options are: 'AlertThrottled', 'BatchJob', 'CollectorDown', 'CollectorFailBack', 'CollectorFailover', 'DataSource', 'EventSource', 'Log', 'ResourceCluster', 'Unknown' or 'Website'.	N/A	N/A
collectorId	Int32	monitorObjectId	Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary.	N/A	N/A
dataSourceInstanceName	String	dataSourceInstance	The Datasource Instance e.g. WinVolumeUsage-F:	N/A	N/A
dataSourceName	String	dataSource	The DataSource unique name.	N/A	N/A
device	String	monitorObjectDisplayName	The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId.	N/A	N/A
deviceGroup	String	resourceGroupName	Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder.	N/A	N/A
deviceId	Int32	monitorObjectId	Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary.	N/A	N/A
deviceName	String	monitorObjectDisplayName	The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId.	N/A	N/A
filterSDT	SdtFilter	sdted	Filter alerts by SDT status where SDT means only include alerts created during SDT in the results, NonSdt means only include alerts created outside SDT in the results and All shows all alerts.	All Sdt NonSdt	All
group	String	resourceGroupName	Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder.	N/A	N/A
host	String	monitorObjectDisplayName	The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId.	N/A	N/A
internalId	String	problemSignature	Only include alerts matching this problem signature (InternalId).	N/A	N/A
results	Int32	take	The maximum number to take.	N/A	N/A
websiteId	Int32	monitorObjectId	Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary.	N/A	N/A

Examples (2)

Example 1

[LogicMonitor.DeviceList: deviceGroups=/, recurseDeviceGroups=true, mode=Normal, orderBy=Status, =>Devices][Json.List: jArray=`{Devices}`, jsonPath="$.[0].DisplayName", =>FirstDevice][LogicMonitor.AlertMap: device={FirstDevice}, location=Leicester, zoom=7, width=640, height=400]

Example 2