ReportMagic

[LogicMonitor.CollectorProperty:]

Inserts one or more properties of a LogicMonitor Collector.

Purpose

Inserts one or more properties of a LogicMonitor Collector, given its ID.

Macro Compatibility

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

Usage

You should no longer use the 'DeviceCount' and 'DeviceId' properties. Use 'ResourceCount' and 'ResourceId' instead.

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
collectorId	Int32	Deprecated	id		The Collector ID.	N/A	N/A
id	Int32	Use instead of: collectorId		Mandatory	The Collector ID.	N/A	N/A
properties	List<String>	Use instead of: property		Mandatory	The property or properties to insert. Some properties (complex objects) may, in Legacy Mode, produce unexpected result. It is highly recommend that you use Normal Mode to run this macro.	AckComment Acked AckedBy AckedOnLocalString AckedOnUtc AckedOnUtcTimestampUtc AllAsJObject AllAsJson Architecture AutomaticUpgradeInfo BackupCollectorId BearerToken Build CanDowngrade CanDowngradeReason ClearSent CollectorConfiguration Configuration ConfigurationFields ConfigurationVersion CopyUrl CreatedOnLocalString CreatedOnTimeStampUtc Credential Credential2 Description DeviceCount DeviceId DownloadUrl Ea EnableFailBack EnableFailOverOnCollectorDevice EncodedConfigData EscalationChain EscalationChainId Format GroupId GroupName HasFailOverDevice HostName Id InSdt InstanceCount IsDown IsEncoded IsLmLogsEnabled IsLmLogsSyslogEnabled IsSyntheticsEnables LastSentNotificationOnLocalString LastSentNotificationOnTimeStampUtc NeedAutoCreateCollectorDevice NetscanVersion NextRecipient NextUpgradeInfo OnetimeDowngradeInfo OneTimeUpgradeInfo OtelId OtelVersion Platform PredefinedConfiguration PreviousVersion ProxyConfiguration ResendInterval ResourceCount ResourceId Size SpecifiedCollectorDeviceGroupId Status SuppressAlertClear Type UpdatedOnLocalString UpdatedOnTimeStampUtc UpgradeTimeUtcSeconds Uptime UserChangeOnLocal UserChangeOnUtcSeconds UserPermission UserVisibleDeviceCount UserVisibleWebsiteCount WatchdogConfiguration WatchdogUpdatedOnLocal WatchdogUpdatedOnSeconds WatchdogUpdatedOnUtc WebsiteConfiguration WebsiteCount WrapperConfiguration	N/A
property	List<String>	Deprecated	properties		The property or properties to insert. Some properties (complex objects) may, in Legacy Mode, produce unexpected result. It is highly recommend that you use Normal Mode to run this macro.	AckComment Acked AckedBy AckedOnLocalString AckedOnUtc AckedOnUtcTimestampUtc AllAsJObject AllAsJson Architecture AutomaticUpgradeInfo BackupCollectorId BearerToken Build CanDowngrade CanDowngradeReason ClearSent CollectorConfiguration Configuration ConfigurationFields ConfigurationVersion CopyUrl CreatedOnLocalString CreatedOnTimeStampUtc Credential Credential2 Description DeviceCount DeviceId DownloadUrl Ea EnableFailBack EnableFailOverOnCollectorDevice EncodedConfigData EscalationChain EscalationChainId Format GroupId GroupName HasFailOverDevice HostName Id InSdt InstanceCount IsDown IsEncoded IsLmLogsEnabled IsLmLogsSyslogEnabled IsSyntheticsEnables LastSentNotificationOnLocalString LastSentNotificationOnTimeStampUtc NeedAutoCreateCollectorDevice NetscanVersion NextRecipient NextUpgradeInfo OnetimeDowngradeInfo OneTimeUpgradeInfo OtelId OtelVersion Platform PredefinedConfiguration PreviousVersion ProxyConfiguration ResendInterval ResourceCount ResourceId Size SpecifiedCollectorDeviceGroupId Status SuppressAlertClear Type UpdatedOnLocalString UpdatedOnTimeStampUtc UpgradeTimeUtcSeconds Uptime UserChangeOnLocal UserChangeOnUtcSeconds UserPermission UserVisibleDeviceCount UserVisibleWebsiteCount WatchdogConfiguration WatchdogUpdatedOnLocal WatchdogUpdatedOnSeconds WatchdogUpdatedOnUtc WebsiteConfiguration WebsiteCount WrapperConfiguration	N/A
calculate	String			Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
colorTableCell	Boolean			Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
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 LogicMonitor Connection.	N/A	N/A
criticalAfter	DateTimeOffset			Optional	The macro is considered 'critical' if the output is after this DateTime UTC.	N/A	N/A
criticalBefore	DateTimeOffset			Optional	The macro is considered 'critical' if the output is before this DateTime UTC.	N/A	N/A
criticalEq	String			Optional	The macro is considered 'critical' if the output is equal to this value.	N/A	N/A
criticalFontBackgroundColor	Color			Optional	The critical font background color to use. If omitted, no change is made.	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
criticalFontBold	Boolean			Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
criticalFontColor	Color			Optional	The critical font color to use. If omitted, no change is made.	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
criticalFontSize	Double			Optional	Change the critical font size in points. If omitted, no change is made.	From 2 to 200	N/A
criticalGe	String			Optional	The macro is considered 'critical' if the output is greater than or equal to this value.	N/A	N/A
criticalGt	String			Optional	The macro is considered 'critical' if the output is greater than this value.	N/A	N/A
criticalIf	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
criticalLe	String			Optional	The macro is considered 'critical' if the output is less than or equal to this value.	N/A	N/A
criticalLt	String			Optional	The macro is considered 'critical' if the output is less than this value.	N/A	N/A
criticalNe	String			Optional	The macro is considered 'critical' if the output is not equal to this value.	N/A	N/A
criticalTableCellBackgroundColor	Color			Optional	The critical table cell 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
errorAfter	DateTimeOffset			Optional	The macro is considered 'error' if the output is after this DateTime UTC.	N/A	N/A
errorBefore	DateTimeOffset			Optional	The macro is considered 'error' if the output is before this DateTime UTC.	N/A	N/A
errorEq	String			Optional	The macro is considered 'error' if the output is equal to this value.	N/A	N/A
errorFontBackgroundColor	Color			Optional	The error font background color to use. If omitted, no change is made.	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
errorFontBold	Boolean			Optional	Change the error font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
errorFontColor	Color			Optional	The error font color to use. If omitted, no change is made.	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
errorFontSize	Double			Optional	Change the error font size in points. If omitted, no change is made.	From 2 to 200	N/A
errorGe	String			Optional	The macro is considered 'error' if the output is greater than or equal to this value.	N/A	N/A
errorGt	String			Optional	The macro is considered 'error' if the output is greater than this value.	N/A	N/A
errorIf	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
errorLe	String			Optional	The macro is considered 'error' if the output is less than or equal to this value.	N/A	N/A
errorLt	String			Optional	The macro is considered 'error' if the output is less than this value.	N/A	N/A
errorNe	String			Optional	The macro is considered 'error' if the output is not equal to this value.	N/A	N/A
errorOnOverflow	Boolean			Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
errorTableCellBackgroundColor	Color			Optional	The error table cell 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
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
fatalAfter	DateTimeOffset			Optional	The macro is considered 'fatal' if the output is after this DateTime UTC.	N/A	N/A
fatalBefore	DateTimeOffset			Optional	The macro is considered 'fatal' if the output is before this DateTime UTC.	N/A	N/A
fatalEq	String			Optional	The macro is considered 'fatal' if the output is equal to this value.	N/A	N/A
fatalFontBackgroundColor	Color			Optional	The fatal font background color to use. If omitted, no change is made.	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
fatalFontBold	Boolean			Optional	Change the fatal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fatalFontColor	Color			Optional	The fatal font color to use. If omitted, no change is made.	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
fatalFontSize	Double			Optional	Change the fatal font size in points. If omitted, no change is made.	From 2 to 200	N/A
fatalGe	String			Optional	The macro is considered 'fatal' if the output is greater than or equal to this value.	N/A	N/A
fatalGt	String			Optional	The macro is considered 'fatal' if the output is greater than this value.	N/A	N/A
fatalIf	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
fatalLe	String			Optional	The macro is considered 'fatal' if the output is less than or equal to this value.	N/A	N/A
fatalLt	String			Optional	The macro is considered 'fatal' if the output is less than this value.	N/A	N/A
fatalNe	String			Optional	The macro is considered 'fatal' if the output is not equal to this value.	N/A	N/A
fatalTableCellBackgroundColor	Color			Optional	The fatal table cell 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
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
fontBold	Boolean			Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	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
fontSize	Double			Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A
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
hidden	Boolean			Optional	Whether to hide the macro output.	true false	false
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
infoAfter	DateTimeOffset			Optional	The macro is considered 'info' if the output is after this DateTime UTC.	N/A	N/A
infoBefore	DateTimeOffset			Optional	The macro is considered 'info' if the output is before this DateTime UTC.	N/A	N/A
infoEq	String			Optional	The macro is considered 'info' if the output is equal to this value.	N/A	N/A
infoFontBackgroundColor	Color			Optional	The info font background color to use. If omitted, no change is made.	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
infoFontBold	Boolean			Optional	Change the info font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
infoFontColor	Color			Optional	The info font color to use. If omitted, no change is made.	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
infoFontSize	Double			Optional	Change the info font size in points. If omitted, no change is made.	From 2 to 200	N/A
infoGe	String			Optional	The macro is considered 'info' if the output is greater than or equal to this value.	N/A	N/A
infoGt	String			Optional	The macro is considered 'info' if the output is greater than this value.	N/A	N/A
infoIf	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
infoLe	String			Optional	The macro is considered 'info' if the output is less than or equal to this value.	N/A	N/A
infoLt	String			Optional	The macro is considered 'info' if the output is less than this value.	N/A	N/A
infoNe	String			Optional	The macro is considered 'info' if the output is not equal to this value.	N/A	N/A
infoTableCellBackgroundColor	Color			Optional	The info table cell 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
jsonFormat	Newtonsoft.Json.Formatting			Optional	In Legacy Mode, how to format the JSON output. Affects the output only when the 'PredefinedConfiguration' property is used.	None Indented	None
maxAttempts	Int32			Optional	The maximum number of attempts when requesting data via the LogicMonitor API.	From 1 to 2147483647	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
normalFontBackgroundColor	Color			Optional	The normal font background color to use. If omitted, no change is made.	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
normalFontBold	Boolean			Optional	Change the normal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
normalFontColor	Color			Optional	The normal font color to use. If omitted, no change is made.	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
normalFontSize	Double			Optional	Change the normal font size in points. If omitted, no change is made.	From 2 to 200	N/A
normalTableCellBackgroundColor	Color			Optional	The normal table cell background color to use. If omitted, no change is made.	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
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
outputListsAsJarray Normal mode	Boolean			Optional	Any macros that output lists can optionally (in Normal mode) output a jArray instead.	true false	true
propertyDelimiter	Char			Optional	In Legacy Mode, the delimiter character to use between each property in the output, when multiple properties are specified.	N/A	^
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
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
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
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
warningAfter	DateTimeOffset			Optional	The macro is considered 'warning' if the output is after this DateTime UTC.	N/A	N/A
warningBefore	DateTimeOffset			Optional	The macro is considered 'warning' if the output is before this DateTime UTC.	N/A	N/A
warningEq	String			Optional	The macro is considered 'warning' if the output is equal to this value.	N/A	N/A
warningFontBackgroundColor	Color			Optional	The warning font background color to use. If omitted, no change is made.	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
warningFontBold	Boolean			Optional	Change the warning font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
warningFontColor	Color			Optional	The warning font color to use. If omitted, no change is made.	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
warningFontSize	Double			Optional	Change the warning font size in points. If omitted, no change is made.	From 2 to 200	N/A
warningGe	String			Optional	The macro is considered 'warning' if the output is greater than or equal to this value.	N/A	N/A
warningGt	String			Optional	The macro is considered 'warning' if the output is greater than this value.	N/A	N/A
warningIf	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
warningLe	String			Optional	The macro is considered 'warning' if the output is less than or equal to this value.	N/A	N/A
warningLt	String			Optional	The macro is considered 'warning' if the output is less than this value.	N/A	N/A
warningNe	String			Optional	The macro is considered 'warning' if the output is not equal to this value.	N/A	N/A
warningTableCellBackgroundColor	Color			Optional	The warning table cell 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

