Create a New ERD

1. From the home menu, select Data → ERD.
2. From the ERD list, Select Create New from the left hand side.
3. PhixFlow opens the properties for the ERD on the right. Enter the name for your ERD and click 

   Insert excerpt
   _finish _finish nopanel true

   . In the popup window enter the name for your ERD, a useful description and click confirm.
4. PhixFlow opens a new ERD canvas on the left. The ERD has a toolbar at the top. Hover over toolbar icons to display a tooltip that explains their use.

Open an Existing ERD

To open an existing ERD you can:

• From the home menu, select Data → ERD 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

    Insert excerpt
    _erd _erd nopanel true

     icon.

Create a New Table

1. From the canvas toolbar, drag the 

   Insert excerpt
   _streams_add _streams_add nopanel true

    icon from the toolbar into the diagram.
2. In the pop-up, enter its name, for example "Customer" and click

   Insert excerpt
   _dialog_finish _dialog_finish nopanel true

   .
3. PhixFlow adds a box to represent the table to the ERD, and opens the properties tab for it. The table is created with one two attributes: UID and Name. The UID is set as the primary key and the Name is set as the display attribute for the table. We might want to make reference to how this is used?
4. Optionally, rename the primary key. 
   1. Click on the UID line in the table. PhixFlow opens the attribute properties.
   2. In the Name field, change the name. We recommend that UID or ID is part of the name to indicate this attribute is the unique identifier. NB: ID is a reserved word and cannot be used on its own.

   3. Insert excerpt
      _dialog_finish _dialog_finish nopanel true

       the attribute properties.
5. To add attributes to the table:
   1. In the table, click 

      Insert excerpt
      _add _add nopanel true

      . PhixFlow opens the attribute properties.
   2. Enter the Name, Type and Length for the data; see Stream Attributes. Attributes are created with the default of a 50 character string. It's important to change this for other types of data, for example, numerical or date/time data. We make no reference to the current table  relation button?

   3. Insert excerpt
      _dialog_finish _dialog_finish nopanel true

       the attribute properties.
6. PhixFlow adds the attribute to the table in the ERD.

Add an Existing Table

1. From the canvas toolbar, Click the Stream List icon. Tables icon. Should this be an icon?
2. PhixFlow filters the repository to show the list of tables available in this application.
3. Drag a table from the repository into onto the ERD canvas. 

Creating Relationships Between Attributes

The purpose of a relationship is to show that an attribute in one table contains the same data as the same as a primary key in another table. I dont understand this? My understanding is that it allows us to display data from a different table without having to duplicate the data in multiple places? You are aiming to: Not sure how this helps?

• relate a primary key with a non-primary attribute. do we want to make refence to a foreign key? 
• ensure related attributes have the same data properties.

To create a relationship between attributes in different tables, click-drag from one attribute to another. 

1. Click on the source attribute.
2. Drag to the destination attribute. PhixFlow highlights the attribute when your mouse pointer is over it. This may be offset from the end of the relationship arrow. Not sure what the last sentence means? Sounds like a bug? This is a bug
3. When the destination attribute is highlighted release the click.
4. Enter the name for the relationship. I believe the name is provided automatically, but the user can change it. Please refer to the Adobe XD file. I understood that we were going to hide or drop the relationship names as they were redundant
5. PhixFlow
   • adds the relationship arrow
   • opens its properties; see Relationships It does not
   • sets the destination attribute to be a foreign key. Only if you have dragged a primary key, but we can drag a non-primary key onto a primary key. I think this is a bug - it should only be possible to connect primary to foreign key, and I'm not happy with converting non-key to foreign-key because it currently ignores type mismatches. Can drag a primary key onto a non-primary key (if the types match), can drag a non-primary key onto a primary key (if the type matches). 

If you try to create a relationship between two non-primary attributes, PhixFlow assumes the source attribute is the primary key. We don't support this as it's considered a many-to-many.

• If the source table does not have a primary key, it sets the source attribute to be primary. This isn't true if you've defined a stream elsewhere, but I'm inclined to think that you shouldn't be allowed to add relationships until you have added/nominated a primary key.
• If the source table already has a primary key, it uses it as the source attribute. 

Do we need to explain the many-to-one and the one-to-many and that m:n is not supported at this time?

Properties

I cant add a direct comment but the section below relates to the properties toolbar? Should it say tab? it links later to the tabs section.

Basic Settings

ERD Context Menu and Toolbar

In an ERD, you can hover your mouse pointer over the toolbar or context menu options to see what they are for.

We have a more menu and make no reference to it? I am note sure we have a right click menu.

Toolbar

You can find the toolbar at the top of the canvas

Context Menu

In the ERD, right-click a table to show the context menu.