This page is for application designers who need to configure the relationships between data. It explains the properties for entity relationship diagram (ERD).
Overview
PhixFlow PhixFlow ERDs define the logical structure of the data in your application; see Understanding ERDsEntity Relationship Diagrams.
Insert excerpt |
---|
| _property_toolbar |
---|
| _property_toolbar |
---|
nopanel | true |
---|
|
Insert excerpt |
---|
| _property_tabs |
---|
| _property_tabs |
---|
name | basic-h |
---|
nopanel | true |
---|
|
Insert excerpt |
---|
| _parent |
---|
| _parent |
---|
nopanel | true |
---|
|
Tables
For complete details on tables and ERDs see Entity Relationship Diagrams. The following diagram illustrates how an ERD represents a table:
Image Added
Name | Description |
---|
Insert excerpt |
---|
| _key_primary |
---|
| _key_primary |
---|
nopanel | true |
---|
|
| PhixFlow expects every table to have a special attribute called a primary key, which uniquely identifies each record. |
Insert excerpt |
---|
| _key_secondary |
---|
| _key_secondary |
---|
nopanel | true |
---|
|
(available in PhixFlow version 11.3+) | Secondary keys are optional keys that index records and do not have to be unique. When you create a relationship, one attribute in the relation must be either a Primary Key or a Secondary Key. |
Insert excerpt |
---|
| _key_foreign |
---|
| _key_foreign |
---|
nopanel | true |
---|
|
| A foreign key attribute is an attribute in the table that refers to the primary key in another table. When you create a relationship from a primary key to an attribute, PhixFlow automatically sets the attribute to be a foreign key. |
Insert excerpt |
---|
| _display_name |
---|
| _display_name |
---|
nopanel | true |
---|
|
| The display name is the attribute that will be displayed in place of the Primary Key. 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 example a Company Name rather than their ID. |
Insert excerpt |
---|
| _indexed |
---|
| _indexed |
---|
nopanel | true |
---|
|
| Indexes are applied to attributes on a table and help improve the speed of data retrieval when handling large data sets. |
Basic Settings
Field | Description |
---|
Name | The name for the ERD. |
Insert excerpt |
---|
| _description |
---|
| _description |
---|
nopanel | true |
---|
|
The toolbar is at the top of the canvas. Hover your mouse pointer over the toolbar to see a tooltip.
Option | Description |
---|
Insert excerpt |
---|
| _tables |
---|
| _tables |
---|
nopanel | true |
---|
|
| To create a new table, drag the icon from the toolbar onto the canvas. To add an existing table, click to list the tables available in the repository. Drag a table from the list into the ERD canvas. |
Insert excerpt |
---|
| _screen |
---|
| _screen |
---|
nopanel | true |
---|
|
| Create a new application screen using data from the selected table. In the Create Screen window: - Name: Enter a name for the screen
- Open Maximised: Tick for a maximised screen. Untick for a popup screen.
- Description: Optionally enter a description for the screen.
- Select a Template: PhixFlow shows the screen designs available to your application. These depend on the template packages/palettes you have.
|
see /wiki/spaces/HELP11/pages/9711229273 |
Canvas options |
---|
| Open the help topic with details about working with ERDs. |
| Options to arrange the selected components: Insert excerpt |
---|
| _align_left |
---|
| _align_left |
---|
nopanel | true |
---|
| : Align the left edges of all the selected components to the component that is furthest to the left. Insert excerpt |
---|
| _align_right |
---|
| _align_right |
---|
nopanel | true |
---|
| : Align the right edges of all the selected components to the component that is furthest to the right. Insert excerpt |
---|
| _align_top |
---|
| _align_top |
---|
nopanel | true |
---|
| : Align the top edges of the selected components to the component that is positioned highest. Insert excerpt |
---|
| _align_bottom |
---|
| _align_bottom |
---|
nopanel | true |
---|
| : Align the bottom edges of the selected components to the component that is positioned lowest. Insert excerpt |
---|
| _align_horizontal |
---|
| _align_horizontal |
---|
nopanel | true |
---|
| : Equally distribute the selected components horizontally in the available space. Insert excerpt |
---|
| _align_vertical |
---|
| _align_vertical |
---|
nopanel | true |
---|
| : Equally distribute the selected components vertically in the available space. |
Insert excerpt |
---|
| _property_settings |
---|
| _property_settings |
---|
nopanel | true |
---|
|
| Open the properties tab for the ERD. |
Insert excerpt |
---|
| _zoom_out |
---|
| _zoom_out |
---|
nopanel | true |
---|
|
| Zoom out to see more of the diagram, with smaller text. |
Insert excerpt |
---|
| _zoom_in |
---|
| _zoom_in |
---|
nopanel | true |
---|
|
| Zoom in to see a smaller area of the diagram, with larger text. |
Insert excerpt |
---|
| _refresh |
---|
| _refresh |
---|
nopanel | true |
---|
|
| Update the ERD to the last saved diagram layout. This clears any unsaved layout changes. Your ERD should automatically show an changes elsewhere in PhixFlow. For example, if someone adds a new attribute to a table in your ERD, the attribute will appear on the list. If changes are not appearing, click this icon. |
To access more options in a popup menu, in the table header, click
Insert excerpt |
---|
| _more_options_erd |
---|
| _more_options_erd |
---|
nopanel | true |
---|
|
Option | Description |
---|
| Open the properties for this table to make changes. |
Insert excerpt |
---|
| _remove |
---|
| _remove |
---|
nopanel | true |
---|
|
| Remove the selected item(s) from the diagram. |
Insert excerpt |
---|
| _rel_in |
---|
| _rel_in |
---|
nopanel | true |
---|
|
| Tables may have relationships to other tables not represented on the current ERD. Use these options to add all related tables to your ERD so that you can see the full relationship set; |
see Show Relationships From Other ERDs see Adding Content to an ERD, above. |
Insert excerpt |
---|
| _rel_out |
---|
| _rel_out |
---|
nopanel | true |
---|
|
|
Insert excerpt |
---|
| _delete |
---|
| _delete |
---|
nopanel | true |
---|
|
| Delete the selected item(s) from the ERD and from everywhere it is used. |
Insert excerpt |
---|
| _attributes_show_hide |
---|
| _attributes_show_hide |
---|
nopanel | true |
---|
|
| Toggle the tables between expanded to show all attributes or collapsed to show |
only the only the table name, primary key and any foreign keys. This is useful if your table contains many attributes. |
Insert excerpt |
---|
| _screen |
---|
| _screen |
---|
nopanel | true |
---|
|
| Create a new application screen using data from the selected table. |
This is accessed by right-clicking on an attribute.
Option | Description |
---|
Insert excerpt |
---|
| _key_primary_set |
---|
| _key_primary_set |
---|
nopanel | true |
---|
|
| Make: set the current attribute to be a primary key. A table can have only one primary key. Unset: unset this attribute so it is no longer the primary key for the table. |
Insert excerpt |
---|
| _key_secondary_set |
---|
| _key_secondary_set |
---|
nopanel | true |
---|
|
(available in PhixFlow version 11.3+) | Make: set the current attribute to be a secondary key. Unset: unset this attribute so it is no longer the secondary for the table. |
Insert excerpt |
---|
| _key_foriegn_set |
---|
| _key_foriegn_set |
---|
nopanel | true |
---|
|
| Make: set an attribute to be a foreign key. Unset: unset this attribute so it is no longer a foreign key. |
Insert excerpt |
---|
| _view_gray |
---|
| _view_gray |
---|
nopanel | true |
---|
|
| Make: set an attribute to be the display name for the primary key Unset: unset this attribute so it is no longer the display name for the primary key. |
Insert excerpt |
---|
| _attributes_add |
---|
| _attributes_add |
---|
nopanel | true |
---|
|
| Create a new attribute for the table. PhixFlow opens the properties where you can add a name and set the data type. |
Insert excerpt |
---|
| _delete |
---|
| _delete |
---|
nopanel | true |
---|
| Attribute | Delete the attribute from the table. PhixFlow prompts you to confirm. |