This page is for data modellers or application designers. It explains how to use a relationship diagram to understand how your system's data is interconnected.
TODO: Check for info in these links
- https://www.sisense.com/en-gb/glossary/entity-relationship-diagram/
- https://www.smartdraw.com/entity-relationship-diagram/
- https://www.guru99.com/er-diagram-tutorial-dbms.html
Overview
Use an relationship diagram to visualise how your system's information is connected. PhixFlow relationship diagrams are similar to simplified entity-releationship diagrams (ERDs). In PhixFlow, entities are represented by streams and their attributes. You can use relationship diagrams to draw the relationships between existing streams, or you can create the diagram and, at the same time, create the streams it represents.
For example, a simple relationship diagram can represent a company and its employees. A company has attributes, such as a name, address, turnover. In a PhixFlow stream, a company must also have an attribute that identifies the company uniquely. A company also has employees. In a relationship diagram this looks like:
Company → employs → People
UniqueID
Name
Address
Turnover
Relationships can work both ways, for example a person "works for" the company. The relationships are usually expressed as an action (verb) that follows the left-right flow of the diagram. For example:
- either company → employs → people
- or people→ workfor → company
- but not company → workfor→ people
The relationship connects identifiers in each stream. A unique identifier in a stream is it's primary key. It uniquely identifies the row (data record) in the stream. In some cases a unique attribute from one stream is represented in another stream - this is a foreign key . It uniquely identifies a row in a different stream.
For example Person has attributes
- Name
- Address
- Employer - this contains the unique identifier of the company and is therefore a foreign key.
Relationships can be
- 1-1: primary key to primary key
- 1-to-many: primary key to foreign key
- many-to-1: foreign key to primary key
- many-to-many: foreign key to foreign key.
PhixFlow imposes no restrictions on naming relationships, but the relationship name must be unique. We recommend that you use an action word that represents the relationship, avoiding "has" or "contains".
The components of a diagram:
- Each stream is displayed as a box
- The box also lists all the attributes
- Primary keys and foreign keys are highlighted in green
- Relationships connect stream attribute primary and foreign keys.
- You can collapse a stream box to show only the attributes that are primary or foreign keys.
TODO Invoice example
- Invoice has the totals information. has attributes: custID, total, date etc.
- Parent object - there are many
- And it shows the invoice lines e.g. call breakdown - these are not the data records for the invoice
- Children with their own attributes: invoice id -
- Relationship is btwn ID field invoice - and the invoice id
- Receipt is an invoice - individual lines - info
To show the process flow of data, use a BPMN diagram
Other affected pages: repository, toolbars
Properties
...
Basic Settings
...
Drawing Entity-Relationship Diagrams
...
Adding Entities
To open an existing ERD:
- either, in the Repository, right-click the name and select Display.
- or, in the properties toolbar, click the ERD icon (TODO add).
Entities are represented by streams and their attributes.
To add an existing stream, from the repository, drag an existing stream into the diagram. PhixFlow adds the stream and all of its attributes.
To add a new stream.
...
As streams can contain many attributes, you can collapse the view to show only primary and foreign keys. TODO ADD screenshot
Adding Relationships
To add a relationship, click on one attribute and drag the mouse pointer to an attribute in another stream. PhixFlow extends a red arrow line. Stop dragging, or click on an attribute name to connect the two. PhixFlow displays an attribute in bold when it has focus.
When you create a relationship, PhixFlow:
- sets the origin attribute to be a Primary Key which must be unique.
- sets the destination attribute to be a Foreign Key
- creates a one-to-many relationship
The Primary Key and Foreign Key are properties of the Stream Attributes. (TODO ADD the new properties to attributes)
If both attributes are
primary keys, PhixFlow creates a one-to-one relationship.
foreigh keys, PhixFlow creates a many-to-many relationship.
If you connect two primary keys, PhixFlow creates a 1 to 1 relationship.
You cannot create a relationship between attributes if they are not a primary or foreign key. If you add a relationship between attributes, PhixFlow automatically sets them to be one of these.
ERDs and Relational Views
TODO - Add how ERDs and Relational vies interact.
TODO - Possibly bugs or possibly me...
- I ended up with 3 streams that did not appear until the diagram is saved - can I reproduce this
- relationship end points can be drawn a long way from the mouse.
- I can untick keys and it keeps the relationship
- When entities are below each other PhixFlow gets confused.
Toolbar
TODO Same as Model Window Toolbar Icons
...
...
Organise selected objects in a grid.
...
...
Align all selected objects left.
...
...
Align all selected objects right.
...
...
Align all selected objects to top.
...
...
Align all selected objects to bottom.
...
...
Distribute all selected objects horizontally. Changed ICON TODO
...
...
Distribute all selected objects vertically. Changed ICON TODO
...
| 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, 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. A 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.
Many: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 is 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 | ||||||
|---|---|---|---|---|---|---|
|
Using ERDs in Views
PhixFlow displays data to application users via views most commonly a grid view, which displays data in rows and columns.