Starting Point | Process | Primary Key | See | |||||||
---|---|---|---|---|---|---|---|---|---|---|
I have no data | Define the tables, attributes and their relationships in the ERD. Later you will need to add records to the tables:
| PhixFlow automatically creates each table with:
| Defining Data Structures using ERDs | |||||||
I have data in Excel files | Drag the Excel files directly into an ERD. PhixFlow loads the data structure and records. It then adds the table to the ERD. In the ERD, you then add the relationships between tables. | PhixFlow prompts you to set the primary key and display name attributes. | ??Link to doc on XD flow 4.10 | |||||||
I have data but it's not in PhixFlow | Use an analysis model to connect to your data. PhixFlow can read the data structures to create tables. When you run analysis on the model, PhixFlow loads the data records. | In each table
| Load Data | |||||||
I have tables in PhixFlow already | In the ERD toolbar, click the
| Defining Data Structures using ERDs |
Note | ||||||||
---|---|---|---|---|---|---|---|---|
|
How to Define an ERD
Open an Existing ERD
- From the home menu, select Data and click on an ERD in the list.
- In the repository, open your application and find Data → ERD.
- either right-click on an ERD name and select Display.
- or double-click the ERD name to open the properties. In the properties toolbar, click the
icon.Insert excerpt _erd _erd nopanel true
Create a New ERD
- From the home menu, select Data.
- PhixFlow displays the list of ERDs. Select Create New from the left hand side.
In the pop-up, enter a name for your ERD, and a description then click
.Insert excerpt _dialog_finish _dialog_finish nopanel true Tip When you are creating tables, choose a name that reflects the entity your table represents.
PhixFlow opens a new ERD canvas on the left with a toolbar at the top. Hover your mouse pointer over toolbar icons to display a tooltip.
Create a Table From an Excel File
todo?? Flow 4.10
Add an Existing Table
- In the toolbar, click Table ListWaiting for qualified icon??PhixFlow filters the repository to click
Insert excerpt _table_list _table_list nopanel true - PhixFlow filters the repository to show the list of tables available in this application.
- Drag a table from the repository onto the ERD canvas.
Create a New Table
Drag Table Create from- Drag
from the toolbar into the diagram. Waiting for qualified icon??Insert excerpt _table_new _table_new nopanel true - In the pop-up, enter a name, for example "Customer" and click
.Insert excerpt _dialog_finish _dialog_finish nopanel true - PhixFlow adds the table to the canvas and opens its properties tab on the right. The header displays the name entered in step 2. PhixFlow automatically adds 2 attributes:
- UID - the PhixFlow requires a unique identifier and primary key .for each table.
- Name - Figure out how to explain what the name attribute is for and how it's needed for the display name???
To add attributes to the table:In the table, - PhixFlow sets the Name attribute to be the display name. In data grids and forms etc. PhixFlow uses this attribute to provide a user-friendly name, rather than a numeric identifier. Optionally, change the attribute name.
- To add attributes to the table:
- In the table, click
. PhixFlow opens the attribute properties on the right.Insert excerpt _new _new nopanel true - In the properties, enter the Name, Type and Length for the data; see Attributes.
PhixFlow creates attributes with a Type or String and Length of 50 characters. Remember to select appropriate type properties for an attributes data, such as Date or Integer.
the attribute properties.Insert excerpt _dialog_finish _dialog_finish nopanel true
- In the table, click
- PhixFlow adds the attribute to the table in the ERD.
Create Relationships
In an ERD you can create a one-to-many relationship between a primary key in one table with an attribute in another table. For relationship concepts, see Understanding ERDs.
To create a relationship, click-drag from one attribute to another.
Expand | ||
---|---|---|
| ||
|
See the table below for the relationships that can be created between attributes.
Drag | Relationship line | |
---|---|---|
From table1 | To table2 | |
primary key | attribute | table1.primarykey → table2.attribute |
attribute | primary key | table2.primarykey → table1.attribute |
primary key |
table header | table1.primarykey → table2.new-attribute 1:many | |
attribute | attribute | if table1 has no primary key: PhixFlow makes the table1.attribute the primary key if table 1 has a primary key: the relationship is from table1.primarykey instead of from table1.attribute. |
PhixFlow cannot create a relationship between your selected attributes if your selected foreign key attribute:
- is already a foreign key to a different primary key.
- has a different Data Type and type properties to the primary key.
In these cases, PhixFlow reports an error: Related attributes must have the same type and length. This <type/length is different.
You can:
- create a new attribute to be the foreign key
- change the foreign key attributes to match the primary key, provided there is no data in the table
- create the relationship with a different attribute.
To change the data type properties, In the ERD, click on an attribute to open its properties.
Show
in/outRelationships From Other ERDs
Tip |
---|
If you have created several ERD to define the data structure that your application requires, then each ERD is a view onto a part of the full data structure. |
If a table appears on more than one ERD it may have relationships with tables that are not visible in your current ERD. You can check for other relationships using the show in/out buttons
Show all tables using this table (many:1)
Sow all tables used by this table (1:many)To see other related tables, right-click a table to show the context menu and select:
Insert excerpt _rel_in _rel_in nopanel true Insert excerpt _rel_out _rel_out nopanel true
Saving ERDs
Changes to tables, attributes and relationships are automatically saved. However, you must click
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Rearranging ERDs
To move tables around in the ERD, click on the header and drag the table. There are also Align options in the toolbar that you can use to line up or distribute selected tables.
If you want to highlight the relationships that affect a table, click the table to select it. The following screenshot shows the Teacher table is selected.
- Blue lines indicate relationships to a foreign key in the selected table
- Green lines indicate relationships from the primary key in the selected table.
If a table has a lot of attributes that you do not need to see you can collapse the list to show only the table's primary and foreign keys.
- either right-click on a table and select Hide attributes or Show attributes
- or double-click on the table header.
To select multiple tables, draw a square around them.
Properties
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Basic Settings
Field | Description |
---|---|
Name | The name for the ERD. |
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
ERD Toolbar
The toolbar is at the top of the canvas. Hover your mouse pointer over the toolbar to see a tooltip.
Option | Description |
---|---|
Create | |
Create | Drag this icon onto the canvas to create a table. |
Screen | Creates a new screen for the selected table. |
List | |
Tables | Click to see a list available tables. |
Screens | Click to see a list available screens. |
Canvas | |
Save | Save changes to the diagram. If there is no save icon, PhixFlow is saving changes automatically. |
Refresh | Redraw the ERD to display recent changes to the diagram. |
Properties | Open the properties for the current diagram. |
Zoom out | Zoom out to see more of the diagram, with smaller text. |
Zoom in | Zoom in to see a smaller area of the diagram, with larger text. |
Ungroup | Select a grouped set of items and then click to ungroup them. Select several items then click to group them together. |
Group | Select several items then click to group them together. |
Back | For screen layout, move a component back. |
Forward | For screen layout, bring a component forward. |
Align options | Click/hover to show all the options for aligning items on the canvas. |
Align Grid | Organise selected items into a grid pattern. |
Align left | Align selected items to the left. |
Align right | Align selected items to the right. |
Align top | Align selected objects to the top. |
Align bottom | Align selected objects to the bottom. |
Distribute horizontally | For 3 or more items, distributes the selected items evenly between the left and right items. |
Distribute vertically | For 3 or more items, distributes the selected items evenly between the top and bottom items. |
Table Pop-up Menu
You can access more options in a pop-up menu:
- in the table header, click
Insert excerpt _more_options_erd _more_options_erd nopanel true - right-click anywhere in the table.
Option | Rename to | Description |
---|---|---|
Configure Table | Table properties | Open the properties for this table. |
Remove this item from the Diagram | Remove from ERD | Remove the selected item(s) from the diagram. |
Hide Attributes | Hide attributes | Collapse the table so that it only shows the table name, primary key and any foreign keys. Other attributes are hidden. |
Show Attributes | Show attributes | Expand the table to show all the attributes |
Parmanently Delete | Delete everywhere | DDelete the selected item(s) from the ERD and from everywhere it is used. |