Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

They also provides the following icons:

Image Removed

Shows a list of any Stream Actions associated with the Stream View. The user may select one of these actions e.g. to update specific data on the grid.

Image Removed

Image Added

Refresh the chart.

Select an existing (or predefined) Filter or create, delete and modify Filters. This causes the chart to refresh and display only those entries which match the selected Filter.

Select an existing (or predefined) multi-column Sort Order or create, delete and modify Sort Orders. Note that data is ordered across all records which are implied by the Filter, not just the current page of data.

Image Removed

Pressing this icon toggles the display of other standard icons and the additional icons below.

Image Removed

Displays summary details of the Stream View.

Image Removed

Displays detail common to Dashboard Elements. This icon is only displayed when a Stream View is added to a Dashboard.

Image Removed

Modifies selected items displayed in the Chart. When this button is pressed, a form containing all fields in the Chart will appear. If a value is entered into any of these fields, the value will be applied to all items displayed.

Image Removed

Exports the data currently being viewed in the grid using a Database Exporter or a File Exporter. The user can select an exporter from the list of Database and File Exporters attached to the underlying stream.

Note that this will export all data, not just the current paged result. However, any filters on the pipe connecting the stream to the Database or File Exporter selected will be applied, so not all records displayed in the Chart may be exported - some may be filtered out in the pipe.

Image Removed

Shows Alarms associated with this Chart.

Image Removed

Shows the configuration of the underlying Stream.

Opens the download data form allowing the user to export just the selected items or all data on the chart as either an Excel file, a CSV (comma separated) file or as an HTML document.

Image Removed
Shows the list of Stream Views

Image Added

Display the number of records in the data, and the number of records currently being displayed.

Anchor
configuringDashboards
configuringDashboards
Configuring dashboards

A dashboard allows a User you to gather into a single view a set of charts.

This grouping of related reports and statistics provides the User users with preconfigured pre-configured 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.

...

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

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

FieldDescription
NameThe name of the dashboard.
PublicIf 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 DataIf 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 MaximisedIf ticked, the dashboard opens fills the whole screen when it is opened.
Show Toolbar Show the toolbar on the dashboard.
Always On TopAlways keep the dashboard on top.
Dashboard Elements
A list of the dashboard elements on this dashboard.

Access Permissions

All Users Can View DataIf ticked, 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 in the the user group list.
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
DescriptionDescription of the dashboard.

...

The form provides the standard form icons, as well as:

Display the dashboard.

Anchor
dashboardElement
dashboardElement

Configuration

Dashboards open locked by default (elements cannot be moved or edited and buttons carry out updates even in design mode). In design mode, right click on the dashboard area to unlock it. The previous locked status is remembered when switching back to design mode from app mode.

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:

...

...

Add Element

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

...

You can remove an element from the dashboard by selecting Image Removed from the element icon bar. This removes the object from the Dashboard view but will not delete the object from PhixFlow.right clicking on the view and going to Dashboard Options → Remove Element From Dashboard

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 Image Removed 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:

Code Block
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:

...

Image Removed

...

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.

...

Image Removed

...

.

Anchor
dashboardElement
dashboardElement
Forms: Dashboard Element

...