This page covers:
Viewing and Using Dashboards
| Anchor | ||||
|---|---|---|---|---|
|
...
You can display the charts generated by stream views in dashboards. You can also generate some types of charts without using a dashboard. For example, you can view the contents of a stream set in a grid; see Stream Set List.
...
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.
When you open an existing dashboard, it is locked by default. This means the dashboard cannot be edited, for example by selecting or moving elements and layout components. 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. To test buttons and actions that you have configured for a dashboard, you must switch to
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Dashboard Properties
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...
The toolbar includes the button to
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Basic Settings
| Field | Description |
|---|---|
| Name | The name of the dashboard. |
| Open Maximised | If ticked, the dashboard opens fills the whole screen when it is opened. |
| Allow User to Resize | If 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 Top | Always keep the dashboard on top. |
| Keep Data | If 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. |
| Preload | If ticked, PhixFlow preloads the dashboard as it is setting up. Preloading adds to PhixFlow's setup time. When the user then opens the dashboard, the layout displays immediately. The data itself may still take time to load. Use this option for dashboards that the user will always want to open when they use PhixFlow. |
| Cache Locally | If ticked, PhixFlow does not preload the dashboard. Instead, when the user opens the dashboard for the first time, PhixFlow caches it on the client computer. When the user closes and reopens the dashboard, the layout loads immediately. The data itself may still loads from the server. Use this option for dashboards that a user may want to open. |
Dashboard
...
Elements
A list of the dashboard elements on this dashboard.
Access Permissions
For details about how to control access to a dashboard, see Common Properties → Access Permissions.
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.
...
Form Icons
The form provides the standard form icons, as well as:
...
...
Configuration
...
Using Dashboard Options
To edit a dashboard, right-click and select Unlock Layout.
Splitter Bars
The Dashboard 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:
...
Where AccountNumber is an Attribute on the Driver view.
Dashboard Element Properties
| Anchor | ||||
|---|---|---|---|---|
|
...
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:
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Field | Description |
|---|---|
| Name | Name of the dashboard element. |
| Name of target | Name of the view underlying this dashboard element. |
Data Retrieval Options
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Refresh If Not Active | If 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 Range | Ticking 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. | Available when Use Custom Data Range is ticked.
This value will overwrite any data range specified on the backing stream. | ||||||||
| Use Custom Default Filter | If you tick the check box, 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. | ||||||||
| Refresh When Dashboard Refreshes? | Select one of:
|
Header Options
| Field | Description |
|---|---|
| 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 |
Background Filter Rules
| Field | Description |
|---|---|
| Evaluate These Filter Rules as an Or | Ticking this field means that the background filter rules will be combined as an "or" filter as opposed to an "and" filter |
| Background Filter Rules | A 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 |
| Filter | The Filter that will be used should the Rule Expression evaluate to true |
| Order | The 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 True | If true and the Rule Expression evaluates to true then any subsequent filter rules will not evaluated |
| Description | A Description of the filter rule |
Dashboard Context Menu
Right-click on a dashboard to display the context menu for it.
...