This page is for data modellers or application designers. It explains how to use an ERD to understand how your system's data is connected.
Panel |
---|
borderColor | #00374F |
---|
titleColor | white |
---|
titleBGColor | #00374F |
---|
borderStyle | solid |
---|
title | Sections on this page |
---|
|
|
Image Removed
The Task Bar Changed
On Desktop or Laptop Computers
For desktop or laptop computers, the task bar shows:
on the left:the Insert excerpt |
---|
_logout | _logout | nopanel | true |
buttonthe number of currently running actionsin design mode, the number of windows open in the workspacethe right of the grey status bar at the bottom of the screen shows the status of any actions, and lists how many items, such as models or dashboards, are open Anchor |
---|
formBar | formBar | When there are several model windows or dashboards open in the workspace you can Show/Hide Windows Bar; see 13 Using the Windows Bar. This displays icons for all the open windows (both open and minimised). Click on a link to maximise or bring a window to the front of the workspace. Each icon also has a context menu which allows you to close it.on the right: the user name of the currently logged in user, and the following icons. For information about these icons; see Menu Options and Toolbar Buttons Insert excerpt |
---|
| _Banners |
---|
| _Banners |
---|
name | GettingStarted |
---|
nopanel | true |
---|
|
Overview
PhixFlow has two distinct modes depending on what you need to do.
Insert excerpt |
---|
| _design_mode |
---|
| _design_mode |
---|
nopanel | true |
---|
|
Application designers use this mode to create and configure applications. This includes:
We recommend designing applications on a desktop or laptop computer, as you require screen space to configure PhixFlow. When designing, you can switch between
Insert excerpt |
---|
| _design_mode |
---|
| _design_mode |
---|
nopanel | true |
---|
|
and Insert excerpt |
---|
| _app_mode |
---|
| _app_mode |
---|
nopanel | true |
---|
|
, where you can see your application in action by clicking the mode icon in the top right of the PhixFlow window. userdetailsuserdetails Application users run PhixFlow applications in this mode.
PhixFlow displays only essential menus and toolbars in
consoleconsole. Your administrator usually configures PhixFlow so that an application user has no access to administrationadministration – the options available depend on your permissions. Insert excerpt |
---|
_palette | _palette | nopanel | true. Instead, application users work within an application and use the application's menus and navigation to complete tasks.
You can run a PhixFlow application on:
- desktop or laptop computers
- mobile devices, such as a tablet or smartphone.
An application designer can configure application user access to the specific applications and data that they need; see Controlling User Access to Applications.
How to use Application Mode
Opening an Application
When you log in, PhixFlow displays the Welcome window and the application menu. Anytime you want to return to the application menu, in the top left corner of the PhixFlow window, click
repositoryrepositoryeither .
You can change the layout of the application menu, using icons in the top right of the application window.
designmodedesignmode or Image AddedTo open an application:
- Double-click anywhere in a card or on a list line
- PhixFlow asks you to confirm
- Click Yes to continue to the application's Home window.
From here you can select an aspect of your application on which to work
To create a new application from the application menu, click the
app_modeapp_mode.In design mode, PhixFlow displays green, blue or red notification pop-ups on screen. You can click Dismiss notifications to close all green and blue notifications. You must close red error messages individually.On Mobile Devices
PhixFlow applications are often deployed on button on the left of the menu; see Creating an Application.
Using Applications on Mobile Devices
PhixFlow supports mobile devices, such as tablets and phones. This means team members can access and update data whilst
in fieldmove. As mobile devices have less screen space available, the
task header bar is simplified to show the icons:
logoutlogoutwindow_barwindow_baradministration | nopanel | true |
---|
|
– option available depending on user's permissions
Image Added
How to use Design Mode
userdetailsuserdetails is a powerful tool for configuring applications that help automate business processes.You can:
- plan the workflows and tasks for application users
- define data structures
- design application screens
- configure user interactions for buttons and options on a screen, so that an application user can make changes to specific data records
- import, batch process and export large volumes of data using analysis models.
This means PhixFlow can exchange data with your existing systems and databases
Loading an Application
When you first log into
administrationadministration – the options available depend on your permissions.Application Mode
Your PhixFlow applications usually have a menu bar at the top of the screen. On the top left is the PhixFlow name and logo, which looks like this. Dot menu only in mobile. The dots will always be there but in mobile view only the dots should show.
Image Removed
Application developers can configure PhixFlow to not display the menu bar. Instead the PhixFlow logo is displayed the bottom right of the screen.
Click on the PhixFlow name or logo to display the , PhixFlow displays the a list of the applications available to you. To return to the application menu at any time, click Insert excerpt |
---|
| _app_menu |
---|
| _app_menu |
---|
nopanel | true |
---|
|
in the top left.
Image Added
In the application menu, applications are shown as cards or as a list. To switch view, click the icons in the top right of the application window.
Insert excerpt |
---|
| _show_card |
---|
| _show_card |
---|
nopanel | true |
---|
|
appmenuappmenuImage Removed. This shows the applications available to you as a set of cards. For example:To load an application:
- Click anywhere in a card
to open the application. PhixFlow always asks if you want to confirm any action, including opening an application. Click Yes to continue. When you select an application:
In - or on a list line
- PhixFlow asks how you would like to load the application (load in current tab, new tab or new window)
- Click an option to continue to the application's Home window.
From here you can select an aspect of your application on which to work
To create a new application from the application menu, click the
design_modedesign_mode, PhixFlow loads the application. This means the repository shows only the items for the application.In When you load an application, PhixFlow opens its home window.
Image Added
This window layout remains the same when you select different things to work on. For example, the following screenshot shows an entity relationship diagram (ERD). In addition to the repository, you can see that the right panel is displaying context help for ERDs.
Image Added
The home window has the following parts.
Header Bar
The header bar runs across the full width of the PhixFlow Window. It shows, from left to right:
modemode PhixFlow runs . An application has its own menus, to provide the application user with the options they need. See also: Application Menu.
Application Help
Application designers are responsible for providing help about how to use an application.Task Bar Anchor |
---|
TaskBar | TaskBar | At the bottom of the PhixFlow window is the grey task bar. The task bar display varies for desktop and mobile devices.
Design Mode
Design mode has a workspace on the left and the repository tab on the right. The repository lists the items in PhixFlow to which you have access. If the repository is not visible, click The Repository, Items and Properties
When you open PhixFlow in design mode, PhixFlow opens the Repository tab on the right of the screen; see Using the Repository.
Double-click on an item in the repository to open its properties tab. Here you can set the properties for modelling objects and application components.
In addition to having properties, you can open and edit some items in the workspace on the left. These are:
- Analysis Models: represent the flow and transformation of data.
- Stream Views: display the data in streams as tables (called grids) and charts.
- Dashboards: combine several stream views. Application screens are dashboards with more complex layouts, including menus and actions.
To display and update these items:
- From the repository, open the item's properties.
- From the toolbar on the properties tab, click the icon for the item, which is its Display option.
- PhixFlow opens the item in the workspace on the left.
Property Tabs - menu to load a different application
-
Insert excerpt |
---|
| _phixflow_logo_name |
---|
| _phixflow_logo_name |
---|
nopanel | true |
---|
|
: also opens the application menu. Depending on the way your administrator has configured PhixFlow, this logo may be replaced by your company logo - Quick access to the main activities:
- Home
- ERDs
- Workflows
- Screens
- Actionflows
- Analysis Models
- The name of the PhixFlow server on which you are working
Insert excerpt |
---|
| _user_details |
---|
| _user_details |
---|
nopanel | true |
---|
|
: options to manage your user details, passwords and to Insert excerpt |
---|
| _logout |
---|
| _logout |
---|
nopanel | true |
---|
|
- Open the
Insert excerpt |
---|
| _repository |
---|
| _repository |
---|
nopanel | true |
---|
|
icon in the bottom left of the window.- Open the Learning Centre
Insert excerpt |
---|
| _administration |
---|
| _administration |
---|
nopanel | true |
---|
|
lists the system options, including the Insert excerpt |
---|
| _console |
---|
| _console |
---|
nopanel | true |
---|
|
, which monitors different processes and tasks; see Administration Menu. The options you see depend on your permissions. .
- The option to switch to the other PhixFlow mode,
- either
Insert excerpt |
---|
| _design_mode |
---|
| _design_mode |
---|
nopanel | true |
---|
|
- or
Insert excerpt |
---|
| _app_mode |
---|
| _app_mode |
---|
nopanel | true |
---|
|
.
Workspace and Tabs
Every diagram or screen that you have open in the workspace has a tab at the top. Click on a tab to switch between different open items in the workspace.
This toolbar has options specific to the item on which you are working.
Layers Panel
When you are working on screen design, PhixFlow displays a Layers panel on the left of the screen. This panel shows how the different items on the screen are related to each other, and highlights any element you have selected. Click the
Insert excerpt |
---|
| _layer_slider |
---|
| _layer_slider |
---|
nopanel | true |
---|
|
to show or hide the Layers panel.Right Panel
On the right there are several things that PhixFlow can display. You can click the
Insert excerpt |
---|
| _panel_show_hide |
---|
| _panel_show_hide |
---|
nopanel | true |
---|
|
to hide all the tabs that are open in the right panel: tab tab tab tabs the - its tab, which shows the name of the item.
- To keep a property
tab - pane open, click the icon in its
tab. To unpin a property - tab, then click the
Insert excerpt |
---|
| _pinned |
---|
| _pinned |
---|
nopanel | true |
---|
|
icon to then close it. - To view
tabs the tab - pane onto the workspace. This creates a second
properties area- right panel. You can create
several property areas - multiple right panels and you can drag
properties tabs - property panes between them.
- To close a property tab, click on the white cross on the tab.
- To resize the right panel, drag its border line.
Every properties
tab pane has a toolbar at the top, next to the item name. If the item name is long, toolbar icons are condensed into a
toolbarsquashedtoolbarsquashedIf you do not want to show the help panel again, tick the check box at the bottom of the panel. To subsequently show the panel, go to Insert excerpt |
---|
_user_details | _user_details | nopanel | true |
and tick the Show the Help Tab on Startup check box.To open the help about the options in a properties tab, click When you first log into PhixFlow in Insert excerpt |
---|
_design_mode | _design_mode | nopanel | true |
, you will see a Help tab on the right, as well as the Repository tab. The Help tab provides links to the help and training.- The help button in the header bar will take you to the learning centre where you will find video tutorials, example data sets, template applications, as well as the ability search our extensive help library for your specific topic.
- Item properties and windows in PhixFlow include a
in at the top of the tab.When you delete a PhixFlow item it is deleted from the repository and from any model or dashboard that contains it. Deleting cannot be undone. For this reason, PhixFlow
- always asks for confirmation that you really do want to delete an item before actually deleting it.
- will not delete an item when another object within PhixFlow still refers to it.
PhixFlow notifies you about how many and what type of items still refer to the item you are trying to delete.
In analysis models, consider using the alternative pop-up toolbar option, Insert excerpt |
---|
_remove | _remove | nopanel | true |
. This removes the modelling object from the model, but it remains in the repository.To delete an item completely, right-click any item to display its context menu and click Insert excerpt |
---|
_delete | _delete | nopanel | true |
. Selecting and Deleting Items
Either in the repository or in dashboards or models, you can click an item to select it. A selected item is highlighted. Also the highlighting on any previously selected items is cleared.
There are several places in PhixFlow where you can make a change to several items at the same time, for example deleting items. To select a continuous subset of items in a list,
- Select the first item on the list.
- Hold down the Shift key.
- Then select the last item.
To select several items separately, press the Control (Ctrl) key as you click the different items. This will add each item to the list of selected items. If you click on an item that is already selected, it is removed from the selection list.
Drag-and-Drop
The user can drag-and-drop many of the items in PhixFlow. What happens when you drag items depends on the context. In general:
- Items can only be dragged onto a compatible location. PhixFlow does not let you drop an item if it makes no sense for the item to be in that location.
- You can often drag multiple selected items to/from lists.
- Items can be reordered when dragged into ordered lists. For example, the order of the items is important in the Stream Attributes.
- In model windows, you can drag single or multiple modelling objects around the model; see Using the Model Window.
To drag objects off the model and onto another location, select the object and then use Shift-drag. - One or more Stream Views can be dragged onto Dashboards to display data.
Context Menus Anchor |
---|
contextMenu | contextMenu | Right-click any item to display its context menu. You can display a context menu when you right-click:
- its name in the repository
- for modelling objects, its icon in a model
- for layout components, its representation in a dashboard
Analysis Model objects always have the context menu entry Insert excerpt |
---|
_model_show | _model_show | nopanel | true |
. This displays a list of all the models in which the current object exists.Deleting Items
PhixFlow does not have an option to undo an action such as deletion. Take care when you use the Insert excerpt |
---|
_delete | _delete | nopanel | true |
option as this removes the selected item from the repository. It can affect other items that also use the item you are deleting. For analysis models, it is safer to use the Insert excerpt |
---|
_remove | _remove | nopanel | true |
option, which erases the selected modelling object from the model, whilst leaving it in the repository and in other models that use it.Error Messages
If you are using a PhixFlow application, the messages you see related to actions within the application are written by application designers using the Action → Confirmation Message.
- . Click the help icon to open the associated reference help page, which has details about each option.
Notifications and Errors
PhixFlow displays notification popups on the screen. The different coloured notifications are:
- Green - information
- Blue - warnings
- Red - errors.
You can click Dismiss notifications in the header bar to close all green and blue notifications. In
Insert excerpt |
---|
| _administration |
---|
| _administration |
---|
nopanel | true |
---|
|
→ System → Configuration you can set the Notification Timeout to automatically close these popups; see System Configuration.If there is an error that prevents PhixFlow completing something, it will display
the system a red error message. You must close these messages individually.
Image RemovedImage Added
The message window can include | If | Administrator Links |
---|
a More Detail link to technical information | your user account or user group has the Show Console privilege | |
a button to open the log file containing the error message | your user account or user group has the View Log Files privilege |
a Report button to email the details to IT support, The email includes a link to the log file, so the administrator can easily access full details of the error. | there is an IT email recipient configured in System Configuration → General settings → Error Reporting Email Address. | |
Administrators monitor the details of what PhixFlow is doing using the System Console and can configure how much detail is logged; see System Monitoring and System Logging Configuration.