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 101 Next »

This page is for data modellers and application designers who want to select specific attributes to appear in a screen, and to format how the data will be displayed.

Overview

To display data on a screen, start by dragging a data view component from a palette to the screen. PhixFlow displays a window in which you can select attributes from one or more tables; see  Understanding Data Views.

This page explains the properties you can set for the view. These properties affect 

  • how the data is presented, for example in a form, grid or a type of chart
  • charts legends, appearance and the attributes you want to use for the axes etc
  • how records are filtered, sorted and ordered 
  • whether or not the data displayed is from the latest analysis run, or across all time
  • the appearance of the view, for example the styles that set borders, and headers
  • the actions that an application user can run, for example when they:
    • double-click in the view
    • drop something onto the view
    • click a menu option in the view's header.

You can send data reports from PhixFlow by emailing the output of a File Exporter, a Task Plans, or a Screen.

Property Pane Toolbar

For information about the toolbar options, see the Common Properties page, Toolbars and Controls section.

 Properties Tab

Parent Details

If this item is within or belongs to another, it's parent name is shown here. See the Common Properties page, Parent Details section for more details.

Basic Settings

FieldDescription
NameThe name of the 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 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 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 table, with data for values of one attribute broken out ('pivoted') into multiple columns. For the additional options available when Display Type is Pivot, see Pivot View Pop-up Options and Pivot Details below.
  • 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.

For the additional options available when Display Type is any of the chart options except Pivot, see Chart Layout  and Chart Layout: Line Chart (time), below.

Default Sort OrderIf specified, the default order in which data should be displayed. See Sort Order.
Default FilterAny filter on the table can be selected as the default filter for this view.
Background FilterAny filter on the table 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) applied on top of the background filter.

Double-click Action

The default action to run when the user double-clicks on a row in a data grid; see Action. For example:

  • run an update action so that a user (with permission) can update the record
  • open a read-only detailed view of the record.
Drag TypeThe drag type that will be used when dragging data from this view. See Drag Types and Drop Targets.
Enable Filter Picker Tick to allow the filter picker to be used for filters created for this view. See Filters on Data Views.
Form View

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

Include History Records Tick to include audit records in the view data. If set, superseded records will be identified by a grey background on the grid row. If not set, superseded records will be filtered out.

View Attributes

A list of attributes displayed in the view. Click  to show view attributes window. Drag the attributes you want to add to the view into this list. If there are related tables, you can also drag in attributes from the related tables; see View Editor Window

When you create a chart view, PhixFlow displays a skeleton chart builder in the screen canvas. You can drag attributes from this list onto the parts of the chart builder, such as the x-axis or the  y-axis. 

In the attribute list:

  • to edit the attribute's properties, double-click an attribute; see View Attribute
  • to delete an attribute, right-click and select  Delete  

Pivot View Pop-up Options

For pivot views, you must assign a purpose to each attribute. Right-click an attribute to open the pop-up menu, and select one of the purposes listed in the table below. For the additional properties available when Display Type is Pivot, see Pivot Details below.

Pivot View
Purpose

Description
Pivot Column

Assign only one attribute to be the Pivot Column. The attribute generates columns in the pivot table. 

Formatting of the column headings is be controlled by the formatting options set on this view attribute.

Pivot Row

Assign any number of attributes to be Pivot Rows. These attributes generate the rows of the pivot.

Pivot Label

Assign only one attribute to be the Pivot Column. If Pivot Column Source is 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.

Pivot Value

Assign only one attribute to be the Pivot Value. The values in this attribute generate the data values in the pivot.

You must apply an aggregate function to this attribute in order to provide the Sum, Minimum, Maximum etc. of these values for each row and column; see Aggregating Data for the aggregate functions.

Pivot Row Total

Assign any number of attributes to be a Pivot Row Total. Each Pivot Row Total attribute generates a value for each row calculated as single-value aggregate of the individual pivot column values. Use any single-valued aggregate; see Aggregating Data for the single-value aggregate functions Sum, Minimum, Maximum, Average, Count.

Filters

