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.

Insert excerpt
_Banners
_Banners
namescreen
nopaneltrue

Overview

PhixFlow stores data in tables (previously called streams

. Streams

). Views are used to display the data in these Tables. Often they 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

, which displays the information you specify.

Views Consist of:

  1. Attributes
    The base stream.
      1. Attributes from the base table
        Specify which attributes to include in your view. You can hide attributes
    from the base stream
      1. that you want access to but do not necessarily want
    to display
      1. a user to see, such as the UID of a record.
    Selected attributes
      1. Attributes from related
    streams
      1. tables.
    Relationships between streams are configured in
      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.

    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

      1. . Views which contain these type of attributes are referred to as a relational view.
    1. Records:

      1. For each
    stream
      1. table, the view includes records
    from the streamsets
      1. specified in the
    streams
      1. tables default period. This can be all
    streamsets
      1. data (usually for transactional data)
    ,
      1. or only the latest.
  2. apply sorting, filtering and ordering
  3. 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:
    1. Sorting and Filtering
      1. You can filter and sort records. See Filtering and Sorting Data.

    View Components

    The views below display data in different ways.

    1. Insert excerpt
      _grid
      _grid
      nopaneltrue
      : the attributes form the grid columns and data records are displayed in rows. PhixFlow can add scroll bars or paging where grids cannot be accommodated by the screen size.
    2. Insert excerpt
      _
    grid
    1. card
      _
    grid
    1. card
      nopaneltrue
      : rather than using a form to display data, you can use a card. Any palette item can be added to a card which offered great flexibility.
    2. Insert excerpt
      _
    graph_line
    1. chart
      _
    graph_line
    1. chart
      nopaneltrue
      : attributes are represented in different segments of a pie chart, with values aggregated to represent the segment size. 
    2. Insert excerpt
      _graph_
    vertical
    1. horizontal
      _graph_
    vertical
    1. horizontal
      nopaneltrue
      : attributes are represented on the vertical axis, with values aggregated and represented in the bar length.
    2. Insert excerpt
      _graph_
    horizontal
    1. vertical
      _graph_
    horizontal
    1. vertical
      nopaneltrue
      : attributes are represented on the horizonal axis, with values aggregated and represented in the bar height.
    2. Insert excerpt
      _graph_
    chart
    1. line
      _graph_
    chart
    1. line
      nopaneltrue
      : attributes are represented as points on a horizontal axis, with values aggregated and setting the point position on the vertical axis.
    2. Insert excerpt
      _
    card
    1. form
      _
    card
    1. form
      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:
  4. area: can contain any component
  5. form: designed to contain data fields and their labels
  6. 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
    1. : attributes are represented by different fields. Usually a form is linked to an action on a grid. For example, the application user selects a line on a grid, and the form displays the data from that record.

    Form and card components are special data components, as they can contain other elements, usually fields and labels.

    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

    for more information on the specific of setting up charts and graphs see Creating Dashboards and Reports.

    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

    Drag attributes from the Attribute Selection window onto a component

    Table

    1. There are several ways to show data on a screen:

      1. From an Entity Relationship Diagram (ERD), select a table and use the Create Screen option; see Creating a Screen from an ERD Table.
      2. Drag a Table from the repository or a tables icon from its properties directly onto a screen.
        1. A list of available tables is available by clicking the Tables button on the toolbar.
        2. This method will typically set the data for the backing form to that of the table.
    2. PhixFlow asks you how you want the data to be displayed, select the desired option:
      Image Added
    3. The view will be added to the screen.

    Step 2 Select the Attributes

    1. Drag attributes from the Available Attributes window onto the view.
    2. Start with attributes from the current (base
    stream
    1. ) table.
    2. Optionally, click on related
    streams
    1. tables 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
    1. .
    2. When you have
    added You have now created a data component and it is bound to data
    1. dragged 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.
    Image Removed

    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

    1. Image Added
    2. These attributes can be changed at a later date, when a screen is unlocked:
      1. For Forms, click the attributes button from the toolbar.
      2. For Card Components (and Kanbans), right-clicking on the card and selecting Show table view configuration
      3. For Grids and Charts: right-clicking on the item, selecting Show Table view configuration. In the attributes section click 
        Insert excerpt
        _attributes
        _attributes
        nopaneltrue
        .
    3. See Available Attributes Window for details.

    Step 3 Apply Filtering and Sorting

    You have now created your view and added it to a screen. 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:

    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

    :

    1. Select the view you have added.
      You may need to right-click the view and select Show table View Configuration.
      PhixFlow opens the view properties.
      1. For Forms, we can only apply filters. Right-click on a screen → Show Element Details Background Filter Rules. This setup is slightly different see Screen Element for guidance.
    2. Image Added

    3. Select an existing Default Sort Order, Default Filter or Background Filter or create new ones, see Sort Order and Filter for more detail.

    4. Save all your changes and PhixFlow applies filters.

      Tip

      Users can remove a Default Filter, where as Background Filters are permanent.


    Reusing Views

    Once you have created a view, you can reuse it in multiple locations. In the repository

    , you can find a view listed under it's base stream

    navigate the the table which owns the view, the base table, open the table and in the views section drag the desired view onto your screen. Be aware however that changes made to the view will affect all instances of that view.

    Form Field

    Names

    Name

    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

    table,

    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

    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:
  7.  Tick the base stream attributes that you want to be available in the view.
  8. Optionally, click on related streams to show additional attributes that are available.  Again, tick the attributes you want to be available in the view. 
  9. Drag attributes into the parent area, or empty data component.
  10. PhixFlow adds all the attributes to the data component

    .

    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

  11. 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.
    Image Removed The red exclamation icon shows that a component has no data bound to it. 
  12. Click Insert excerpt_data_bind_data_bindnopaneltrue.When the component has data bound to it, the  Insert excerpt_attributes_show_attributes_shownopaneltrueand Insert excerpt_filter_filternopaneltrueicons become available.


    Tip

    If a form field or dynamic text field exists on a screen, it will link to an attribute in the data backing the screen by name, however you can also right-click on these components and select Change Backing Attribute to link it to any available attribute.