Dashboards

This context is a container, holding all dashboards for a particular user.

Unique Actions

[?]

Create Dashboard

(Default Action)

This action is used for creating new dashboards. It allows user to specify basic properties of the new dashboard and configure it immediately after creation.

Action Type:

Create

Permissions:

Accessible at Manager permission level.

This action is used for printing several dashboards into a single merged PDF document. You can set up the input parameters of the printed version as described in the Print Multiple function.

Action Type:

Call Function

Action Name:

printMultiple

Permissions:

Accessible at Observer permission level

Common Actions

[?]

Create From Template, Replicate To Children, Import, Export, Edit Context Permissions, Monitor Related Events, Search/Filter, various Grouped Actions according to child contexts.

Context States and Icons

This context has no states. It is always represented by the icon.

Advanced Information

Context Information

Context Type: dashboards

Context Name: dashboards

Context Description: Dashboards

Context Path: users.USER_NAME.dashboards

Context Mask: users.*.dashboards

Context Permissions

[?]

Level

Description

None

No access allowed.

Observer

Basic event monitoring.

Operator

Same as Observer.

Manager

Dashboard creation, export and import.

Engineer

Same as Manager.

Administrator

Same as Manager.

Public Variables (Properties)

[?]

This context has no public variables (properties).

Public Functions

[?]

Common Functions: makeCopy (Make Copy), delete (Delete)

Create

Creates new dashboard.

Function Name:

create

Permissions:

Accessible at Manager permission level.

Input Records:

1

Input Format:

Same as format of childInfo variable in Dashboard context.

Output Records:

0

Output Format:

none

Prints several dashboards into a single merged PDF document. For an overview of printable dashboards and merged PDF generation, see Printable Dashboards.

Function Name:

printMultiple

Permissions:

Accessible at Operator permission level

Input Records:

0…Unlimited

Input Format:

 

 

 

Name

Type

Description

reportPath

String

Path of the dashboard context to print.

params

Data Table

Print parameters for the dashboard. Uses the same structure as the input of print.

firstPage

Integer

Optional first page number set for this dashboard.

Output Records:

1

Output Format:

 

 

 

Name

Type

Description

result

Data

Generated merged PDF file.

totalPages

Integer

Total number of pages in the merged document.

Public Events

[?]

Common Events: info (Information)

Was this page helpful?