---

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

---

Macro Compatibility

---

Usage

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

---

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
level	AlertLevel			Conditional	Only include alerts at this level or above.	Error All Warning Critical DoMapping Any	Error
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
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
alertType	List<String>	Deprecated	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
alertTypes	List<String>	Use instead of: alertType		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
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
collectorId	Int32	Deprecated	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
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	Use instead of: dataSourceName		Optional	The DataSource unique name.	N/A	N/A
dataSourceInstance	String	Use instead of: dataSourceInstanceName		Optional	The Datasource Instance e.g. WinVolumeUsage-F:	N/A	N/A
dataSourceInstanceName	String	Deprecated	dataSourceInstance		The Datasource Instance e.g. WinVolumeUsage-F:	N/A	N/A
dataSourceName	String	Deprecated	dataSource		The DataSource unique name.	N/A	N/A
device	String	Deprecated	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	Deprecated	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	Deprecated	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	Deprecated	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
endDate	DateTimeOffset			Optional	The end date in the format YYYY-MM-DD.	N/A	Midnight on the first day of this month
errorOnOverflow	Boolean			Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
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
filterSDT	SdtFilter	Deprecated	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	Deprecated	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	Deprecated	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
id	String			Optional	The specific unique alert ID to fetch.	N/A	N/A
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
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
internalId	String	Deprecated	problemSignature		Only include alerts matching this problem signature (InternalId).	N/A	N/A
maxAttempts	Int32			Optional	The maximum number of attempts when requesting data via the LogicMonitor API.	From 1 to 2147483647	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
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 object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
monitorObjectDisplayName	String	Use instead of: device deviceName host		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	Use instead of: collectorId deviceId websiteId		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
monthsToReport	Int32			Optional	If set, sets 'endDate' to the 'start' plus the specified number of months.	N/A	N/A
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
orderBy	String			Optional	The order the alerts should be retrieved in.	N/A	StartOnSeconds
orderDirection	Filters.OrderDirection			Optional	The direction of the order the alerts should be retrieved in.	Desc Asc	Desc
problemSignature	String	Use instead of: internalId		Optional	Only include alerts matching this problem signature (InternalId).	N/A	N/A
recurseDeviceGroups	Boolean			Optional	Whether to recurse device groups. Specify true to include alerts from child device groups.	true false	true
resourceGroupName	String	Use instead of: deviceGroup group		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
results	Int32	Deprecated	take		The maximum number to take.	N/A	N/A
sdted	SdtFilter	Use instead of: filterSDT		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	Due to an issue with the LogicMonitor API, you should no longer filter alerts using any of the parameters: dataSourceName, dataSourceId, websiteName, websiteId. You have some choices, but the 'too long, didn't read' version is 'use a combination of resourceTemplateId and alertType parameters to filter by a specific LogicModule.' Here's the full spiel: 1) If you want to filter by a string, please filter using the resourceTemplateName and the *DisplayName* (not the unique name), but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this display name, you will have the desired outcome. 2) If you want to filter by an id, please filter using resourceTemplateId, but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this Id, you will have the desired outcome. You can use this in combination with the alertType parameter and a single alertType (e.g. DataSource) to guarantee the desired outcome.	monitorObjectId	Optional	DEPRECATED	N/A	N/A
serviceName	String	Due to an issue with the LogicMonitor API, you should no longer filter alerts using any of the parameters: dataSourceName, dataSourceId, websiteName, websiteId. You have some choices, but the 'too long, didn't read' version is 'use a combination of resourceTemplateId and alertType parameters to filter by a specific LogicModule.' Here's the full spiel: 1) If you want to filter by a string, please filter using the resourceTemplateName and the *DisplayName* (not the unique name), but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this display name, you will have the desired outcome. 2) If you want to filter by an id, please filter using resourceTemplateId, but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this Id, you will have the desired outcome. You can use this in combination with the alertType parameter and a single alertType (e.g. DataSource) to guarantee the desired outcome.	resourceTemplateDisplayName	Optional	DEPRECATED	N/A	N/A
skip	Int32			Optional	The number of items to skip.	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
take	Int32	Use instead of: results		Optional	The maximum number to take.	N/A	N/A
useCache	Boolean			Optional	Whether to use the cache (where supported).	true false	false
waitDuringUpgrades	Boolean			Optional	Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses).	true false	N/A
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
websiteId	Int32	Deprecated	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:

[LogicMonitor.DeviceList: deviceGroups=/, recurseDeviceGroups=true, mode=Normal, orderBy=Status, =>Devices][Json.List: jArray=`{Devices}`, jsonPath="$.[0].DisplayName", =>FirstDevice][LogicMonitor.AlertMap: device={FirstDevice}, location=Europe, markers=York;Warsaw;Paris;Madrid;Rome;Berlin;Bern;Oslo;Greece, zoom=3, height=400, markerColor=white, markerLabel=C]