This page is for data modellers or application designers. It explains how to use an ERD to understand how your system's data is connected.
Overview
An ERD is an entity relationship diagram. Use an ERD to represent the information that your application will use and how it is connected. PhixFlow uses the connections between data when you come to make views. When you select something to add to a view, PhixFlow can offer all the connected tables and attributes. This means you can easily create views that combine data from different tables.
| Tip |
|---|
PhixFlow's ERDs are simplified Entity-Relationship Diagrams. If you are unfamiliar with the general concepts of ERDs, they are explained in this article: ER Diagram Tutorial in DBMS. |
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Example ERD
The following ERD shows the tables and attributes for a school.Key Concepts
A table represents a thing or entity.
| Tip |
|---|
Choose a name that reflects the thing your table represents. |
Entities:
- School Department
- Class Room
- Teacher
- Course
- Student
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Overview
PhixFlow ERDs define the logical structure of the data in your application.
The following example shows an ERD for a school. A school has entities, for example: departments, teachers, students, classrooms and so on. All these entities are represented as tables. The lines connecting the tables show the relationships between them.
The following illustration shows how an ERD represents a table.
The table has a list of attributes
Student attributes:
- StudentID
- Student Name
- Student Address
- Intake Year
PhixFlow automatically generates an attribute that is the unique identifier, UID. This is the table's primary key. The records for this attribute will all have a unique value.
| Note |
|---|
We recommend that a primary key attribute is an integer, because PhixFlow can automatically generate a unique integer value for each new data record. |
Primary Keys
- DepartmentID
- ClassRoomID
- TeacherID
You can create a relationship between the primary key in one table, to an attribute in another table. On the diagram the relationship is shown as an arrow from a primary key to an attribute in another table.
When you are designing screens, you can create views to display attributes from a table AND from tables with a direct relationship.
By convention, set the name of a relationship an action (verb) that follows the left-right flow of the diagram.
- a department→ has→ many teachers
- a teacher → runs→ several courses
- classroom → is ued by→ many courses
Relationships show that the data in a primary key in one table also appears in an attribute in another table.
The attribute may have a different name, but it must represent the same data. This attribute is a foreign key.
When you create a relationship in an ERD, PhixFlow automatically sets the foreign key status for the attribute.
Employee attributes:
- EmployeeID (primary key)
- Name
- Address
- Phone
- Department = foreign key for DepartmentID
Department attributes
- DepartmentID - primary key
- Department Name
- Purpose
- Department Manager = foreign key for EmployeeID
Understanding Relationships
Relationships From and To
Relationships between tables have a direction that depends on which table you are focused on. For example, the Teacher table shown below has two relationships.
, which represent the different pieces of data you want to record.
Attributes are configured with a data type and associated properties; see Understanding Data Types. For example the Address attribute is a String which has an associated length. To change the attribute to reflect the nature of your data, click on the attribute's name to open and edit its properties.
It is important to set the correct data type and properties before loading records into a table, as you cannot change the data type once the table contains records. If you do have data and want to change the type you will need to add a new attribute or clear your data; see Clearing and Loading Data in an ERD.
You can create tables in an ERD manually, but if you already have data, PhixFlow can automatically create tables from it; see Adding Content to an ERD.
Primary Keys and UIDs
PhixFlow expects every table to have a special attribute called a primary key, which uniquely identifies each record. For example, teachers have a UID as the primary key. This is because they can have the same first or family name, or even both, so these attributes cannot be a primary key. When you create a table, PhixFlow adds an attribute called UID (short for Unique IDentifier) and configures it as follows:
- as the table's
primary key. - as an integer.
- to automatically create a unique number for every record in a table.
This means PhixFlow can ensure all the UIDs have unique values.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Display Name
| Anchor | ||||
|---|---|---|---|---|
|
Typically a primary key is not user-friendly and you do not want to display it. Instead, you want to display something that makes more sense to a person. For this reason, when you create a table, PhixFlow automatically adds an attribute called Name and ticks its Display Name property. The display name is shown in place of the primary key when displayed on a view or screen. Display names do not need to be unique and should be something user-friendly.
Let's look at the following example. For the SchoolDept table, PhixFlow has created:
- a UID, for example 1490.
- a Name, for example Mathematics.
When any view makes reference to the SchoolDept using it's primary key, PhixFlow displays the department name, not its number; see Using Relational Views. The configuration is shown below:
SchoolDept SchoolDept
Primary Key Display Name
Relationships and Foreign Keys
| Anchor | ||||
|---|---|---|---|---|
|
Tables in PhixFlow are relational, which means information in one table can be related to information in another table. The key benefit is you can access data in many different tables without needing to duplicate it.
A foreign key is an attribute in one table, that refers to the primary key in another table.
In an ERD you can connect tables by drawing a line, called a relationship between them. For example, the Teacher table needs to have the name of a department. The ERD below shows this relationship using a line that joins SchoolDept.DeptID to Teacher.Department.
When you create screens that show data, PhixFlow uses the relationships defined in the ERD to provide options for displaying data from related attributes in the same grid, form, card, graph or chart; see Displaying Data (Views). This means you only need to store the School DeptID against a teacher to be able to access all of the SchoolDept details.
When you create a relationship from a primary key to an attribute, PhixFlow automatically sets the attribute to be a 
foreign key. Foreign keys must have the same data type and properties as the corresponding primary key. For example, in the illustration above, the Teacher.Department attribute contains the same data type as SchoolDept.DeptID; see Understanding Data Types.
The foreign key represents the many side and the primary key the one side. This means that SchoolDept.DeptID is unique, there is only one record containing this unique information. The Teacher.Department, can have one or more instances of a value of DeptID. For example, the Maths Department UID could occur 10 times, once for each of the 10 maths teachers.
One-to-many and Many-to-
one
PhixFlow draws a relationship line between a primary key and a foreign key. This represents a one-to-many
relationship. For example, one
teacher runs
many courses.
For this type of relationship, PhixFlow automatically sets it to be aggregate. This means the relationship reports the total number. So a teacher runs 3 courses. In the ?? properties, you can clear the aggregate setting to report the full list of their courses.
AA many-to-one relationship is implied when you read a relationship in the opposite direction. For example, a
department has many teachers, and several teachers work for one department.
Finding out about the relationships between tables
Use the ERD. You can highlight relationships From and ToMany-to-manyMany:many
To create a many-to-many relationship, you need an intermediate table that has foreign key attributes from each of the tables you want to
have a relationship.
For example,
many students take many courses. A many-to-many relationship
- A customer → buys → many products
- A product → is bought by → many customers
The intermediate Customer Purchase Record table has both the CustomerID and ProductID as foreign keys.
- Customer purchase → records → CustomerIDs
- Customer purchase record → lists → ProductIDs
Finding out about the relationships between tables
- Use the ERD. You can highlight relationships From and To
- Use the properties?? Relationships are listed under From and To
Shift select
square select
Example
In a relationship diagram, a stream and its attributes are displayed as a box. You can expand or collapse the box using the icon in the top left. PhixFlow shows all the attributes when the stream is expanded, and only the primary and foreign keys when it is collapsed.
The following diagram shows some relationships between streams that represent a company, its employees and departments, the products it makes and the customers who buy them.
The company "contains" many departments. An employee "works in" a department, and a department can have many team members. In this company, the department "makes" several products, which "ship to" many customers.
Relationship diagrams are useful because you can design relational views that use data from multiple streams. For example, you might want a view that shows the employee details by department. This will display data from the Employee stream and the Department stream. The relationship diagram shows these are connected by the DepartmentID attribute.
Relationship Diagrams in the Repository
When you create a relationship diagram, you start in the repository. Find theis shown below, using the intermediate table called CourseAttendee. Notice that CourseAttendee does not need a unique identifier.
- A course is attended by many students
- A student takes many courses.
Viewing ERD Data
| Anchor | ||||
|---|---|---|---|---|
|
| Insert excerpt | ||
|---|---|---|
|
|
As you draw the diagram, PhixFlow adds items to the repository:
- a stream for each table; see
- a stream attributes for each attribute. These are nested under the stream in the repository.
- a relation for each relationship.
Relationship Diagrams and Relational Views
Relationship diagrams underpin the ability to create views that combine data from different streams.
When you create a GUI screen for an application, a view can display the data records for selected attributes using a Stream View. This can be a grid (table), a graph or a chart. If a table has no relationships to other tables, PhixFlow can only show attributes and records from that stream.
When a table has a direct relationship to other tables in a relationship diagram, PhixFlow can display the data for the attributes from the related tables.
For example, with the following relationship diagram, you can create a view based on the "Departement" stream that shows
- Company name from table Company
- Department names from table Department
- Product category and Status from table Products
todo better diagram and example
Check its in PhixFlow the delete
Select a grouped set of items and then click to ungroup them.
Select several items then click to group them together.
Back: ?
Align selected items to the left
Align selected items to the right
Align selected objects to the top
Align selected objects to the bottom
Click to list available tables
Context Menu
Permanently Delete → Delete (no undo)
Video showing a worked examples
scripts incontext
Icons
Video script (4 mins)
Bullet pointed list of where incontext
On entry, on creations...
Sketch out in Word
Incontext help design?
Title, video script, links....
Have a look at how the GUI is being affected by changes to ICONS
Close of play TUESDAY
| title | Special terms on this page |
|---|
| borderColor | #072171 |
|---|---|
| borderStyle | solid |
| title | Terms |
inbound/outbound
Primary key
attribute
foreign keySee Creating Dashboards and Reports.
Using ERDs in Views
PhixFlow displays data to application users via views most commonly a grid view, which displays data in rows and columns.