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

This page is for application designers who need to create views of data and bind them to components on screens.

todo - check GUI is finalised. Revise following pages:

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.

Sections on this page

  • 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:
      •  Grid
      •   Line Graph
      •   Vertical Bar Chart
      •   Horizontal Bar Chart
      •   Pie Chart
      •   Card: todo - check is a card container automatically created or is it the card container you are adding?
    • 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.  

todo - check 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 - 1. replace the image with a sensible onw
    2.  check window name and either change image or change name occurrences

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.

Repository→ Stream→ stream name → View → view name


Technicalites todo update title

You can export data from a view: todo - this was in the original. Still true?

Analysis docs to check

Sorting: DEV-7041 Relational Views - Sorting - Development - PhixFlow Confluence (atlassian.net)

Filters: DEV-7109 Query Filters - Development - PhixFlow Confluence (atlassian.net)

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 table, this depends on the Display Name option. For example:

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

  • No labels