Page Comparison

...

Date/Time Format

Field Description

Basic Settings

Name The name of the stream view. By default, a space will be included before each capital letter. For example, the name CustSpendAverage will be displayed in the column heading as Cust Spend Average.

Display Type

A number of chart types are available:

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 stream data laid out in a table.
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 stream data laid out in a table, 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 - a stream attribute of type Date or Datetime.

HELPDEVTODO: no file download button on form; is this still correct anyway? If display type is a chart and the user elects to output the chart to HTML (either via a File Exporter or from a chart, PhixFlow will output the chart to HTML as a picture (.PNG).

Default Sort Order If specified, the default order in which data should be displayed. See the Stream View Sort Order form.

Default Filter Any filter on the stream can be selected as the default filter for this view.

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

Form View

Tick this box to make this a form view. This can be used to accepting input from a user, for an insert or update action.

View Attributes

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:

Order The order in which the attributes will appear in the view. For a grid view, this is the order of columns.

Name

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.

Stream Function

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.

Role

This setting only shows if the view is a chart, i.e. not a data grid. This is the role that the field has in generating the chart.

HELPDEVTODO: are there fairly generic descriptions for roles that are worth putting in, or is it only worth describing these in context for each chart type?

Decimal Places This field will only show if the underlying stream attribute has type Float. The number of decimal places to display.

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.

Decimal Places This field will only show if the underlying stream attribute has type Date Float. The number of decimal places to display.

Date/Time Format This field will only show if the underlying stream attribute has type Date or Datetime. See toString for a description of display formats.

Hidden

HELPDEVTODO: not shown for charts, should it be? If not, put in Grid Settings section

Whether the field is shown on the view. Sometimes you need to include fields in views so that they can be used in filters and Actions, but displaying them would make the view cluttered. Make the field hidden.

_{Stream Attribute Details}

Name

The name of the underlying stream attribute.

Type The type of the underlying stream attribute. This cannot be edited here. It must be edited in the Stream.

Grid Settings

These settings are only available for view attributes for grid views

Grid Default Width (pixels) Set the default width of the column for this attribute. PhixFlow will create the grid with default column widths - you only need to specify a value in this field if the width you want is different from this default.

Label

An optional label for the resulting column header. If left blank, this is the Name of the stream view attribute.

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

Label is Expression Tick this box if you want to set the Label using an expression.

Changes Row Colour If ticked, the row colour changes whenever the value in this field changes.

Alignment

Set the alignment of values in this column to:

Left
Right
Centre

Form Settings

These settings are only available for form views - that is, grid views that have Form View ticked.

Read Only This makes the field read-only in the form view.

Height On Form (pixels) Sets the height of the form field for this attribute. PhixFlow will create the form field with a default height - you only need to specify a value in this field if the height you want is different from this default.

Width On Form (pixels) Sets the width of the form field for this attribute. PhixFlow will create the form field with a default width - you only need to specify a value in this field if the width you want is different from this default.

Multiline on Form If ticked, users can press the Enter key to create multiple lines in this field, or copy multi-line text into this field.

Selection View Attribute

This sets the dropdown list from which the user can pick a value. Drag the stream view attribute that you want to use for the dropdown list into this field. The Show the dropdown 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 Selection View Attributes below for an example of configuring selection view attributes.

If another stream view attribute has a Selection View Attribute set and has Show the dropdown button set to yes, then it is possible to set the current stream view attribute from the same selection view without a further dropdown 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.

Show the dropdown button See Selection View Attribute above.

Formatting Rules

A list of the formatting rules that apply to this field in the view.

For each formatting rule, set the following fields:

Rule Expression

Style Select a style from the drop-down list, or create a new style.

Order The order in which the formatting rules are applied.

Enabled Stop if True Form (pixels) Sets the width of the form field for this attribute. PhixFlow will create the form field with a default width - you only need to specify a value in this field if the width you want is different from this default.

Multiline on Form If ticked, users can press the Enter key to create multiple lines in this field, or copy multi-line text into this field.

Selection View Attribute

This sets the dropdown list from which the user can pick a value. Drag the stream view attribute that you want to use for the dropdown list into this field. The Show the dropdown 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 Selection View Attributes below for an example of configuring selection view attributes.

If another stream view attribute has a Selection View Attribute set and has Show the dropdown button set to yes, then it is possible to set the current stream view attribute from the same selection view without a further dropdown 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.

Show the dropdown button See Selection View Attribute above.

Formatting Rules

A list of the formatting rules that apply to this field in the view. This section only appears when you are configuring a grid 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:

Rule Expression An expression to govern whether this rule will be applied to this field in the grid. If this expression evaluates to true, the rule will be applied.

Style Select a style from the drop-down list, or create a new style.

Order The order in which the formatting rules are applied.

Enabled Whether the rule is currently active.

Stop if True If ticked, if this rule evaluates to true, no styles that follow this will be applies, regardless of the result of their Rule Expression.

Description A description of the formatting rule.

Refresh Actions

This tab shows the 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 StreamView.

Excel Template

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.

Number of Periods Number of processing periods from the stream to display on the chart. If a full set of data is generated in each period, then this will be 1. If the data is spread across processing periods in the stream - for example, each processing period only contains new data for that day, but we want to plot data across a number of days - then this number must be high enough to include all data of interest to show on a chart.

Background Filter Any filter on the stream can be selected as the background filter for this view. When the user opens this view the background filter is applied first and any other filter applied to the view (either specifically created/selected by the user or automatically applied as the default filter described above) acts in addition to the background filter.

All Users Can View Data If checked, this specifies that all users can view this stream view by default (provided they have the basic privilege to view stream views). If this field is not checked, then access to the stream view is controlled by dropping user groups onto the stream's "User Groups" tab.

Default Width The default width of the Stream View. If empty, the View's width will be set to the system default value.

Default Height The default height of the Stream View. If empty, the View's height will be set to the system default value.

...

The following fields are configured through separate tabs on the form:

See the Stream View Attribute Details form.

Field	Description	View Attributes		Description
Menu	This tab shows the Lists and Buttons which holds Stream Actions that can be applied when Stream Item Details are accessed from this view. Lists can hold Buttons and other Lists creating multi level menu. 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. 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 to create a list which will hold new Buttons and the Button the Actions you dropped onto. If you drop onto an existing List the selected Actions 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 or a List. You can add new Lists and Button to the existing List by following the same steps. See the Action Button Details form for details of each Action Button.	Refresh Actions	This tab shows the 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 StreamView.

Filters	This tab shows the list of Filters which will be available in the drop down list of filters accessible from the filter icon in the header of the StreamView. There are two ways to add a Filter to this list: Click on the Filter icon at the top of this form. A popup window will appear listing all the available filters. Drag a filter from this popup form onto this tab. Go to the parent Stream's Filters tab and drag filters into this tab.
User Groups	A list of user groups associated with the Stream View.
Description	Description of the stream view.

...

Versions Compared

Old Version 19

New Version 20

Key