The list of filters that will be available to application users in the drop-down list of filters on the view.

There are two ways to add a filter to this list:

  1. Click on the filter button in this section
    • PhixFlow opens a list of all the available filters on the parent table.
    • Drag a filter from this popup into the list.
  2. Go to the parent table'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.

 Security Tab

Access Permissions

See the Common Properties page, Access Permissions section.

Advanced

FieldDescription
Selection AttributeThis attribute will be used to determine the record selected. This is important when the data will be refreshed while users are looking at it - for example, if they run actions that run task plans to update the data, and which are set as refresh actions (see above). Setting this using a key field of the data means that after the refresh, the same record will be selected as before.
Auto Save

 Tick to save the edited row after another row is clicked. 

If a user makes a change to a view with Auto Save selected, then clicks  Refresh, PhixFlow runs auto save first.

Auto Save Action

Available when Auto Save is ticked.

Select an action from the list, or click 

table

In PhixFlow a table is a structured store of data. The table receives data from one or more modelling objects. The table processes data and stores it. Bulk processing of table data is done in analysis models. PhixFlow applications make transactional updates to table data. 

 to open the list of table-actions.
When an application user clicks elsewhere in the screen, PhixFlow runs the selected autosave action.

Row Selection Style

The style that will applied to rows in this view when they are selected. If set, this will override the default selected row style set in the System Configuration.
Select First Row By Default

 Tick to automatically select the first row shown in the view when the view is opened.

Show Paging Bar

Available when Display Type is Grid.

 Tick to show the paging bar by default.

Show Records Count

 Tick to calculate the total number of rows. Users do not have to click the '...' symbol to see this information.

Show Row Number Tick to display the row number on the grid.
Always Show the Column Filter Icon

 Tick to always display the a filter icon on this grid's column headers. This means users can quickly select values on which to filter the grid.

PeriodsNumber of processing periods from the table 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 table - 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.
Default WidthThe default width of the view. If empty, the view's width will be set to the system default value.
Default HeightThe default height of the view. If empty, the view's height will be set to the system default value.
Allow Multi-Select Tick to enable users to select more than one row in the grid.
Frozen ColumnsNumber of columns frozen while scrolling the View horizontally.
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.

Chart Layout 

Available when Type is one of the chart view options. PhixFlow only shows options that are relevant for the type of chart selected.

To configure attributes to display as a chart:

  1. Drag the table or view onto a screen.
  2. Select the chart option you want.
  3. Select the attributes you want to use on the chart.
  4. PhixFlow creates the view and the screen displays a chart builder.
  5. Drag attributes from the view properties onto the chart builder boxes.
    • Series and Series (right axis)
    • on the vertical axis: Y attributes and Y attributes (right axis)
    • on the horizontal :X axis  
    • Label attribute
    • For a horizontal bar chart or line chart, the chart builder boxes are:
    • Series, Y Attributes , X AttributesLabel Attributes

Behind the chart builder you can see the chart. To show the chart without the chart builder overlay, either lock the layout or switch to  Application Mode.

You can display up to 6 


FieldDescription
Show Legend

When a series is used,  Tick to display a box listing all lines, along with the corresponding values.

Display Legend Below The Chart

Available when Show Legend is ticked for charts with left axis only.

 Tick to display the legend below the chart.

 Untickto display the legend above the chart.

Show Controls

Available when Display Type is Barchart.

  Tick to display a Grouped/Stacked switch on the chart.

Mark Selection

Available when Display Type is Barchart.

 Tick to add a visible border around the currently selected bar.

Tooltip Number FormatSelect or add a number format to be applied to a chart tooltip.
Colour MapSelect or add a colour map.
Group Spacing

Available when Display Type is Barchart.

Specify a value between 0 and 1 to define custom spacing between bar groups.

Chart Axis Options

Horizontal Axis SectionVertical Axis Section
Left or right axis
Description
Show Horizontal AxisShow Vertical Axis Tick to display the axis on the chart.
Horizontal Axis TitleVertical Axis TitleAvailable when Show Horizontal/Vertical Axis is ticked.
The label to appear below the axis.
Title StyleTitle Style

