Overview

Entity Relationship Diagrams (ERDs) define the structure of the data in your application. "Entities" are displayed as tables and represent the "things" in the world that you want to show as data.

Opening and Creating ERDs

• On your application's home page, click

  Insert excerpt
  _erd _erd nopanel true

   to list the existing ERDs.
  • Alternatively, click

    Insert excerpt
    _erd _erd nopanel true

     from the header bar. 
  • 
• To create a new ERD, click the 

  Insert excerpt
  _add _add nopanel true

  button.
• To open an existing ERD, double-click it.

ERD Layout

Here is a simplified view of the ERD:

Tables

A table is where your data is stored for your application. Click on the image below to enlarge it.

Image RemovedImage Added

Attributes

Attributes represent the different pieces of data recorded in the table, and can be thought of as column headers on a spreadsheet.

• Attributes are configured with a data type (e.g. string, integer, true/false) and properties. To change these, click on the attribute's name. See Understanding Data Types.

Primary Keys

Insert excerpt
_key_primary _key_primary nopanel true

s are special attributes which uniquely identify each record. 

• When you create a new table, PhixFlow adds an attribute called UID UID (Unique IDentifier) and configures it as follows:

  • the table's Primary Key
  • an integer
  • automatically creates a unique number for every record in the table
• If your data already has a unique attribute, you can use this as the Primary Key by right-clicking and selecting Make Primary Key. 
  • On the example image above, the Teacher Employees table has the attribute UID  EmployeeID as the Primary Key. This is because teachers may have the same first and/or surname, so these attributes cannot be guaranteed to be unique and therefore cannot be a Primary Key.

Foreign Keys

Secondary Keys

• When creating relationships on the ERD, one attribute in the relation must be either a Primary Key or a Secondary Key

Example: In a student records table, if a student ID is the primary key, a student's email address or phone number could be a secondary key. This allows data to be retrieved using these attributes even if the student ID is not known.

Foreign Keys

• Foreign Keys must have the same data type as the corresponding Primary Key or Secondary Key. For example, both must be strings and of the same length.

Display Names 

Anchor
DisplayName DisplayName

Display Names are special attributes which are displayed instead of a Foreign Key, as they make more sense to a human.

• When you create a new table, PhixFlow adds an attribute called Name and configures it as the Display Name.
  • This is then shown in place of the Foreign Key when displayed on a screen as part of a relational view, see Using Relational Views. Display Names do not need to be unique and should be user-friendly.
• If your data already has an attribute you want to use as the Display Name, right-click it and select Make Display Name. 

Validation

Validation is applied to table attributes and determines the criteria an attribute must satisfy in order to be considered valid. For example, the attribute is mandatory, must contain a minimum number of characters or must adhere to a specific pattern. Validation, added to a table attribute,  will will be applied wherever that attribute is updated, such as when saving data on an input screen. See Adding Validation to Table Attribute ValidationAttributes.

Indexing

Indexes are applied to attributes on a table and help improve the speed of data retrieval when handling large data sets. See Indexing.

Relationships Between Tables 

Anchor
relationships relationships

Tables in PhixFlow are relational, which means that information in one table can be related to information in another table. Data can then be accessed in many different views without requiring duplication. See Creating Dashboards and Reports.

A line connects the Primary Key of one table to a Foreign Key in a different table represents a relationship. See Relationship.  Click on the image below to enlarge it.

Image Removed

One-to-Many and Many-to-One

The relationship line between a Primary Key and Foreign Key represents a one-to-many relationship. In the below example, one teacher runs many courses.

A many-to-one relationship is implied when you read a relationship in the opposite direction. In the below example, many courses are run by one teacher. Click on the image below to enlarge it.

Image Removed

Many-to-Many 

Many-to-many relationship can be supported with an intermediate table.

For full information on table relationships, including multi-hop relationships, see Understanding Table Relationships.

Working in an ERD

You can add tables in an ERD manually. See Adding Content Data and Tables to an ERD.

• Create a new table by dragging 

  Insert excerpt
  _tables _tables nopanel true

   from the toolbar onto the canvas.
• Add an Excel spreadsheet or CSV file by dragging it onto the canvas. PhixFlow imports the data and creates a new table. Note, the expected format is the header is the first row followed by the data. If your data is in a different format, this is supported, see Importing Data from Excel (Advanced).
• Add an existing table by clicking 

  Insert excerpt
  _tables _tables nopanel true

   in the toolbar. The available tables are listed in the Repository and can be dragged onto the canvas. 
• If you have data in an external source such as database and wish to add this data, it will first need to be imported. See Importing Data.

View Table Data 

Anchor
view view

To view the data in a table, click 

Create a Screen from a Table

Select 

Multiple ERDs

The same table can appear on multiple ERDs.

ERD Example

What's Next?

The PhixFlow Fundamentals, this course  course provides a practical guide to using PhixFlow, including setting up ERDs. 

Already started PhixFlow Fundamentals?

Return to ERD Fundamentals

Further Reading