...
...
...
...
...
...
...
...
...
...
The following fields are configured for stream views:
...
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
A list of attributes displayed in the view, or to build a chart. Press to bring up a list of attributes for the stream, and drag the attributes you want to add to the view into this list.
For each attribute, the following fields are shown:
...
The display name of the attribute in the view. By default, this is the same as the name of the attribute in the underlying stream.
Remember that if you are applying an Aggregate Function to the attribute, it is often useful to reflect that in the display name. For example: you are going to display the average monthly spend for each customer, by applying the aggregate function Average to the attribute CustSpend
. You set the display name as CustSpendAverage
.
...
You can specify an Aggregate Function on this attribute. As soon as you have specified a single aggregate attribute in your view, any other fields will be either aggregate attributes - if you also specify an aggregate function for them - or used as grouping attributes.
...
This option is available if the view is a chart, i.e. not a data grid. This is the role that the field has in generating the chart.
You can set the role manually in the stream view attribute editor - but it is generally better to create charts using the visual editor. To do this:
- drag your stream view into a dashboard
- make sure you are in design mode
- unlock the padlock in the view (if it is not already unlocked)
You will see a visual chart editor. You can drag stream attributes onto this editor to create your chart. See Pivot Views and Charts, below.
...
This check box is only available if an Action is specified.
...
This check box is only available if an Action is specified.
...
This check box is only available if an Action is specified.
...
...
...
...
Name
...
This field is only available when the underlying stream attribute has the type Float, Integer or Decimal.
Specify the number format as it will be displayed on a grid or form; see Number Format.
...
This field is only available when the underlying stream attribute has the type Date or Datetime.
Specify the format of a date/time as it will be displayed on a grid or form; see Date Time Format.
...
...
...
...
An optional label for the resulting column header. If left blank, this is the Name of the stream view attribute, formatted with a space before each capital letter.
The label gives you more options for setting the column header - for example, control over the white space in the column heading - but you can also make this an expression. For example, to that the column contains transactions for the currently logged in user, you could use:
Code Block |
---|
"Transactions for " + _user.username |
For user pchevalier
, this would give the column heading:
Code Block |
---|
Transactions for pchevalier |
To use an expression in this field, tick the box Label is Expression.
Multi-level labels can be generated by configuring the Label to return a list of values.
...
...
...
...
Use this option when you need to include a field in a view for a filter or Action, but displaying it would make the view cluttered.
...
Enter an expression that determines whether or not the attribute's field is displayed on the view. When the expression evaluates to true, then the field will be hidden.
When Always Hidden is ticked, the result of this expression is ignored.
...
Set the alignment of values in this column to:
- Left
- Right
- Centre
...
This sets the drop-down list from which the user can pick a value. Drag the stream view attribute that you want to use for the drop-down list into this field. The Show the drop-down button option must be ticked to display the drop-down.
When a user is entering or updating data using a form view, you can use the internal variable _form to use a value already entered in the form in the filter on a selection view. That is, the values that appear in a drop-down list will be governed by values they have entered so far in the form. See Configuring Pivot Details on the View below, for an example of configuring selection view attributes.
If another stream view attribute has a Selection View Attribute set and has Show the drop-down button set to yes, then it is possible to set the current stream view attribute from the same selection view without a further drop-down list. Drag the stream view attribute that you want to use to set this stream view attribute into this field
Drag the attribute out of the field to delete the contents of the Selection View Attribute.
...
A list of the formatting rules that apply to this field in the view. This section only appears when you are configuring a grid or pivot view.
All formatting rules whose Rule Expression evaluates to true will be applied to the field in the grid. However, you can tick Stop if True so that, if a rule evaluates to true, no styles that follow this in the list of rules will be applied - regardless of the result of their Rule Expression.
For each formatting rule, set the following fields:
...
...
...
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 Stream's Actions tab and drag actions into this tab. The stream does not have to be the parent of this stream view.
...
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:
...
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:
...
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
...
Access Permissions
For details about how to control access to a stream view, see Common Properties → Access Permissions.
...
...
...
...
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.
...
Configuring pivot attributes
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 (Stream 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.
...
For pivot views, the following section will appear in the view details:
...
This controls how the field given the role Pivot Column will be used to generate columns in the pivot table. 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.
...
Chart view details
For charts, the following section will appear in the view details:
...
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.
...
Line Chart (time)
The following fields only apply for charts of type Line Chart (time). These apply to the horizontal axis, which in this case is a time series:
...
Chart attributes
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.
Colouring grid rows
The colours of rows in grid views can be set by creating a stream 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.
Stream 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.
...