Examples (4)

Example 1: Legacy mode

This Legacy Mode example displays the name and status of all Collectors. The [LogicMonitor.CollectorList:] macro initially obtains all Collector IDs, then iterates over them using the [ForEach:] macro. Next, The [LogicMonitor.CollectorProperty:] macro is used to obtain the properties which it stores as a delimited string it a variable called Details. Finally, [Regex:] macros are used to split the value of the Details variable we obtained (which stores the data as: name^status) into two parts separated by the caret, and hence we have the name and status:

[LogicMonitor.CollectorList: properties=Id, storeAsHidden=Ids, mode=Legacy]
[ForEach: values={Ids}, storeAs=Id][LogicMonitor.CollectorProperty: id={Id}, properties=HostName;Status, mode=Legacy, storeAsHidden=Details]
Name: [Regex: value={Details}, pattern="(.*)\^.*"]
Status: [Regex: value={Details}, pattern=".*\^(.*)"]
[EndForEach:]

Example 2: Normal mode

This Normal Mode example displays the name and status of all Collectors. The [LogicMonitor.CollectorList:] macro initially obtains all Collector IDs, then we iterate over them using the [ForEach:] macro. Next, the [Calculate:] macro's shorthand form of [.:] is used to extract the Id property of the variable (which is a JObject) and store into a second integer variable. This variable can now be used by the [LogicMonitor.CollectorProperty:] macro (as it requires a simple ID) to obtain the required properties. Finally, [.:] macros are used again to obtain both properties from the variable called Object.

