Presents detailed DataSource instance data in a table.
Purpose
Presents detailed DataSource instance data in a table. See also Table Macros help.
Compatibility
The macro can be used in the highlighted input document types only. A greyed-out icon indicates not supported.
Parameters(105)
Mandatory(1)
Parameter
Type
Purpose
Options
Default
dataSourceName
String
The DataSource name.
N/A
N/A
Behaviour(1)10 additional
Parameter
Type
Presence
Purpose
Options
Default
recurseDeviceGroups
Boolean
Optional
Whether to recurse Device Groups. Specify false to exclude child Device Groups.
true
false
true
Additional (10)
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
hidden
Boolean
Optional
If true, the table will not be written to the report. This is useful if you want to use a Table macro in PowerPoint (which does not support adding tables) but have XLSX output enabled on the Schedule. This way the macro will produce a Success rather than Macro Error and the XLSX output will be generated.
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
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 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
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
Colours(2)
Parameter
Type
Presence
Purpose
Options
Default
normalCellColor
Color
Optional
The cell color to use when no issue exists. Affects a cell or row based on the ThresholdAffects parameter.
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
normalCellTextColor
Color
Optional
The cell text color to use when no issue exists. Affects a cell or row based on the ThresholdAffects parameter.
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
Formatting(2)8 additional
Parameter
Type
Presence
Purpose
Options
Default
flowDirection
FlowDirection
Optional
The traffic flow direction. Used only with type=NetflowBandwidth (or type=NetflowBandwidth, which is exactly the same).
All
In
Out
All
titleHeadingLevel
Int32
Optional
If auto-titling the graph, the heading level to use.
From 1 to 6
N/A
Additional (8)
Parameter
Type
Presence
Purpose
Options
Default
autoFit
AutoFitBehavior
Optional
The Word autofit behaviour. If omitted, no change is made.
Content
Fixed
Window
Content
columnAlignments
List<String>
Optional
The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI.
N/A
N/A
fontSize
Double
Optional
Override the table style's font size. This is achieved by setting the font size for each table cell.
From 4 to 50
N/A
format
CellFormat
Optional
The cell format to use. Options are: 'AllStrings', 'Auto' or 'NumbersAsStrings'. Auto automatically sets the format for the whole column, or it can be forced to a string with AllStrings. To preserve date / time formatting (with dateTimeFormat) but treat only number columns as strings, use NumbersAsStrings.
Auto
AllStrings
NumbersAsStrings
Auto
horizontalAlignment
TableHorizontalAlignment
Optional
The horizontal alignment of the table on the page (does not affect Excel output).
Left
Center
Right
Left
pageWidthPercent
Double
Optional
The percentage of the available page that the table should occupy.
From 0 to 150
N/A
style
String
Optional
Use Word's built in Table Styles (such as Grid Table 2 - Accent 1), or make your own in the Report Template. Built-in styles can be used in any document. Note that any custom styles you create, or customisations to the standard styles required that the styles exist in the input template XML (because they are not saved in Word documents by default). This can be achieved by assigning the style to a table, then delete the table and save the document.
N/A
Table Grid
xlsxTableStyle
XlsxTableStyle
Optional
The XLSX table style to use in any XLSX output document.
TableStyleMedium13
None
TableStyleDark1
TableStyleDark10
TableStyleDark11
TableStyleDark2
TableStyleDark3
TableStyleDark4
TableStyleDark5
TableStyleDark6
TableStyleDark7
TableStyleDark8
TableStyleDark9
TableStyleLight1
TableStyleLight10
TableStyleLight11
TableStyleLight12
TableStyleLight13
TableStyleLight14
TableStyleLight15
TableStyleLight16
TableStyleLight17
TableStyleLight18
TableStyleLight19
TableStyleLight2
TableStyleLight20
TableStyleLight21
TableStyleLight3
TableStyleLight4
TableStyleLight5
TableStyleLight6
TableStyleLight7
TableStyleLight8
TableStyleLight9
TableStyleMedium1
TableStyleMedium10
TableStyleMedium11
TableStyleMedium12
TableStyleMedium14
TableStyleMedium15
TableStyleMedium16
TableStyleMedium17
TableStyleMedium18
TableStyleMedium19
TableStyleMedium2
TableStyleMedium20
TableStyleMedium21
TableStyleMedium22
TableStyleMedium23
TableStyleMedium24
TableStyleMedium25
TableStyleMedium26
TableStyleMedium27
TableStyleMedium28
TableStyleMedium3
TableStyleMedium4
TableStyleMedium5
TableStyleMedium6
TableStyleMedium7
TableStyleMedium8
TableStyleMedium9
TableStyleMedium13
Conditional Formatting(10)
Parameter
Type
Presence
Purpose
Options
Default
criticalCellColor
Color
Optional
The critical cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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.
Color [A=255, R=192, G=0, B=0]
criticalCellTextColor
Color
Optional
The critical cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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
errorCellColor
Color
Optional
The error cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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.
Color [A=255, R=240, G=128, B=0]
errorCellTextColor
Color
Optional
The error cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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
fatalCellColor
Color
Optional
The fatal cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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.
Color [A=255, R=150, G=0, B=0]
fatalCellTextColor
Color
Optional
The fatal cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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
infoCellColor
Color
Optional
The info cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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.
Color [A=255, R=0, G=213, B=213]
infoCellTextColor
Color
Optional
The info cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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
warningCellColor
Color
Optional
The warning cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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.
Color [A=255, R=240, G=192, B=0]
warningCellTextColor
Color
Optional
The warning cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter.
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
Chart(4)
Parameter
Type
Presence
Purpose
Options
Default
graphId
Int32
Conditional
The graph ID. If set, do not set the 'graphName' parameter. You can use -1 to use raw data when there is no graph in LogicMonitor but you must choose the data point name as it appears on the 'Raw Data' tab in LogicMonitor, rather than the name in the DataPoint definition.
N/A
N/A
graphName
String
Conditional
The graph name. If set, do not set the 'graphId' parameter.
N/A
N/A
overviewGraphId
Int32
Conditional
The overview graph ID.
N/A
N/A
overviewGraphName
String
Conditional
The overview graph name.
N/A
N/A
Time & Date(3)4 additional
Parameter
Type
Presence
Purpose
Options
Default
forecast
Boolean
Optional
Whether to include forecast data.
true
false
false
forecastTime
String
Optional
The time to forecast.
7days
14days
1month
3months
7days
forecastTrainingTime
String
Optional
The amount of data to use to inform the forecast.
1month
1year
3months
6months
1month
Additional (4)
Parameter
Type
Presence
Purpose
Options
Default
dateTimeFormat
String
Optional
The date/time format to use. Use the format specified here: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings. When the format parameter is set to AllStrings, this is ignored unless you use NumbersAsStrings. Note however that this parameter only has an effect if all the values in the column are the same type.
N/A
yyyy-MM-dd
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(3)4 additional
Parameter
Type
Presence
Purpose
Options
Default
excludeDataPoint
List<String>
Optional
The datapoints to exclude.
N/A
N/A
excludeSdt
Boolean
Optional
Whether to exclude periods of SDT from the macro results. Only works for Devices (not Websites, etc.). For the most accurate results, ensure that you have LogicMonitor permissions for ALL the Device Groups that the Devices are members of. When this is not the case, those Device Groups will simply be skipped.
true
false
false
includeDataPoint
List<String>
Optional
The datapoints to include.
N/A
N/A
Additional (4)
Parameter
Type
Presence
Purpose
Options
Default
includeCondition
String
Optional
The condition on which each row is included. Fields should be referred to based on the column name in curly braces, for example: includeCondition ='{CreatedOn}'>'{StartOfLastMonth}'.
N/A
N/A
orderBy
String
Optional
If present, sorts alphanumerically by this column.
N/A
N/A
orderByDescending
String
Optional
If present, sorts reverse alphanumerically by this column.
N/A
N/A
take
Int32
Optional
Only display up to this number of rows.
From 0 to 2147483647
N/A
Output(1)3 additional
Parameter
Type
Presence
Purpose
Options
Default
writeToSpreadsheet
Boolean
Optional
Whether to write output to a spreadsheet.
true
false
N/A
Additional (3)
Parameter
Type
Presence
Purpose
Options
Default
emptyTableText
String
Optional
If present, and the table has no rows, the specified text will be inserted in place of the table.
N/A
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
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(17)11 additional
Parameter
Type
Presence
Purpose
Options
Default
dataSourceName
String
Mandatory
The DataSource name.
N/A
N/A
dataSourceInstanceGroupId
Int32
Conditional
The DataSource instance group id. If set, the dataSource parameter must also be set.
N/A
N/A
dataSourceInstanceGroupName
String
Conditional
The DataSource instance group name. If set, the dataSource parameter must also be set.
N/A
N/A
dataSourceInstanceId
Int32
Conditional
The DataSource instance ID. If set, the dataSource parameter must also be set.
N/A
N/A
dataSourceInstanceName
String
Conditional
The DataSource instance name. If set, the dataSource parameter must also be set.
N/A
N/A
websiteCheckPointName
List<String>
Conditional
The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint).
N/A
N/A
websiteName
List<String>
Conditional
The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint).
N/A
N/A
widgetId
Int32
Conditional
The Widget ID for dashboard graphs. The type / graphType parameter should be set to DashboardWidget. Finding the Widget id requires a few steps: you will need to use your LogicMonitor portal UI, enter developer mode in the browser, and find all 'li' elements (which are the Widgets) where the 'data_component_unique_name' attribute is like xxx_widget_xxx, where xxx are numbers. For example, 99_widget_123 is a Widget ID of 123.
N/A
N/A
autoTitle
Boolean
Optional
Whether to auto title the graph.
true
false
true
columns
List<String>
Optional
The columns parameter is specified as a set of semicolon-separated definitions. There are 1-column options (e.g. columns=PROPERTY NAME), and several 3-column options (where the caret symbol is used to define 3 values e.g. columns=COLUMN LABEL^AGGREGATION^DATA POINT NAME). You can mix and match 1-column options and 3-column options in the same definition separated by a semicolon, e.g. specify two columns like this: columns=ALIAS;MY COLUMN LABEL^Property^device.CreatedOn. The 1-column option allows you to specify the DataSource Instance property to output and the column name in one go. Supported options are: Alias, DeviceId, DataSourceId, Id, Description, DiscoveryInstanceId, AlertEnable, DataSourceInstanceAlias, and Name, as well as any of the device properties mentioned at the end of this help (**) in the format device.XYZ. They can be used like this: columns=Name;Alias;AlertEnable;device.DisplayName. This example produces a table with 3 columns, with three headings: Name, Alias, and AlertEnable. The values output in the table will be the relvant values for the Device DataSource Instance in question. The 3-column options are specified delimited by the caret (^) in 4 variants: 1) The first is: COLUMN LABEL^AGGREGATION^DATASOURCE GRAPH LINE LEGEND NAME e.g. XYZ^max^max (In) where XYZ is the column title in the output, max is an aggregation (min, mean, max, count, etc. - more details below), and GRAPH DATAPOINT is the name of a data point that exists on the data source graph you have specified using the dataSourceName and graphName parameters. 2) The second 3-column specification is: COLUMN LABEL^Property^device.Propertyname e.g. columns=Device Display Name^Property^device.DisplayName. The available properties are specified at the end of this help. 3) The third 3-column specification is: COLUMN LABEL^calc^expression, e.g. columns=Total^Calc^1+2. This would produce a table with 1 column (titled Total) and the value in the cell is a calculation of 1 + 2. The expression can contain column label names (in curly braces) to use values from previous columns in the calculation, e.g. columns=Total^Calc^{Col1}+{Col2}. 4) The fourth 3-column specificiation is: COLUMN LABEL^Property^dataSourceInstance.PROPERTYNAME (replace capitalised text). The PROPERTYNAME text should be replaced with any of: Alias, DeviceId, DataSourceId, Id, Description, DiscoveryInstanceId, AlertEnable, DataSourceInstanceAlias or Name. For example: e.g. columns=My Column Name^Property^dataSourceInstance.DeviceId. * Supported aggregations are: Mean, Min, Max, First, Last, Sum, All, and Count. ** Supported properties used when the COLUMN LABEL^Property^device.PropertyName format is used, are: device.AlertEnable, device.AlertLevel, device.AlertsAreAcknowledged, device.AlertsAreInSdt, device.AlertStatus, device.AllAsJObject, device.AllAsJson, device.AutoPropsAssignedOn, device.AutoPropsUpdatedOn, device.CollectorDescription, device.CreatedOn, device.CurrentCollectorId, device.DeviceGroupIds, device.DeviceGroups, device.DeviceStatusdevice.DisplayName, device.DisplayName, device.EffectiveAlertEnabled, device.EnableNetflow, device.DeviceGroups, device.HostName, device.Id, device.InSdt, device.LastDataTime, device.Link, device.NetflowCollectorId, device.PreferredCollectorId, device.SdtStatus, device.AlertStatus, device.Type
N/A
N/A
dataSourceId
Int32
Optional
The DataSource ID.
N/A
N/A
deviceGroups
List<String>
Optional
The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.
N/A
N/A
deviceIds
List<Int32>
Optional
The Device ID or IDs.
N/A
N/A
devices
List<String>
Optional
The Device Display name or names.
N/A
N/A
flowInterfaceIndices
List<String>
Optional
The traffic flow interfaces e.g. 1;2;3 for interfaces 1, 2 and 3. Used only with type=NetflowBandwidth.
N/A
N/A
type
GraphType
Optional
The graph type. Note that the default is Device, so you should change this if, for example, you are requesting graphs from Websites or other types.
Device
WebsiteOverview
NetflowBandwidth
WebsiteCheckPoint
DashboardWidget
Device
websiteIds
List<Int32>
Optional
The Website ID or IDs.
N/A
N/A
Additional (11)
Parameter
Type
Presence
Purpose
Options
Default
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
deCamelCaseHeaderRow
Boolean
Optional
Whether to de-camel-case the header row (i.e. convert 'MyHeaderText' to 'My Header Text'.
true
false
false
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
repeatHeaderPerPage
Boolean
Optional
Whether to repeat the header row at the beginning of each page.
true
false
true
tableName
String
Optional
The table name (e.g. for XLSX output)
N/A
Table
thresholdAffects
ThresholdAffects
Optional
What the threshold affects.
Cell
Row
Cell
thresholdColumn
String
Optional
The threshold column.
N/A
N/A
worksheetName
String
Optional
The worksheet to save the result in the output Excel document (if so configured). Excel does not allow blank names, names above 31 characters, and the following characters: :, /, \, ?, *, [, ]
N/A
Table
Deprecated(18)4 additional
Parameter
Type
Preferred Parameter
Purpose
Options
Default
dataSource
String
dataSourceName
The DataSource name.
N/A
N/A
serviceCheckPointName
List<String>
websiteCheckPointName
The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint).
N/A
N/A
serviceCheckPointNames
List<String>
websiteCheckPointName
The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint).
N/A
N/A
serviceName
List<String>
websiteName
The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint).
N/A
N/A
serviceNames
List<String>
websiteName
The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint).
N/A
N/A
websiteCheckPointNames
List<String>
websiteCheckPointName
The Website Checkpoint name or names (required when type / graphType is set to WebsiteCheckPoint).
N/A
N/A
websiteNames
List<String>
websiteName
The Website name or names (required when type / graphType is set to WebsiteOverview or WebsiteCheckPoint).
N/A
N/A
autoTitleHeadingLevel
Int32
titleHeadingLevel
If auto-titling the graph, the heading level to use.
From 1 to 6
N/A
device
List<String>
devices
The Device Display name or names.
N/A
N/A
deviceGroup
List<String>
deviceGroups
The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.
N/A
N/A
deviceId
List<Int32>
deviceIds
The Device ID or IDs.
N/A
N/A
graphType
GraphType
type
The graph type. Note that the default is Device, so you should change this if, for example, you are requesting graphs from Websites or other types.
Device
WebsiteOverview
NetflowBandwidth
WebsiteCheckPoint
DashboardWidget
Device
group
List<String>
deviceGroups
The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.
N/A
N/A
groups
List<String>
deviceGroups
The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.
N/A
N/A
host
List<String>
devices
The Device Display name or names.
N/A
N/A
hostId
List<Int32>
deviceIds
The Device ID or IDs.
N/A
N/A
hosts
List<String>
devices
The Device Display name or names.
N/A
N/A
websiteId
List<Int32>
websiteIds
The Website ID or IDs.
N/A
N/A
Additional (4)
Parameter
Type
Preferred Parameter
Purpose
Options
Default
alignment
List<String>
columnAlignments
The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI.
N/A
N/A
alignments
List<String>
columnAlignments
The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI.
N/A
N/A
autofit
AutoFitBehavior
autoFit
The Word autofit behaviour. If omitted, no change is made.
Content
Fixed
Window
Content
topN
Int32
take
Only display up to this number of rows.
From 0 to 2147483647
N/A
Examples (6)
Example 1
This example produce a table with 6 columns. The first 3 columns output the relevant properties (and use the property names themselves as the column headings). The 4th column will be titled 'InBound' and uses the Max aggregation on the DataSource graph's line legend name 'Inbound : Number of inbound bits/sec.'. The 5th column will be titled'OutBound' and also use the Max aggregation with the 'Number of outbound bits/sec.' line legend name. The last column is titled 'Addition' and uses the Calc aggregation to sum the values from the InBound and Outbound columns:
[LogicMonitor.InstanceDetailsTable: devices=pdl-fw-01, dataSourceName=snmp64_If-, graphName=Throughput, columns=device.DisplayName;Alias;AlertEnable;InBound^Max^Inbound : Number of inbound bits/sec.;Outbound^Max^Outbound : Number of outbound bits/sec.;Addition^Calc^{InBound}+{Outbound}, orderByDescending=Addition, take=10, autoFit=Window]
Example 2
The following example produces a table as in the first example, but colours the 'Addition' column's cells with a red background and yellow text when the cell's values exceed 1,000,000. This is achieved by using the thresholdColumn parameter (to specify which column any warning/error/critical parameters will apply), the errorGe parameter (to set the 'error greater than' value), the errorCellColor parameter (to set the cell's background color), and the errorCellTextColor parameter (to set the cell's text colour):
[LogicMonitor.InstanceDetailsTable: devices=pdl-fw-01, dataSourceName=snmp64_If-, graphName=Throughput, columns=device.DisplayName;Alias;AlertEnable;InBound^Max^Inbound : Number of inbound bits/sec.;Outbound^Max^Outbound : Number of outbound bits/sec.;Addition^Calc^{InBound}+{Outbound}, orderByDescending=Addition, take=10, thresholdColumn=Addition, autoFit=Window, errorGe=1000000, errorCellColor=#ff0000, errorCellTextColor=#ffff00]
This example has 4 columns. The first column specifies the name using the 1-column format. The next two columns are also specified using the 1-column format to output the device properties. The last column uses the Mean aggregation on the Busy line legend name (which can be found in LogicMonitor by going to the graph definition, and finding the Lines section, then by choosing the relevant item):
[LogicMonitor.InstanceDetailsTable: devices=dev.panoramicdata.com;test.panoramicdata.com, dataSourceName=WinCPU, graphName=CPU Usage, columns=Name;device.DisplayName;device.DeviceGroups;Mean CPU %^Mean^Busy]
This example is similar to the previous one, except that it uses the 3-column columns format to specify a custom column title (Device ID) for the dataSourceInstance.DeviceId property. If we had used the 1-column format instead (and used just DeviceId) then the column name would also be 'DeviceId', rather than 'Device ID' which is what we can achieve this way:
