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. Dashboard Elements 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:
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. | |
| Show the toolbar on the dashboard. | ||
| Always On Top | Always keep the dashboard on top. | |
| Dashboard Elements | ||
| A list of the dashboard elements on this dashboard. | ||
| User Groups | ||
| A list of the user groups which can view this dashboard. This tab is only shown if All Users Can View Data is not selected. | ||
| Description | ||
| Description | Description of the dashboard. | User Groups | Adds a User Group to the User Group list. See the Role Details form
Form Icons
The form provides the standard form icons, as well as:
| Display the dashboard. |
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:
...
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.
...
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:
...
...
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. |
| Anchor | ||||
|---|---|---|---|---|
|
...
Dashboard Element
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. |
| Name of target | Name of the view underlying this dashboard element. |
| Data Retrieval Options | |
| Use Custom Data Range | Ticking the field allows to choose the different data range than is selected on the original view. |
| Data Range | |
| Range of Stream Sets which will be shown on the chart. The user can choose Latest Stream Set |
| or All Stream Sets. | |
| 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 |
| 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. |
| Refresh When Dashboard Refreshes? | Select one of:
|
HELPDEVTODO not yet added 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. |
...
| Header Options | |
| Display Export Button | Toggle the export button on the view in the dashboard |
| Display Filter Button | Toggle the filter button on the view in the dashboard |
| Display Paging Button | Toggle the paging button on the view in the dashboard |
| Display Refresh Button | Toggle the refresh button on the view in the dashboard |
| Display Sort Order Button | Toggle the sort order button on the view in the dashboard |
Form Icons
The form provides the standard grid form icons.