Versions Compared

Old Version 2

changes.mady.by.user Anthony George

Saved on

compared with

New Version Current

changes.mady.by.user Anthony George

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
nameERD
nopaneltrue

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 ERDs define the logical structure of the data in your application; see Understanding ERDs.

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue

Properties

Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue

Insert excerpt
_parent
_parent
nopaneltrue

Tables

For complete details on tables and ERDs see Understanding ERDs. The following diagram illustrates how an ERD represents a table:

Image Added

NameDescription
Insert excerpt
_key_primary
_key_primary
nopaneltrue
PhixFlow expects every table to have a special attribute called a primary key, which uniquely identifies each record.
Insert excerpt
_key_foreign
_key_foreign
nopaneltrue
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
nopaneltrue
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.

: 

Basic Settings

FieldDescription
Name

The name for the ERD.

Insert excerpt
_description
_description
nopaneltrue

Insert excerpt
_audit
_audit
nopaneltrue

Toolbars and Popup Menus

ERD Toolbar

The toolbar is at the top of the canvas. Hover your mouse pointer over the toolbar to see a tooltip.

OptionDescription

Create options

Insert excerpt
_tables
_tables
nopaneltrue
Drag this icon

To create a new table, drag the icon from the toolbar onto the canvas

to create a stream.

List options

.

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
_
tables
screen
_
tables
screen
nopaneltrue
Click to open the repository filtered to list the streams available in your application.

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 Understanding Template Packages and /wiki/spaces/HELP90/pages/2076246053.

 Canvas options

Insert excerpt
_help
_help
nopaneltrue
Open the help topic with details about working with ERDs.
Insert excerpt
_align
_align
nopaneltrue

Options to arrange the selected

streams in the ERD

components:

Insert excerpt
_align_

grid

left
_align_

grid

left
nopaneltrue

Insert excerpt_align_left_align_leftnopaneltrue

: Align the left edges of all the selected components to the component that is furthest to the left.

Insert excerpt
_align_right
_align_right
nopaneltrue
: Align the right edges of all the selected components to the component that is furthest to the right.

Insert excerpt
_align_top
_align_top
nopaneltrue
: Align the top edges of the selected components to the component that is positioned highest.

Insert excerpt
_align_bottom
_align_bottom
nopaneltrue
: Align the bottom edges of the selected components to the component that is positioned lowest.

Insert excerpt
_

distribute

align_horizontal
_

distribute

align_horizontal
nopaneltrue
: Equally distribute the selected components horizontally in the available space.

Insert excerpt
_

distribute

align_vertical
_

distribute

align_vertical
nopaneltrue
: Equally distribute the selected components vertically in the available space.

Insert excerpt
_property_settings
_property_settings
nopaneltrue
Open the properties tab for the ERD.
Insert excerpt
_zoom_out
_zoom_out
nopaneltrue
Zoom out to see more of the diagram, with smaller text.
Insert excerpt
_zoom_in
_zoom_in
nopaneltrue
Zoom in to see a smaller area of the diagram, with larger text
. Insert excerpt_save_savenopaneltruePhixFlow automatically saves changes to streams and relationships.
Use this icon to save diagram layout changes to the ERD
.

Insert excerpt
_refresh
_refresh
nopaneltrue

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 stream Stream Pop-up

a table in your ERD, the attribute will appear on the list. If changes are not appearing, click this icon.

Ungroup

todo-Fiona - does not seem to be available

Select a grouped set of items and then click to ungroup them.

Select several items then click to group them together.

Table Popup Menu

To access more options in a

pop-up

popup menu, in the

stream

table header, click 

Insert excerpt
_more_options_erd
_more_options_erd
nopaneltrue
 


OptionDescription

Insert excerpt
_

config

edit
_

config Insert excerpt_property_settings_property_settingsnopaneltrue

edit
nopaneltrue

todo-Fiona - check Can this be 

Open the properties for this

stream

table to make changes.

Insert excerpt
_remove
_remove
nopaneltrue

Remove the selected item(s) from the diagram.

Image RemovedShow many to one relations

todo-Fiona - should be 
Insert excerpt
_rel_
out
in
_rel_
out
in
nopaneltrue
Streams

Tables may have relationships to other
streams
tables not represented on the current ERD. Use these options to add all related
streams
tables to your ERD so that you can see the full relationship set; see Show Relationships From Other ERDs , above.

Image RemovedShow one to many relations

todo-Fiona - should be 
Insert excerpt
_rel_
in
out
_rel_
in
out
nopaneltrue
Insert excerpt
_delete
_delete
nopaneltrue
 
Delete the selected item(s) from the ERD and from everywhere it is used.
Insert excerpt
_attributes_show_hide
_attributes_show_hide
nopaneltrue
Toggle
the stream
the tables between expanded to show all attributes or collapsed to show only the
stream
table name, primary key and any foreign keys. This is useful if your
stream
table contains many attributes.
Insert excerpt
_
delete
screen
_
delete
screen
nopaneltrue
Delete the selected item(s) from the ERD and from everywhere it is used

Create a new application screen using data from the selected table.

Attribute

Pop-up

Popup Menu

OptionDescription
Insert excerpt
_key_primary_set
_key_primary_set
nopaneltrue
Set the

Make: set the current attribute to be a primary key. A table can have only one primary key.

Remember to unset any other primary key in the stream

Unset: unset this attribute so it is no longer the primary key for the table. 

Insert excerpt
_key_foriegn_set
_key_foriegn_set
nopaneltrue
Set the current attribute to be a foreign

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
nopaneltrue

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
nopaneltrue

Create a new attribute for the
stream
table. PhixFlow opens the properties where you can add a name and set the data type.
Insert excerpt
_delete
_item
_delete
_item
nopaneltrue
 attribute
 Attribute
Delete the attribute from the
stream
table. PhixFlow prompts you to confirm.


Live Search

htmlcomment

spaceKey@self

hidden

additional

true
Things not yet implemented
For the Starting Point stream:
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 stream to the ERD.

In the ERD, you then add the relationships between streams.

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
  1. From the home menu, select Data and click on an ERD in the list.
  2. In the repository, open your application and find Data → ERD.
    • Either right-click on an ERD name and select Display.
    • Or...
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_finishnopaneltrue.
    Tip

    When you are creating streams, choose a name that reflects the entity your stream 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 Stream From an Excel File  Document Flow 4.10
    For Create Relationships Stream
    primary keystream headerstream1.primarykey → stream2.new-attribute
    1:many

    none
    placeholderSearch all help pages
    typepage

    Panel
    borderColor#00374F
    titleColorwhite
    titleBGColor#00374F
    borderStylesolid
    titleSections on this page

    Table of Contents
    maxLevel3
    indent12px
    stylenone


    Learn More

    For links to all pages in this topic, see Entity Relationship Diagrams.

    Insert excerpt
    _terms_changing
    _terms_changing
    nopaneltrue