[LogicMonitor.CollectorList: properties=Id, storeAsHidden=IdObjects, mode=Normal]
[ForEach: values={=IdObjects}, storeAs=IdObject][.:IdObject.Id, =>Id][LogicMonitor.CollectorProperty: id={Id}, properties=HostName;Status, mode=Normal, storeAsHidden=Object]
Name: [.:Object.HostName]
Status: [.:Object.Status]
[EndForEach:]

Example 3: Normal mode

This Normal Mode example outputs the PredefinedConfiguration property of the first Collector as unformatted JSON:

[LogicMonitor.CollectorList: properties=Id, mode=Normal, singleValueList=true, =>CollectorIds][List.First: values={=CollectorIds}, mode=Normal, condition=true, =>FirstCollectorId][LogicMonitor.CollectorProperty: id={FirstCollectorId}, properties=PredefinedConfiguration, JsonFormat=None, mode=Normal]

Example 4: Normal mode

This Normal Mode example get the PredefinedConfiguration property of the first Collector as indented (prettified) JSON:

[LogicMonitor.CollectorList: properties=Id, mode=Normal, singleValueList=true, =>CollectorIds][List.First: values={=CollectorIds}, mode=Normal, condition=true, =>FirstCollectorId][LogicMonitor.CollectorProperty: id={FirstCollectorId}, properties=PredefinedConfiguration, JsonFormat=Indented, mode=Normal]