Dashboard

This context lets you access and manage a single dashboard.

Unique Actions

[?]

Open Dashboard

(Default Action)

This action opens a dashboard.

Action Name:

open

Permissions:

Accessible at Observer permission level

Execution Parameters:

  • Window Path. Can be specified as a String windowPath field of action's input table. Causes the dashboard to get opened inside a specific window (e.g. another dashboard).

Configure

This action is used to edit Dashboard properties.

Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier.

Action Type:

Configure

This action is used for printing the current dashboard to a PDF document. You can configure page orientation, scaling, paper size, page margins, default context, custom properties, and output mode for the printed version as described in the Print function.

For an overview of printable dashboards and dashboard printing workflow, see Printable Dashboards.

Action Type:

Call Function

Action Name:

print

Permissions:

Accessible at Observer permission level

Common Actions

[?]

Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status

Context States and Icons

Icon

Code

State

0

This dashboard is relative.

1

This dashboard is absolute.

2

This dashboard is a class instance dashboard.

Advanced Information

Context Information

Context Type: dashboard

Context Name: provided by user

Context Description: provided by user

Context Path: users.USER_NAME.dashboards.DASHBOARD_NAME

Context Mask: users.*.dashboards.*

Context Permissions

[?]

Level

Description

None

No access allowed.

Observer

Opening the dashboard.

Basic event monitoring.

Status browsing.

Operator

Configuration browsing.

Manager

Dashboard configuration and removal.

Engineer

Same as Manager.

Administrator

Same as Manager.

Public Variables (Properties)

[?]

Common Variables: groupMembership (Group Membership), validity (Validity), activeAlerts (Active Alerts)

Properties

See description of the variable and its fields here.

Variable Name:

childInfo

Records:

1

Permissions:

Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name

Field Type

Notes

name

String

1 - 50 characters

description

String

1 - 50 characters

title

String

Nullable

type

Integer

printable

Boolean

Enables printable dashboard mode. Default value: false. For an overview of printable dashboards and printable rendering, see Printable Dashboards.

validityExpression

String

validityListeners

Data Table

Elements

See description of the variable and its fields here.

Variable Name:

elements

Records:

0...unlimited

Permissions:

Readable at Observer permission level, writable at Manager permission level

Record Format for Desktop dashboards:

Field Name

Field Type

Notes

title

String

type

Integer

location

Data Table

parameters

Data Table

validityExpression

String

Record Format for Web dashboards:

Field Name

Field Type

Notes

name

String

type

Integer

parameters

Data Table

Public Functions

[?]

Print

This function is used to print the current dashboard to a PDF document. For an overview of printable dashboards and dashboard printing workflow, see Printable Dashboards.

Function Name:

print

Permissions:

Accessible at Operator permission level

Input Records:

1

Input Format:

 

 

 

Name

Type

Description

orientation

Integer

Page orientation. Supported values:

0 - Portrait

1 - Landscape.

scale

Integer

Scaling mode. Supported values:

0 - Normal

1 - Fit to Width

2 - Fit to Height

3 - Fit to Page

4 - Custom Number.

scalePercent

Integer

Custom scale percentage used when scale is set to 4.

paperSize

String

Paper size, for example A4, A3, A5, or Custom.

topMargin

Integer

Top margin.

bottomMargin

Integer

Bottom margin.

leftMargin

Integer

Left margin.

rightMargin

Integer

Right margin.

dc

String

Optional default context.

customProperties

Data Table

Optional custom properties passed to printable rendering.

Output Records:

1

Output Format:

 

 

 

Name

Type

Description

result

Data

Generated PDF file. File name: <dashboardName>.pdf.

totalPages

Integer

Total number of pages in the generated document.

Public Events

[?]

Common Events: info (Information)

Was this page helpful?