Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page is for application designers who need to create views of data and bind them to components on screens. Todo-Anthony- check this page is correct when the GUI is finalised.

Overview

PhixFlow stores data in streams. Streams can contain more data than you want to show to a user on the screen. For this reason, whenever you show data on a screen, you first compile a view of the data. A view is made up of:

  • Attributes
    • The base stream.
      You can hide attributes from the base stream that you do not want to display.
    • Selected attributes from related streams.
      Relationships between streams are configured in ERDs; see Understanding ERDs and Views.

Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone


  • Records:
    • For each stream, the view includes records from the streamsets specified in the streams default period. This can be all streamsets (usually for transactional data), or only the latest.
    • apply sorting, filtering and ordering
  • Components:
    • The following components are specifically designed to display a view.
      You can add these components directly onto a dashboard or dashboard element, or onto a container component:
      • Insert excerpt
        _grid
        _grid
        nopaneltrue
      • Insert excerpt
        _graph_line
        _graph_line
        nopaneltrue
      • Insert excerpt
        _graph_vertical
        _graph_vertical
        nopaneltrue
      • Insert excerpt
        _graph_horizontal
        _graph_horizontal
        nopaneltrue
      • Insert excerpt
        _chart
        _chart
        nopaneltrue
      • Insert excerpt
        _card
        _card
        nopaneltrue

        PhixFlow automatically adds a card container and a card.
    • For views with no specific format, you can bind the view to a container component on a dashboard, then drag specific attributes onto contained components, such as fields. Container components are:
      • area: can contain any component
      • form: designed to contain data fields and their labels
      • card container: designed to contain individual cards.


Views can include attributes from other streams because PhixFlow uses relational database SQL queries to combine attributes and records from different streams.

How to Create and Display a View

As views are designed to display data on a screen, creating a view includes binding it to a component.

Step 1  Select a stream and data component

  1. Drag a stream onto a dashboard. This is the stream on which you want to base your view. You can drag:
    • a stream from the list in the repository
    • a stream's icon from its properties tab.
  2. PhixFlow prompts you to select a data component to display the view.

Step 2  Select attributes

  1. Drag attributes from the Attribute Selection window onto a component.
    • Start with attributes from the base stream.
    • Optionally, click on related streams to show additional attributes that are available.  

As you drag attributes, PhixFlow highlights the component you are binding to data, where you can drop attributes.

When you have added all the attributes you require, close the window.

Step 4  Select the data component

When you start by dragging a data component from the palette, or you drag onto an existing data component, PhixFlow knows how what type of view you are creating. 

When you start by dragging an attribute onto an area or container, PhixFlow does not know the view type. In this case, when you drop the attribute, PhixFlow prompts you to select the type.

Click an option to add a component for a grid, graph, chart or card, which will fit the available space in the parent component. Select Form to set the parent as a form component, which is bound to the data view. PhixFlow adds a field to display the attribute being dropped.

Step 5  Apply filtering and sorting for records

You have now created a data component and it is bound to data. Optionally, specify if you want to create or apply any filters or sort orders to the data records; see Filtering and Sorting Data.

Click Finish.

Select a data component from the popup menu:

In the Attribute Selection window:

  • on the right select related streams
  • on the left, select specific attributes from the stream. 
    Todo-Anthony - replace images

Reusing Views

Once you have created a view, you can reuse it. In the repository, you can find a view listed under it's base stream.

Form Field Names

When you drag attributes from the Attribute Selection window onto a form, PhixFlow adds a field and label for each attribute. By default, the label is the attribute's name. However, for an attribute in a related tablestream, this depends on the Display Name option. For example:

Primary key         →   Foreign key
tablestream.attribute     →   related-tablestream.attribute
Company.UID     →    Supplier.Company-Name 

Where Supplier.Company-Name has Display Name:

  • selected, PhixFlow uses "Company-Name" as the label.
  • not selected, PhixFlow uses "UID" as the label.

For information about primary and foreign keys and the Display Name option; see Understanding ERDs and Views.


HTML Comment

Step 1  Starting Points

Option 2

  1. From the palette, Todo-Anthony  specific palette? drag a data component, such as a grid or chart onto the screen canvas.

Option 2

  1. On the dashboard canvas, select a component to which you want to bind data to show the pop-up toolbar. This is usually an area component that will become a parent component.
     The red exclamation icon shows that a component has no data bound to it. 
  2. Click
    Insert excerpt
    _data_bind
    _data_bind
    nopaneltrue
    .

When the component has data bound to it, the 

Insert excerpt
_attributes_show
_attributes_show
nopaneltrue
and
Insert excerpt
_filter
_filter
nopaneltrue
icons become available.

Step 2  Select a

parent table

parent stream

  1. Enter a name for the view.
  2. Select a table stream from the list. This table forms stream is the basis for the data view.
    Alternatively, create a new tablestream
  3. Click Next.
    PhixFlow creates a view and open's its properties.

Step 3  Select attributes

  • To add attributes individually, drag each attribute from the Attribute Selection window onto a component.  As you add attributes to the data component, PhixFlow ticks them in the Attribute Selection window.
    • Start with attributes from the base tablestream.
    • Optionally, click on related tables stream to show additional attributes that are available.  
  • To create a grid with multiple columns, select multiple attributes:
    1.  Tick the base stream attributes that you want to be available in the view.
    2. Optionally, click on related streams to show additional attributes that are available.  Again, tick the attributes you want to be available in the view. 
    3. Drag attributes into the parent area, or empty data component.
    4. PhixFlow adds all the attributes to the data component.