PhixFlow Help

Dashboard

This page covers:

Viewing and using dashboards

The charts generated by stream views are presented in dashboards. Certain kinds of chart can also be generated ad-hoc, for example, to view the contents of a stream set from a stream set form, a Data Grid is produced.

Chart type: Data Grid

A Data Grid is a simple chart type, displaying the data in a table format.

Details for an individual Stream Item can be viewed by double clicking on a row. This bring up the Stream Item Form with details of the Stream Item selected.

Chart buttons

Charts provides the standard grid icons.

They also provides the following icons:

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.

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.

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

Configuring dashboards

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

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

Any number of dashboards can be constructed by dragging predefined Stream Views onto a 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 Views.

Form: Dashboard Details

FieldDescription
NameThe name of the dashboard.
Open MaximisedIf ticked, the dashboard opens fills the whole screen when it is opened.
Allow User to ResizeIf ticked, the user can change the size of the dashboard while in app mode. All designers can still change 
Show Toolbar Show the toolbar on the dashboard.
Always On TopAlways keep the dashboard on top.
Keep DataIf ticked, the dashboard data is available and can be referenced even after the dashboard is closed. It can be used if the user wants to store global data available in the system.
PreloadIf ticked, the system will preload the dashboard while loading, so when requested, the dashboard will open much faster.
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.

Form Icons

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

Display the dashboard.

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.

Add Element

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

Remove Element

You can remove an element from the dashboard by 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.

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.

Forms: Dashboard Element

Stream 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:

FieldDescription
NameName of the dashboard element.
Name of targetName of the view underlying this dashboard element.
Data Retrieval Options
Refresh If Not ActiveIf ticked, the dashboard will refresh even if not active (e.g. after the driving selection changes). Otherwise it will refresh as soon as it becomes active.
Use Custom Data RangeTicking the field allows to choose the different data range than is selected on the original view.
Data RangeRange 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 FilterThe default filter applies to this dashboard element.
Refresh When Dashboard Refreshes?

Select one of:

  • Always
  • Never
  • Always except on first load
Header Options
Display Export ButtonToggle the export button on the view in the dashboard
Display Filter ButtonToggle the filter button on the view in the dashboard
Display Paging ButtonToggle the paging button on the view in the dashboard
Display Refresh ButtonToggle the refresh button on the view in the dashboard
Display Sort Order ButtonToggle the sort order button on the view in the dashboard
Background Filter Rules
Evaluate These Filter Rules as an OrTicking this field means that the background filter rules will be combined as an "or" filter as opposed to an "and" filter
Background Filter RulesA grid of background filter rules which are combined together (usually as an and conjunction) to create the background filter for the dashboard element 
Background Filter Rules have the Following attributes:
Rule Expression The Expression for this Filter rule, if it evaluates to true then the filter associated with this filter rule will be used
FilterThe Filter that will be used should the Rule Expression evaluate to true
OrderThe order in which the filter rules for this dashboard element will be evaluated
Enabled

If not true, this filter will not be used

Stop If TrueIf true and the Rule Expression evaluates to true then any subsequent filter rules will not evaluated
DescriptionA Description of the filter rule

Form Icons

The form provides the standard form icons.

See Also

Please let us know if we could improve this page feedback@phixflow.com