This page is for data modellers and application designers whe want to select specific attributes to appear in a dashboard, and to format how the data will be displayed.
Overview
Views allow you to present data from a stream in the form you wish:
- as a data grid or chart
- sorted and ordered as required
- showing data from the latest run, or across all time.
Reports can be sent out from PhixFlow by emailing the output of a File Exporter, a Task Plans , or a Dashboard.
Properties
Basic Settings
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
CustSpendAverage
will be displayed in the column heading as Cust Spend Average
.- Barchart: plot a quantity as a set of bars against a set of categories along the horizontal axis.
- 3D Barchart: a 3D version of the standard barchart.
- Barchart (horizontal)
- Grid: show data laid out in a grid.
- Line Chart (category horizontal axis): plot line, or lines, representing quantities against a horizontal axis of 'categories'. The categories are printed along the horizontal axis, ordered alphanumerically.
- Line Chart (numeric horizontal axis): plot line, or lines, representing quantities against a numerical horizontal axis.
- 3D Pie Chart: a 3D version of the standard pie chart.
- Pie Chart: show a quantity as a pie chart, grouped by a category.
- Pivot: show data laid out in a stream, with data for values of one attribute broken out ('pivoted') into multiple columns.
- Stacked Barchart: a bar chart where multiple series/multiple attributes per category are displayed in a stacked form.
- Line Chart (times series horizontal axis): plot line, or lines, representing quantities against a date/time value - an attribute of type Date or Datetime.
Default Action
Changed to Double-click Action
The action that will be applied when users double-click on a row in a data grid. Often this is an update action - that allows users (if they have permissions to run the action) to update the record. But you can make this open a read-only detailed view of the record if that is more useful for most users. See Action.
Todo-Fiona - check
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
View Attributes
Fiona-todo: check if this is changed
A list of attributes displayed in the view. Click to show the list of attributes for the stream. Drag the attributes you want to add to the view into this list.
In the list:
- Make Pivot Value
- Make Pivot Column
- Make Pivot Row
- Make Pivot Label
- Make Pivot Row Total
Refresh Actions
A list of Refresh Actions which are all the actions that, following their execution, will cause this view to be refreshed.
To add a Refresh Action go to a the Actions tab and drag actions into this tab. The stream does not have to be the parent of this view.
Drop Targets
A list of the Drop Targets that this view will contain. To add a drop target, click on the + button at the top of the grid.
For each Drop Target you set the following fields:
Menu Items
OWN PAGE??
A list of the buttons, menus and sub-menus that will be presented on this view - which buttons are available to users depends on whether they have permissions to run these actions.
Only actions that belong to the parent stream can be added to a view.
There are three 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 on the parent stream
- 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
- create a list which will hold the new button and the button you dropped the new action on to
- If you drop onto an existing list, the dragged action will be added to the list
- Go to the Stream Details Actions tab and drag actions into this tab
- Use the '+' icon at the top of the grid
- You can decide if you want to create a button, menu or sub-menu.
For each button you set the following fields:
Available for sub-menus.
todo-fiona more info
Filters
The list of filters which will be available to users in the drop-down list of filters on the view.
There are two ways to add a filter to this list:
- Click on the filter button in this section
- A popup window will appear listing all the available filters on the parent stream
- Drag a filter from this popup into the list
- Go to the parent stream's filters and drag filters into this list
- see Filter
Access Permissions
For details about how to control access to a view, see Common Properties → Access Permissions.
Advanced
Row Selection Style
An Excel template can be linked to the view to specify the format the chart data should be exported in.
The location that excel templates must be saved to is specified in the System Configuration.
Style Settings
Options for styling grids,
see Style.
Chart LayoutAvailable when Type is one of the chart view options.
Show Horizontal Axis
Vertical Axis
If fixed scale is turned on, the the maximum value and minimum value defined will always be used as the highest and lowest points on the vertical axis, regardless of the data plotted.
Chart Layout: Line Chart (time)
Available when Type Line Chart (time). These apply to the horizontal axis, which in this case is a time series:
todo-fiona - these options are not showing
Configuring View Attributes for Charts
The best way to configure the chart attributes is to add the chart to a dashboard, and then use the graphical chart builder in design mode to set the attributes to create the chart you need.
You can, however, set the role of each attribute manually if you wish.
Pivot View PropertiesFor pivot views, the property tab includes the following settings.
This controls how the field given the role Pivot Column will be used to generate columns in the pivot stream. Choose from one of:
- View Data - the pivot columns are generated directly from the data in the Pivot Column field. If a field has been given the role Pivot Label, the label values corresponding to values in the Pivot Column field will be used as pivot column headers. The is the simplest way to generate the pivot columns, but does not allow any control of the order of values, or the ability to handle missing values e.g. when generating standard reports
Expression - the pivot column values are the result of an expression.
If Pivot Column Source == Expression, this expression must return either a list of values or a list of pairs of values (the values and corresponding labels).
The expression can refer to any lookup pipe that is an input to the parent stream of the view.
E.g.
Code Block |
---|
['20150101', '20150201', '20150301'] |
In this example the resulting view displays three pivot columns.
The pivot view only displays data where the value of the pivot column attribute equals one of the three quoted values - data that does not match any of the pivot column values is ignored.
The pivot column labels are generated from the pivot values using the formatting rules of the Pivot Column field. In particular, the Label expression can be used to generate formatted label values automatically. If no formatting or Label expression is provided, a default label is generated. This is the recommended way of formatting column labels.
E.g.
Code Block |
---|
[['20150101', 'January 2015'], ['20150201', 'February 2015'], ['20150301', 'March 2015']] |
In the second example, the same data is displayed, but the column headers are provided in the second values for each pivot column.
This method of setting column labels is not recommended, and is provided for compatibility with existing pivot views.
This is the maximum number of pivot columns that can be displayed. If this is blank, the system-wide default in System Configuration is used.
The stream view attributes for a pivot table must have the following roles set.
Todo-Fiona I can't see where to set the roles
To configure a pivot view, add attributes and set the role of each attribute according to these rules.
Each attribute must be assigned to one of these roles.
This field will be used to generate columns in the pivot table. See Configuring Pivot Details on the View below.
Formatting of the column headings will be controlled by the formatting options set on this view attribute.
A Pivot view must have one and only one Pivot Column attribute.
This field will be used to generate the rows of the pivot.
A Pivot View can have any number of Pivot Row attributes.
If Pivot Column Source == View Data, this attribute provides the pivot column headings. In most cases, the number of values for the pivot label should be exactly the same as the number of values for the pivot column.
A Pivot View can have at most one Pivot Column attribute. See Configuring Pivot Details on the View below.
The values in this field will be used to generate the data values in the pivot.
You must apply an aggregate function (Table Function) to this attribute - to provide the sum, max, min, etc. of these values for each row and column.
A Pivot view must have one and only one Pivot Value attribute.
Each Pivot Row Total attribute generates a value for each row calculated as an aggregate of the individual pivot column values.
The aggregate function can be any single-valued Aggregate Function (Sum, Minimum, Maximum, Average, Count).
A Pivot View can have any number of Pivot Row Total attributes.
Grid View: How to Configure Coloured Rows
The colours of rows in grid views can be set by creating an attribute called gridRowColour
, and adding this to the view. This value will not be shown in the grid.
The value of this attribute must evaluate to either a hexadecimal value representing a colour or to the lower case name of one of the basic HTML colours. Visit www.w3schools.com/tags/ref_colorpicker.asp to see how hexadecimal values correspond to real colours. The table below lists the basic HTML colour names:
You are recommended to avoid dark colours as they make data in the grid very hard to read.
View Context Menu
Opens a list of all of the attributes (column headers) for this stream view. Attributes formatted in italics are present in the stream but are hidden in the grid.
To change whether an attribute is hidden or visible, right-click the attribute and select Show this column or Hide this column.