Versions Compared

Old Version 11

changes.mady.by.user Anthony George

Saved on

compared with

New Version 12

changes.mady.by.user Anthony George

Saved on

Key

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

Insert excerpt
_Banners
_Banners
namescreen
nopaneltrue

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 tables, formally known as streams. Tables 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:

  1. Attributes
    1. Attributes from the base table.
      1. You can hide attributes that you want access to but do not necessarily want a user to see. For Example the UID of a record.
    2. Attributes from related tables.
      1. These are the attributes available to the view as the table they originate from shares a relationship with the base table as defined in the ERDs; see Understanding ERDs and Views. Views which contain these type of attributes are referred to as a relational view.

  2. Records:

    1. For each table, the view includes records specified in the tables default period. This can be all data (usually for transactional data), or only the latest.
    2. Can be sorted, filtered and ordered.
  3. Components:
    1. The following components are specifically designed to display a view:
      1. Insert excerpt
        _grid
        _grid
        nopaneltrue
      2. Insert excerpt
        _graph_line
        _graph_line
        nopaneltrue
      3. Insert excerpt
        _graph_vertical
        _graph_vertical
        nopaneltrue
      4. Insert excerpt
        _graph_horizontal
        _graph_horizontal
        nopaneltrue
      5. Insert excerpt
        _chart
        _chart
        nopaneltrue
      6. Insert excerpt
        _card
        _card
        nopaneltrue
    2. These views can be added a screen, content can typically be added by dragging specific attributes from a table onto it. In the case os card any palette item can be added.

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.

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


Step 1  Select a table

  1. Drag a table onto a screen, this can be achieved by dragging
    • a table from the list in the repository.
    • a table icon from a table's properties.
  2. PhixFlow asks you how you want the data to be displayed, select a data component:
    1. Image Modified
  3. The view will be added to the screen.


Step 2  Select attributes

  1. Drag attributes from the Attribute Selection window onto the view.
  2. Start with attributes from the base stream.
  3. Optionally, click on related streams to show additional attributes that are available.
  4. When you have added all the attributes you require, close the window.

Step 3  Apply filtering and sorting for records

You have now created your view and added it to a screen. Optionally, specify if you want to apply any filters or sort orders to the data records:

  1. Select the view you have added.
    1. You may need to right click the view and select Show Stream View Configuration.
  2. The properties tab opens:
    1. Image Modified
  3. Select an existing Default Sort Order, Default Filter or Background Filter
    1. Note the filter are applied when the use sees the view, however the default view can be removed by the user.

Select a data component from the popup menu:

Image Removed

In the Attribute Selection window:

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

Image Removed

Image Added

Reusing Views

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

Form Field

navigate the the table which onws the view, the base table, and this can be dragged onto a screen. Be aware however that changes made to the view will affect all instances of that view.

Form Fields Names

When you drag attributes from the Attribute Selection window or table 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 from a related stream, this depends on the Display Name option.  will be shown and not the foreign key value.

For example:

Primary key         →   Foreign key
stream.attribute     →   related-stream.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.

ExampleBase TableRelated TableValue DisplayedForm Field Label
syntaxtable.UIDRelatedTable.ForeignKeyRelatedTable Attribute set to DisplayName-
Example SyntaxCompany.UIDSupplier.RelatedCompanySupplier attribute set to RelatedCompanyNameRelated Company Name
Example Values 10241024"Cloud and Pixel Ltd"Related Company Name

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


Alternative setup

TODO ANTHONY

HTML Comment

Step 1  Starting Points

Option 2

  1. From the palette, Todo-Anthony  specific palette? drag  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 stream

  1. Enter a name for the view.
  2. Select a stream from the list. This stream is the basis for the data view.
    Alternatively, create a new stream. 
  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 stream.
    • Optionally, click on related 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.