Available when Show Horizontal/Vertical Axis is ticked.
Select or add a style with properties to specify the format of the axis title text.

Label Angle-Available when Display Type is Barchart, Barchart (stacked) and all Line Charts.
The orientation of the values displayed along the horizontal axis. Select a value from the drop-down menu.
Horizontal Axis IncrementVertical Axis IncrementSpecify the interval between tick marks on the axis. For example if the data values have a range from 1 to 100, specify a value of 5 or 10.

Force Horizontal Axis Ticks

-

 Tick to force ticks to appear on the horizontal axis.

-Logarithmic ScaleAvailable when Display Type is any type of Line Chart.
 Tick to scale the vertical axis logarithmically.

Minimum Value

Only for
Barchart (horizontal)

Minimum Value

For charts except
Barchart (horizontal)

Specify a minimum value to show on the axis. If the data includes lower values, they will not be plotted.

If no minimum is specified, PhixFlow scales the chart from the lowest data point.


Compares min and max and then it compares to data and says I don't need it

If over the range they don't have an effect unless you tick fixed scale


If its smaller, you are chopping off those parts of the graph top and bottom

It plots everything but then the top is chopped off - so the bar will go to the top or the line will disappear off or appear on

Maximum Value

Only for
Barchart (horizontal)

Maximum Value

