PhixFlow Help

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

Stream 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; etc.

The following fields are configured for stream views:

FieldDescription
Basic Settings
NameThe name of the stream view.
Display TypeA 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 OrderIf specified, the default order in which data should be displayed. See the Stream View Sort Order form.
Default FilterAny filter on the stream can be selected as the default filter for this view.
Default ActionThe 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.
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:

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

Decimal PlacesThis field will only show if the underlying stream attribute has type Float. The number of decimal places to display.
Date/Time FormatThis field will only show if the underlying stream attribute has type Date or Datetime. See toString for a description of display formats.
HiddenWhether 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.
TypeThe type of the underlying stream attribute. This cannot be edited here. It must be edited in the Stream.
Grid Settings










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 PeriodsNumber 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 FilterAny 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 DataIf 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 WidthThe default width of the Stream View. If empty, the View's width will be set to the system default value.
Default HeightThe default height of the Stream View. If empty, the View's height will be set to the system default value.
Form View

Check box to determine if this view is to be used as a Form View. 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 selection view attributes for details of using selection views to create drop down lists.

Values governing the appearance of charts are configured in the Chart Layout tab.

The following fields apply to Pivot views:

FieldDescription
Pivot Column Source

The pivot column source determines how the the values that are converted to Pivot Columns are generated:

View Data

The pivot column values are read from the Column Attribute in the data being viewed.

If the Label Attribute is specified, the label values corresponding to the value attribute values are used as pivot column headers.

The is the simplest way to derive the pivot column values, 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 no labels are provided, they are derived from the pivot values using the formatting options set on the Column attribute.

Pivot Column Expr

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). E.g.

['20150101', '20150201', '20150301']

or

[ [ '20150101', 'January 2015'], [ '20150201', 'February 2015'], [ '20150301', 'March 2015'] ]

The expression can refer to any lookup pipe that is an input to the Stream being viewed.

If no labels are provided, they are derived from the pivot values using the formatting options set on the Column attribute.

Row AttributesThe row attributes will be displayed on the left of the view.
Maximum Pivot ColumnsThis is the maximum number of pivot columns that can be displayed. If this is blank, the system-wide default in System Configuration is used.

Column attribute

Values in the Column Attribute are mapped to separate columns in the resulting view.

The formatting options on the attribute (decimal places, date/time format) can be used to automatically generate column headers corresponding to Column Attribute values.

Value Attribute

When the view is displayed, the value in this Value Attribute will be displayed in the column corresponding to the value in the Column Attribute.

A Pivot View is not automatically grouped. To make this a grouped view, you should set the value attribute's aggregate function (e.g. to SUM).

Label AttributeIf Pivot Column Source == View Data, this attribute provides the pivot column labels corresponding to the column values. In most cases, the number of values for the label attribute, should be exactly the same as the number of values for the column attribute.

 

The following fields apply to all graphs, that is, all display types other than Grid or Pivot:

FieldDescription
Default ResolutionSet the default resolution for the generated graph. Larger values will produce a more finely grained image, and equivalently smaller fonts, sometimes useful when using graphs containing a large amount of data. Smaller values will produce a bolder, less finely grained image, sometimes useful for producing a clearer graph when there is not much data to display.
Minimum ValueMinimum value along the vertical axis to be displayed. This value will be lowest point on the vertical axis if any value in the data plotted falls below this value. Otherwise, the graph will be automatically sized as normal.
Maximum ValueMaximum value along the vertical axis to be displayed. This value will be the highest point on the vertical axis if any value in the data plotted falls above this value. Otherwise, the graph will be automatically sized as normal.
Fixed ScaleIf 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.
Horizontal Axis TitleThe label given to the horizontal axis.
Vertical Axis TitleThe label given to the vertical axis.
Include LegendWhen a series is used, if this is turned on then a box listing all lines shown, along with the corresponding values, is displayed on the graph.
Tick label angleThe orientation of the values displayed along the horizontal axis. Select a value from the drop down menu.
Show Horizontal GridlinesIf this is turned on, horizontal gridlines are displayed on the chart.
Show Vertical GridlinesIf this is turned on, vertical gridlines are displayed on the chart.
Show Values on ChartsIf this is turned on, then the y/data attribute values are also displayed on the chart for better clarity.

The following fields apply only to display type: Line Chart (times series horizontal axis):

FieldDescription
Primary Axis UnitUnits for date display along the horizontal axis. Choose a value from the drop down list. Note, however, that only as many values will be displayed as can comfortably be fitted in the space available.
Primary Axis FormatChoose a format to display dates along the primary horizontal axis.
Secondary Axis UnitUnits for an optional, second date display along the horizontal axis. This might be used, for example, to create a graph where the months are shown along the primary horizontal axis (Primary Axis Unit = 'Month', Primary Axis Format = 'Jan, Feb') and the years are shown along a line below this, along the secondary horizontal axis (Secondary Axis Unit = 'Year', Secondary Axis Format = 'Four digit year').
Secondary Axis FormatChoose a format to display dates along the secondary horizontal axis, if this is being used.

The following fields apply only to dial charts:

FieldDescription
Major Tick IncrementThe incremental values at which major tick marks should be shown. Do not set too low for the minimum/maximum values specified otherwise there will be too many major ticks.
Minor Tick CountThe number of tick marks between each major tick.
First Band ColourThe colour of the first segment on the three coloured arc indicating different regions of the dial.
Second Band ColourThe colour of the second segment on the three coloured arc indicating different regions of the dial.
Third Band ColourThe colour of the third segment on the three coloured arc indicating different regions of the dial.
First Threshold ValueThe value at which the first band colour changes to the second band colour.
Second Threshold ValueThe value at which the second band colour changes to the third band colour.
Dial StyleArc or Circular.

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

FieldDescription
View AttributesSee the Stream View Attribute Details form.
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 GroupsA list of user groups associated with the Stream View.
DescriptionDescription of the stream view.

Colouring grid rows

The colours of particular rows can be customized by creating a Stream View Attribute called 'gridRowColour'. The value of this attribute should 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:

AquaBlackBlueFuchsia
GrayGreenLimeMaroon
NavyOlivePurpleRed
SilverTealWhiteYellow

It is advised not to use dark colours as they may cause the grid data to be hardly visible.


Form Icons

 

The form provides the standard form icons.

See Also

  • No labels