ReportMagic

[LogicMonitor.Dashboard:]

Inserts a LogicMonitor Dashboard into the output document.

Purpose

Inserts a LogicMonitor Dashboard into the output document, which works by creating and running a Report in LogicMonitor.

Compatibility

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

Usage

In PowerPoint output documents, you can insert into a shape by ID, or omit the ID and the Dashboard will be inserted into the shape that contains the macro. In Word output documents, you can insert into a shape by ID (and in this case optionally use insertHyperlink), or omit the ID and the Dashboard will be inserted directly into the document. For more information on using macros in PowerPoint, see: PowerPoint help.

Parameters (47)

Grouped View

Behaviour (6)5 additional

Parameter	Type	Presence	Purpose	Options	Default
insertHyperlink	Boolean	Optional	When set, a hyperlink to the Dashboard will be added to the output image or shape in PowerPoint. In Word, the hyperlink is ONLY inserted when a shape is used (and the shapeId parameter is set. CTRL-click navigates to the URL.	true false	false
maxAttempts	Int32	Optional	The maximum number of attempts when requesting data via the LogicMonitor API.	From 1 to 2147483647	N/A
minimumWaitMs	Int32	Optional	The delay (in milliseconds) to wait before taking the 'screenshot' of the Dashboard. This gives them additional time to fetch data / render.	N/A	2000
reportGenerationTimeoutMs	Int32	Optional	The timeout (milliseconds) to wait for LogicMonitor when generating Reports. Some Reports may take a long time, in which case you can adjust the timeout value. The default is 10 minutes.	N/A	600000
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

Additional (5)

Parameter	Type	Presence	Purpose	Options	Default
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
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 (1)

Parameter	Type	Presence	Purpose	Options	Default
backgroundColor	Color	Optional	Optionally use to specify the background Colour of the Dashboard. Use known colours (such as 'red') or # formatted (e.g. #RRGGBB or #AARRGGBB).	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 [Transparent]

Formatting (19)

Parameter	Type	Presence	Purpose	Options	Default
imageHeightCm	Double	Conditional	In Word / HTML output, the image height in centimetres. When set, 'imageWidthCm' must also be set.	N/A	N/A
imageWidthCm	Double	Conditional	In Word / HTML output, the image width in centimetres. When set, 'imageHeightCm' must also be set.	N/A	N/A
clipBottom	Double	Optional	In Word / HTML output, the number of pixels to clip from the bottom.	N/A	N/A
clipLeft	Double	Optional	In Word / HTML output, the number of pixels to clip from the left.	N/A	N/A
clipRight	Double	Optional	In Word / HTML output, the number of pixels to clip from the right.	N/A	N/A
clipTop	Double	Optional	In Word / HTML output, the number of pixels to clip from the top.	N/A	N/A
hAlign	PowerPointImageHorizontalAlign	Optional	For PowerPoint output only, the ability to horizontally align images produced by macros, with vertical lines. No other image parameters apply (clipping, etc.).	Center Left Right	N/A
horizontalPositionAlignment	HorizontalPositionAlignment	Optional	In Word / HTML output, the horizontal position alignment.	Left Inline Center Right Inside Outside	Left
horizontalPositionRelativeTo	HorizontalPositionRelativeTo	Optional	In Word / HTML output, that the horizontal position is relative to.	Inline Margin Column Page InsideMargin OutsideMargin LeftMargin RightMargin	Inline
opacityPercent	Double	Optional	In Word / HTML output, the image opacity (0 is transparent, 100 is solid).	From 0 to 100	100
pageHeightPercent	Double	Optional	In Word / HTML output, the page height percentage. To ignore this, you must set both the 'imageWidthCm' and 'imageHeightCm' parameters.	From 0 to 300	N/A
pageWidthPercent	Double	Optional	In Word / HTML output, the page width percentage. To ignore this, you must set both the 'imageWidthCm' and 'imageHeightCm' parameters.	From 0 to 300	100
pictureFitType	ShapePictureFitType	Optional	When inserting into shapes (Word and PowerPoint), how the picture will fit to the shape: either cropped to fit (bottom of the Dashboard may be cropped), or stretched to fit. In PowerPoint, you must manually set the 'chartImageFormat' parameter to either Png or Jpeg, e.g. chartImageFormat=Png	CropToFit StretchToFit	CropToFit
titleHeadingLevel	Int32	Optional	In Word / HTML output, the title heading level. Don't specify if no heading is required.	N/A	N/A
vAlign	PowerPointImageVerticalAlign	Optional	For PowerPoint output only, the ability to vertically align images produced by macros, with horizontal lines. No other image parameters apply (clipping, etc.).	Bottom Middle Top	N/A
verticalPositionAlignment	VerticalPositionAlignment	Optional	In Word / HTML output, the Vertical position alignment.	Top Inline Center Bottom Inside Outside	Top
verticalPositionRelativeTo	VerticalPositionRelativeTo	Optional	In Word / HTML output, what the vertical position is relative to.	Inline Page Paragraph Margin BottomMargin InsideMargin OutsideMargin TopMargin	Inline
viewportHeightPx	Int32	Optional	Sets the viewport height in pixels. This represents the browser height that would be used to view the Dashboard, and should be set to a value that would show the full Dashboard without scrollbars. This is necessary because the Dashboard is actually captured by a 'virtual browser'. When the number is too small, the output image may show scrollbars, and if too large there may be unnecessary whitespace at the bottom. It is advisable to experiment to find the correct value. This parameter may be removed in future if the Dashboard rendering method changes.	N/A	2500
wrapping	Wrapping	Optional	In Word / HTML output, the image wrapping.	Inline BehindText	Inline

Chart (1)

Parameter	Type	Presence	Purpose	Options	Default
expandWidgetLegends	Boolean	Optional	Whether to expand the legends of graph Widgets on the Dashboard output image.	true false	false

Time & Date (2)

Parameter	Type	Presence	Purpose	Options	Default
endDate	DateTimeOffset	Conditional	The end date to use - the equivalent of setting the end date on the report in LogicMonitor. When set, 'startDate' must also be set. Note: using the [DateRange:] macro currently has no effect on this macro.	N/A	N/A
startDate	DateTimeOffset	Conditional	The start date to use - the equivalent of setting the start date on the report in LogicMonitor. When set, 'endDate' must also be set. Note: using the [DateRange:] macro currently has no effect on this macro.	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 (5)5 additional

Parameter	Type	Presence	Purpose	Options	Default
dashboardFullPath	String	Conditional	The Dashboard full path, e.g. Group 1/Subgroup/My Dashboard. Use either this or the 'dashboardId' parameter, but not both.	N/A	N/A
dashboardId	Int32	Conditional	The Dashboard ID to insert. Use either this or the 'dashboardFullPath' parameter, but not both.	N/A	N/A
description	String	Optional	In Word / HTML output, the description for visually-impaired users. This text also displays when the user hovers the mouse over the image in Word or a PDF viewer.	N/A	N/A
shapeId	String	Optional	The shape to insert the image into. In PowerPoint, when no shape ID is specified and the macro is contained inside a shape, that shape will be used. To set a shape's ID (it can be any text) in its Alt Text field, right-click on the shape then choose View Alt Text to open the edit panel and enter the ID there.	N/A	N/A
title	String	Optional	In Word / HTML output, the image title for visually-impaired users.	N/A	N/A

Additional (5)

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
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

Deprecated (1)

Parameter	Type	Preferred Parameter	Purpose	Options	Default
pptxPictureFitType	ShapePictureFitType	pictureFitType	When inserting into shapes (Word and PowerPoint), how the picture will fit to the shape: either cropped to fit (bottom of the Dashboard may be cropped), or stretched to fit. In PowerPoint, you must manually set the 'chartImageFormat' parameter to either Png or Jpeg, e.g. chartImageFormat=Png	CropToFit StretchToFit	CropToFit

Examples (4)

Example 1

This example inserts 3 Dashboards into the output document:

[LogicMonitor.DashboardGroupList: dashboardGroupFullPath=/, property=FullPath, recurse=true, =>FullPaths]
[ForEach: values=`{FullPaths}`, storeAs=FullPath, take=3]
[LogicMonitor.DashboardList: dashboardGroupFullPath=`{FullPath}`, property=Id, =>dashboardList]
[ForEach: values={dashboardList}, storeAs=dashboards]
[LogicMonitor.Dashboard: dashboardId={dashboards}]
[EndForEach:][EndForEach:]

Example 2

Insert a Dashboard (by ID) into a PowerPoint shape called 'MY SHAPE' (which is set in the shape's Alt Text):

[LogicMonitor.Dashboard: shapeId=MY SHAPE, dashboardId=205]

Example 3

Insert a Dashboard (by ID) into a PowerPoint shape called 'MY SHAPE' (which is set in the shape's Alt Text) and crop the image:

[LogicMonitor.Dashboard: shapeId=MY SHAPE, dashboardId=205, pptxPictureFitType=CropToFit]

Example 4

Insert a Dashboard (by full path) into Word:

[LogicMonitor.Dashboard: dashboardFullPath=/Folder 1/My Dashboard]