For charts except
Barchart (horizontal

Specify a maximum value to show on the axis. If the data includes higher values, they will not be plotted. 

If no maximum is specified, PhixFlow scales the chart up to the highest data point.

Fixed Scale

Only for
Barchart (horizontal)

Fixed Scale

For charts except
Barchart (horizontal

 Tick to always use the Maximum Value and Minimum Value  as the highest and lowest values on the axis.

Left axis you can choose,

Right axis cannot be adjusted to the data.... For the right axis it will use the min and max, whatever the data is doing (so it is effectively always fixed).

Right axis is different

Horizontal Axis IncrementVertical Axis IncrementSpecify a value to use as increments on the axis
Show Horizontal GridlinesShow Vertical Gridlines

 Tick to show grid lines on the chart.

Horizontal Axis Date FormatVertical Axis Date Format

Available when the attribute selected for the axis is a date or date/time.
Select or add a Date or Date/Time format to use for the value labels.

Horizontal Axis Number FormatVertical Axis Number Format

Available when the attribute selected for the axis is a number.
Select or add a Number Format for for the axis labels.

Text StyleText StyleSelect or add a style with properties to specify the format of the text for the axis labels

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:

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.

Pivot Details   


Remember that when you create a pivot table, you must assign a purpose to each attribute, so that all the pivot table data is generated; see Pivot View Pop-up Options above.

When Display Type is Pivot, the following properties are available.

FieldDescription
Pivot Column Source

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.

Pivot Column Expr

If Pivot Column Source is 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 table of the view.

E.g.

['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.

[['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.

Maximum Pivot Columns

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.

Include History RecordsTodo-Fiona

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:

AquaBlackBlueFuchsia
GrayGreenLimeMaroon
NavyOlivePurpleRed
SilverTealWhiteYellow

You are recommended to avoid dark colours as they make data in the grid very hard to read.

View Context Menu

Show Record DetailsOpens a window with all the information contained in that grid row
View PropertiesOpens the properties tab for the view.
Table PropertiesOpens the properties tab for the table.
List Attributes <viewName>

Opens a list of all of the attributes (column headers) for this view.  Attributes formatted in italics are present in the table 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.

Description

We recommend that you always enter a description to explain the purpose of this item.

 Actions Tab

Action Settings

FieldDescription
Double-click Action

Select the type of action that PhixFlow will run when the user double-clicks the view.

  • No Action
  • Stream Action
  • Actionflow
Drop Action

Available when Double-click Action is Stream Action.

Select action that will run when something of the chosen Drag Type is dropped onto this view.

To show the list of available streams, click 

table

In PhixFlow a table is a structured store of data. The table receives data from one or more modelling objects. The table processes data and stores it. Bulk processing of table data is done in analysis models. PhixFlow applications make transactional updates to table data. 

Actionflow

Available when Double-click Action is Actionflow.

Select the actionflow that will run when the chosen Drag Type is dropped onto this view. 

  • To show the list of available actionflows, click  Actionflow.
  • To create a new actionflow, click  Add New; see Actionflow.
Drag TypeThe drag type that this drop type is listening for.

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 table 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:

FieldDescription
NameThe name of the drop target.
Drag TypeThe drag type that this drop type is listening for.
Drop ActionThe action that will run when something of the chosen drag type is dropped onto this view.

Menu Items

The view component on the screen is designed with a header bar. You can configure buttons, menus and sub-menus that are displayed in the view's header bar. Each button or menu item also has an associated table-action that runs when the application user clicks the item. You can only add table-actions from view's parent table.

There are three ways to add lists and buttons:

  1. Click on the Actions icon at the top of the grid.
    • A popup window will appear listing all the available actions on the parent table.
    • Drag an action from this popup form onto the grid.
    • If you drop onto an existing button, PhixFlow prompts you to:
      • either create a new button 
      • or create a list for the new button and the button onto which you dropped the new action.
    • If you drop onto an existing list, PhixFlow adds the dragged action to the list
  2. Open the Table properties. Drag actions into Properties tab→ Actions section list.
  3. Click the  Add New icon in the toolbar to create a button, menu or sub-menu.

For each button, set the following fields:

FieldDescription

Click Action

Select the type of action that PhixFlow will run when the user clicks on the menu or sub-menu item.

  • No Action
  • Stream Action
  • Actionflow
Actionflow

Available when Click Action is Actionflow. Save a new menu item before setting this property.

To add an actionflow:

  1. Click  Actionflow to display a list of available actionflows in the repository.
  2. Drag the actionflow from the list into this field.

To create a new actionflow, click  Add New; see Creating Actionflows.

Action

Available when Click Action is Stream Action

To add a table-action:

  1. Find a table-action
    • To reuse a table-action from a different table, click  List Tables to display a list of tables. Expand a table to see its associated table-actions.
    • To display a list of table-actions available to the parent table of this view, click Table-action.
  2. Drag the table-action from the list into this field.
NameAvailable for sub-menus. Enter the internal name of the action button. This name will be used to refer to this button in other configuration objects.
Display Name

Enter the text that application users see for the menu item.

Order

Specify a number that is the order that the menu item appears:

  • either on the header bar, with 1 being the leftmost
  • or in a sub-menu, the order in the list, with 1 being the first.
Menu Items

Available for sub-menus. Lists the menu items nested in this menu item. To add more menu items, click  Add New.

_property_tabs
 Style tab

Style Settings

For grid views, there are default styles set in System Configuration that determine the appearance of the grid on a screen. To apply different styles to a grid view, select the style from the drop-down. 

FieldDescription
Grid Header Style      Select the style for the grid's header row.
Grid Header Button StyleSelect the style for buttons in the header row.
Grid Header Icon StyleSelect the style for icons in the header row.
Grid Header Drop-down Button StyleSelect the style for drop-down buttons in the header row.
Grid Header Drop-down Pane StyleSelect the style for drop-down panes.
Grid Paging StyleSelect the style for the paging bar.
Grid Row StyleSelect the style for rows.
Grid Column Header StyleSelect the style for column headers.
Row Selection StyleSelect the style for the currently selected row(s).

To see a full list of styles, click 

Error rendering macro 'excerpt-include' : No link could be created for '_style'.
.

To create a new style, click  Add New;  see Style.

 Audit Tab

Audit Summary

See the Common Properties page, Audit Summary section.

Sections on this page

  Learn More

For links to all pages in this topic, see Analysis Models for Batch Processing Data.



Terminology changes in progress

As part of the redesign of PhixFlow, we are changing the following terms:

dashboard → screen   
stream → table
stream attributes → attributes
stream item → record
stream set → recordset
stream view → view
stream item action → record-action 
stream action → table-action
driver class → database driver

  • No labels