Forms: Dashboard

A dashboard allows a User to gather into a single view a set of charts and filtered lists of alarms and/or tasks.

This grouping of related reports and statistics provides the User with preconfigured overviews of selected areas, making all the data that is required to view and monitor the health of the system both accessible and easy to read.

Any number of dashboards can be constructed by dragging predefined Stream Views or Alarm Generators, onto a dashboard pane. General filtered lists of Alarms and Tasks can be added using the context sensitive menu on the dashboard pane.

Things added to the dashboard in this way are known as Dashboard Elements. Dashboard Elements are given short names which can then be used in expressions to refer to items selected in those Stream and/or Alarm Views. Select on the Dashboard Element to change these names.

Dashboards can be created as either 'public' or 'private' - a private dashboard is only visible to the owner. Users may also specify a personal 'default' dashboard which is opened automatically each time PhixFlow is started.

Form: Dashboard Details

Field	Description
Name	The name of the dashboard.
Owner	User that owns the dashboard.
Public	If ticked, all users can view and edit the dashboard. If not ticked, only the owner can view or edit the dashboard.
All Users Can View Data	If checked, this specifies that all users can view this dashboard by default (provided they have the basic privilege to view dashboards). If this field is not checked, then access to the dashboard is controlled by dropping user groups onto the stream's "User Groups" tab.
Open Maximised	If ticked, the dashboard opens fills the whole screen when it is opened.
Show Toolbar
Menu	This tab shows the Lists and Buttons which holds Stream Actions that can be applied for this Dashboard. Lists can hold Buttons and other Lists creating multi level menu. There are two ways to add Lists and Buttons: Click on the Actions icon at the top of the grid. A popup window will appear listing all the available actions. Drag an action from this popup form onto the grid. If you drop onto an existing Button you will be asked if you want to create a new Button or to create a list which will hold new Buttons and the Button the Actions you dropped onto. If you drop onto an existing List the selected Actions will be added to the List. Use the '+' icon at the top of the grid. You can decide if you want to create a Button or a List. You can add new Lists and Button to the existing List by following the same steps. See the Action Button Details form for details of each Action Button.
Description	Description of the dashboard.
User Groups	Adds a User Group to the User Group list. See the Role Details form.

Configuration

Splitter Bars

The Dashboard area can be divided into multiple, resizing panes by adding vertical or horizontal splitter bars. Right click the pane or any element on the pane to:

Add Vertical Bar
Add Horizontal Bar

Splitter bars can be removed by right clicking on an empty pane and selecting Delete Pane.

Layout Options

Right click any pane or element and select Layout Options to configure the following options:

Maximize contents
Set a fixed width
Set a fixed height

Add Element

An element can be added to a dashboard by dragging predefined Stream Views or Alarm Generators onto the dashboard pane.

General filtered lists of Alarms, Email Tasks, External Tasks, User Tasks and Timed Tasks can also be added by right-clicking on the dashboard pane and selecting the applicable option from the context sensitive menu .

Remove Element

You can remove an element from the dashboard by selecting from the element icon bar. This removes the object from the Dashboard view but will not delete the object from PhixFlow.

Link Dashboard Elements

You can link Dashboard views together so that the contents of one view are filtered based on items selected in a "Driver" view.

A grid view (grids only) will be automatically made a "Driver", if any of the filter expressions in any of the dashboard elements reference the view by name. Any views that are drivers can be identified by the existence of the icon appearing in the top right of the view. Clicking on this icon will cause any dependent views and charts to refresh themselves.

To make a Dashboard element dependent upon the Driver view, set it up with a Filter which uses at least one condition with an expression containing the drivers view name. i.e ACCTS. When the Filter is evaluated, the view name ACCTS notation will contain the rows selected on the Driver view. An example condition expression is:

AccountNum equals ACCTS.AccountNumber

Where AccountNumber is an Attribute on the Driver view.

Dashboard Pane Toolbar

This is found in the top, right-hand corner of the dashboard pane. This provides the following options:

	Display details for the Dashboard.
	Toggles the ability for the Dashboard owner to modify layout of the Dashboard. By default, the layout is locked, i.e. elements cannot be moved or resized. Note, however, elements may still be maximised in this mode. Pressing this icon enables layouts to be changed. Pressing the button again locks the layout.
	Prints the dashboard.
	Refresh will update the dashboard in line with changes made elsewhere in PhixFlow.

Forms: Chart Parameters

Stream and Alarm views on a Dashboard have parameters like short names (aliases) which can be used in expressions when referring to items selected on those views, data range and filter which can be used to control the list of records shown by the Dashboard Chart. This form allows you to change those parameters from their default values, which are taken from the original view.

The following fields are configured on the form:

Field	Description
Name	Name of the dashboard element.
Use Custom Data Range	Ticking the field allows to choose the different data range than is selected on the original view.
Data Range (visible only when Use Custom Data Range is ticked)	Range of Stream Sets which will be shown on the chart. The user can choose Latest Stream Set, All Stream Set or Custom number of Stream Sets
To Date (visible only when Use Custom Data Range is ticked and Data Range is set to Custom)	The maximum To Date of the Stream Sets shown on the chart
Number of Periods (visible only when Use Custom Data Range is ticked and Data Range is set to Custom)	The number of periods shown on the chart
Use Custom Default Filter	If you tick the checkbox, you can choose a default filter. This will override the default filter set in the original view, if one has been set.
Default Filter (visible only when Use Custom Filter is ticked)	The default filter applies to this dashboard element.
Background Filter	The background filter of this dashboard element. This will be applied in addition to the background filter of the original view, if one has been set. A default filter, if set, or user selected filters are applied on top of this background filter, and the view background filter.
Apply Selections Mode	Auto - Linked Views linked with the Driving View will refresh automatically after selecting a row. Manual - Linked Views linked with the Driving View will refresh after clicking on a Update the dashboard using the selected rows green button.

This form is also available from a Standalone Stream View. In that case settings are applied temporarily and will be lost after closing the View.

Form Icons

The form provides the standard grid icons.

dashboard