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: - either manually, for example create a screen in which application users can enter data.
- or via an analysis model.
| PhixFlow automatically creates each table with: - a primary key called UID
- a Name attribute
- the Name attribute set as the display name; see Display Name.
| Defining Data Structures using ERDs
Creating a Screen from a Table Load Data |
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: - either set one attribute as the primary key and ensure all values will be unique
- or add an attribute called UID with
- Data Type = Integer
- Precision = 10
- Set one attribute to be the Display Name.
| Load Data |
I have tables in PhixFlow already | In the ERD toolbar, click Insert excerpt |
---|
| _table_list |
---|
| _table_list |
---|
nopanel | true |
---|
|
to display a list of all the tables. Drag tables into the ERD and then add the relationships. | Defining Data Structures using ERDs |
How to Define an ERD
Open an Existing ERD
In the repository, find 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
Insert excerpt |
---|
| _erd_display |
---|
| _erd_display |
---|
nopanel | true |
---|
|
icon.
Create a New ERD
- In the repository, find ERD. Right-click to display the context menu, and select
Enter a name for your ERD, and a description then click
Insert excerpt |
---|
| _finish |
---|
| _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.
Add an Existing Table
- In the toolbar, 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
Insert excerpt |
---|
| _table_new |
---|
| _table_new |
---|
nopanel | true |
---|
|
from the toolbar into the diagram. - In the pop-up, enter a name, for example "Customer", and click
Insert excerpt |
---|
| _dialog_finish |
---|
| _dialog_finish |
---|
nopanel | true |
---|
|
. - PhixFlow opens the properties tab for the new table on the right and adds the table to the canvas.
The header displays the name entered in step 2. PhixFlow automatically adds 2 attributes:
- UID - PhixFlow requires a unique identifier and primary key for each table.
- Name - 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, with the default settings of:
- Type = String
- Length = 50 characters.
- In the properties, enter the Name and select appropriate type properties, such as Date or Integer; see Attributes. The following data types have additional properties:
- For String add Length
- For Integer add Precision
- For Decimal add Significant Figures and Decimal Places
- Click
Insert excerpt |
---|
| _finish |
---|
| _finish |
---|
nopanel | true |
---|
|
to save the attribute properties.
- 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 |
---|
|
- Click on the source attribute.
- Drag to the destination attribute. PhixFlow highlights the attribute when your mouse pointer is over it.
- When the destination attribute is highlighted, release the click.
|
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 1:many |
attribute | primary key | table2.primarykey → table1.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.
If this happens, 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.
Tip |
---|
If you have created several ERDs to define the data structure that your application requires, then each ERD is a view onto a part of the full data structure. |
Saving ERDs
Changes to tables, attributes and relationships are automatically saved. However, to keep any changes you make to the layout, such as moving tables or adding angle points to relationships, remember to click Show Relationships From Other ERDs
Tip |
---|
If you have created several ERDs 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. To see other related tables, right-click a table to show the context menu and select:
Image AddedShow many to one relations ?? should be
savesaveTo select multiple tables, draw a square around them.
Image Removed
Properties
Insert excerpt |
---|
_parent | _parent | nopanel | true |
---|
Basic Settings
Field | Description |
---|
Name | The name for the ERD. |
Insert excerpt |
---|
_description | _description | nopanel | true |
---|
Insert excerpt |
---|
_audit | _audit | nopanel | true |
---|
The toolbar is at the top of the canvas. Hover your mouse pointer over the toolbar to see a tooltip.
Option | Description |
---|
Create options |
---|
Insert excerpt |
---|
_tables | _tables | nopanel | true |
---|
Drag this icon onto the canvas to create a table. | List options |
---|
Insert excerpt |
---|
_tables | _tables | nopanel | true |
---|
Click to open the repository filtered to list the tables available in your application. | Canvas options |
---|
Insert excerpt |
---|
_help | _help | nopanel | true |
---|
Open the help topic with details about working with ERDs. | Insert excerpt |
---|
_align | _align | nopanel | true |
---|
Options to arrange the selected tables in the ERD:
Insert excerpt |
---|
_align_grid | _align_grid | nopanel | true |
---|
Insert excerpt |
---|
_align_left | _align_left | nopanel | true |
---|
Insert excerpt |
---|
_align_right | _align_right | nopanel | true |
---|
Insert excerpt |
---|
_align_top | _align_top | nopanel | true |
---|
Insert excerpt |
---|
_align_bottom | _align_bottom in the toolbar. PhixFlow notifies you if there are unsaved changes when you attempt to close an ERD.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.
Image Removed
- 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, 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.
Image AddedShow one to many relations ?? should be Insert excerpt |
---|
| _rel_out |
---|
| _rel_out |
---|
nopanel | true |
---|
|
PhixFlow adds the related tables to your ERD.
To keep the related tables in your ERD, in the toolbar, click
.To remove the related tables from your ERD, in the toolbar, click
Insert excerpt |
---|
| _refresh |
---|
| _refresh |
---|
nopanel | true |
---|
|
.Saving ERDs
Changes to tables, attributes and relationships are automatically saved. However, to keep any changes you make to the layout, such as moving tables or adding angle points to relationships, remember to click
in the toolbar. PhixFlow notifies you if there are unsaved changes when you attempt to close an ERD.Accessing Properties
You can set properties for all the items in an ERD. To access properties:
- for the ERD: in the canvas toolbar click
Insert excerpt |
---|
| _property_settings |
---|
| _property_settings |
---|
nopanel | true |
---|
|
- for a table: in the ERD, click on the table header or right-click to open the pop-up menu and select
Insert excerpt |
---|
| _config |
---|
| _config |
---|
nopanel | true |
---|
|
- for an attribute: in the table, click on an attribute
- for a relationship: in the ERD, click on the relationship line. For relationships you can only add or change the description.
PhixFlow opens the properties panel on the right.
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.
Image Added
- 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, 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.
Image Added
Properties
Insert excerpt |
---|
| _parent |
---|
| _parent |
---|
nopanel | true |
---|
|
Basic Settings
Field | Description |
---|
Name | The name for the ERD. |
Insert excerpt |
---|
| _description |
---|
| _description |
---|
nopanel | true |
---|
|
distributehorizontal_distribute_horizontal | Insert excerpt |
---|
_distribute_vertical | _distribute_vertical | nopanel | trueThe toolbar is at the top of the canvas. Hover your mouse pointer over the toolbar to see a tooltip.
Option | Description |
---|
Create options |
---|
Insert excerpt |
---|
| _property_settingstables |
---|
| _property_settingstables |
---|
nopanel | true |
---|
|
| Open the properties tab for the ERD.Drag this icon onto the canvas to create a table. |
List options |
---|
Insert excerpt |
---|
| _zoom_outtables |
---|
| _zoom_outtables |
---|
nopanel | true |
---|
|
| Zoom out to see more of the diagram, with smaller text.Click to open the repository filtered to list the tables available in your application. |
Canvas options |
---|
Insert excerpt |
---|
| _zoom_inhelp |
---|
| _zoom_inhelp |
---|
nopanel | true |
---|
|
| Zoom in to see a smaller area of the diagram, with larger textOpen the help topic with details about working with ERDs. |
savesavePhixFlow automatically saves changes to tables and relationships. Use this icon to save layout changes to the ERD. | Menu option | DescriptionOptions to arrange the selected tables in the ERD: refreshrefresh | Update the ERD to the last saved 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. |
---|
Ungroup Not available?? | Select a grouped set of items and then click to ungroup them. Select several items then click to group them together. |
tmp
Insert excerpt |
---|
| _align_left |
---|
| _align_left |
---|
nopanel | true |
---|
|
Insert excerpt |
---|
| _align_right |
---|
| _align_right |
---|
nopanel | true |
---|
| deletedeleteWhen a specific component is selected, delete the component. Other delete options that may be available relate to specific types of component in the selected pane. Insert excerpt |
---|
| _align_bottom |
---|
| _align_bottom |
---|
nopanel | true |
---|
| elementdeleteelementdelete | Delete a pane or dashboard element from the layout. Check whether Remove Element from Dashboard is also going?? | deleteitemdeleteitem |
Delete a form component from the layout. | Excerptexcerpt-include |
---|
| _formproperty_newsettings |
---|
| _formproperty_newsettings |
---|
nopanel | true |
---|
|
| Create a new form in the current areaOpen the properties tab for the ERD. |
Insert excerpt |
---|
| _pinzoom_unpinout |
---|
| _pinzoom_unpinout |
---|
nopanel | true |
---|
|
| Fix the position of selected objects. ??Going away??Zoom out to see more of the diagram, with smaller text. |
palette_palettezoom_in | | _zoom_in |
---|
nopanel | true |
---|
|
| Open the palette to drag in componentsZoom in to see a smaller area of the diagram, with larger text. |
Insert excerpt |
---|
| _autosizesave |
---|
| _autosizesave |
---|
nopanel | true |
---|
|
Toggle whether or not the currently selected component is automatically autosized when an application window is resized by the user. Note |
---|
Using this option, or manually resizing a component may change the state of the Layout → Style Settings → Auto Size property. |
| Arrange the selected items | Options to arrange the selected components within a pane: PhixFlow automatically saves changes to tables and relationships. Use this icon to save layout changes to the ERD. |
align_leftalign_left Insert excerpt |
---|
| _align_right | _align_right |
nopanel | true |
---|
Insert excerpt |
---|
_align_top | _align_top | nopanel | true |
---|
Insert excerpt |
---|
_align_bottom | _align_bottom | nopanel | true |
---|
Insert excerpt |
---|
_distribute_horizontal | _distribute_horizontal | nopanel | true |
---|
Insert excerpt |
---|
_distribute_vertical | _distribute_vertical | nopanel | true |
---|
Insert excerpt |
---|
_repository_find | _repository_find | nopanel | true |
---|
change to Show in layers??
Open the repository with to see the selected component in the list. This can be useful if you want to move a component. | Insert excerpt |
---|
_screen_properties | _screen_properties | nopanel | true |
---|
Open the properties tab for the screen. | Insert excerpt |
---|
_record_show | _record_show | nopanel | true |
---|
Display information about the table and its records. Check this option's name has changed?? | Select all children | For the selected parent container, select all the child components too. |
Show Attributes for <table name> | Open the list of attributes for the table. This option is available when a screen is backed by a table. |
Show Attributes for <view name> | Open the list of attributes for the view. This option is available when a screen is backed by a view. |
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 | Description |
---|
Configure | Open the properties for this table. |
Remove this item from the Diagram | Remove the selected item(s) from the diagram. |
Show many to one relations | Show one to many relations | Hide Attributes | Collapse the table so that it only shows the Update the ERD to the last saved 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. |
Ungroup Not available?? | Select a grouped set of items and then click to ungroup them. Select several items then click to group them together. |
To access more options in a pop-up menu, in the table header, click
Insert excerpt |
---|
| _more_options_erd |
---|
| _more_options_erd |
---|
nopanel | true |
---|
|
Option | Description |
---|
Insert excerpt |
---|
| _config |
---|
| _config |
---|
nopanel | true |
---|
|
?? Can this be Insert excerpt |
---|
| _property_settings |
---|
| _property_settings |
---|
nopanel | true |
---|
|
| Open the properties for this table. |
Insert excerpt |
---|
| _remove |
---|
| _remove |
---|
nopanel | true |
---|
|
| Remove the selected item(s) from the diagram. |
Image AddedShow many to one relations ?? should be Insert excerpt |
---|
| _rel_out |
---|
| _rel_out |
---|
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 , above. |
Image AddedShow one to many relations ?? should be Insert excerpt |
---|
| _rel_in |
---|
| _rel_in |
---|
nopanel | true |
---|
|
|
Insert excerpt |
---|
| _attributes_show_hide |
---|
| _attributes_show_hide |
---|
nopanel | true |
---|
|
| Toggle the table between expanded to show all attributes or collapsed to show only the table name, primary key and any foreign keys. Other attributes are hidden. |
Show Attributes | Expand the table to show all the attributes |
Parmanently Delete This is useful if your table contains many attributes. |
Insert excerpt |
---|
| _delete |
---|
| _delete |
---|
nopanel | true |
---|
|
| Delete the selected item(s) from the ERD and from everywhere it is used. |
Option | Description |
---|
Make Primary Key |
|
Make Foreign Key | Add New Stream Attribute | Delete AttributeKey |
|
Add New Stream Attribute |
|
Delete Attribute Insert excerpt |
---|
| _delete |
---|
| _delete |
---|
nopanel | true |
---|
|
|
|
HTML Comment |
---|
|
Things not yet implementedFor the Starting Point table: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 |
For 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.
For Create a New For Open an Existing 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.
For Create a Table From an Excel File Document Flow 4.10For Create Relationships table |
primary key | table header | table1.primarykey → table2.new-attribute 1:many |
For Show Relationships From Other ERDs (before Saving ERDs)
Tip |
---|
If you have created several ERDs 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. 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- 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.
For 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.
For Create a Table From an Excel File Document Flow 4.10
For Create Relationships table
primary key | table header | table1.primarykey → table2.new-attribute 1:many |