Versions Compared

Key

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

This page is for any user of PhixFlow. It explains the different areas in the PhixFlow interface.

Overview

PhixFlow appears slightly different depending on how you are using it.

Application User

You do all your tasks using one or more PhixFlow applications. You may work on:

  • a desktop or laptop computer
  • a mobile device, such as a tablet or smartphone.

In this case, you run PhixFlow in App Mode. ??Update Icon

Application Designer

You use PhixFlow to design applications. As well as creating screen layouts, you manage the data for the application and wire in set up actionflows. We recommend that you use design mode on a desktop computer as you require screen space to build analysis models and design application screens.  For these tasks, you run PhixFlow in  Design Mode. ??Update Icon

Data Modeller

PhixFlow has a powerful tool called analysis models . You can create analysis models to import, processing and export data. This can be part of your application, or may be for batch processing of data not related to an application. To model data,  you run PhixFlow in  Design Mode. ??Update Icon


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

Table of Contents
indent12px
stylenone


Application Mode

When you log into PhixFlow to use an application, the Welcome screen lists all the applications available to you. 
??What happens for an AppUser on login, I will make you a screenshot

??Mock up. Needs header bar label.  Admin maybe?

Applications are shown as a set of cards. You can use the buttons on the right to switch between a card and a list view.

Click anywhere in a card to run the application. PhixFlow always asks if you want to confirm any action, including opening an application. Click Yes to continue. When you load an application, all the window except the grey header bar, is an application designed by your company. It will have its own menus and navigation, to provide you with the options you need. 

You can return to the Welcome window at any time by clicking on the ??Add dot iconicon in the top leftThe PhixFlow logo also returns to the Welcom window. However, this logo is not present if:

  • you are running PhixFlow on a mobile device
  • your administrator has configured PhixFlow logo to display your company logo instead.

See also: Application Menu.

On Mobile Devices

What's visible on mobile??

PhixFlow applications are often deployed on mobile devices, such as tablets. This means team members can access and update data whilst in the field. As mobile devices have less screen space available, the header bar is simplified to show the icons:

  • Insert excerpt
    _user_details
    _user_details
    nopaneltrue
  • Insert excerpt
    _administration
    _administration
    nopaneltrue
     –  the options available depend on your permissions.

Application Help

Application designers are responsible for providing help about how to use an application.

Design Mode

Working on an Application

The Welcome window lists all the applications available to you. 

Applications are shown as a set of cards. You can use the buttons on the right to switch between a card and a list view. You can change the view from tile to list view or search for an application by name. This is also where you can find links to the latest videos from the learning centre.


To You can return to the Welcome window , click at any time by clicking on ??Add dot icon Application list icon or PhixFlow logo in the top rightleft. The PhixFlow logo is not present if:

  • you are running PhixFlow on a mobile device
  • your

    if your administrator has configured PhixFlow logo to display your company logo instead

    .

    The ??Add Application list icon is always present.

    ??Add link to the Application page

    If you do not want to work on something that is in an application, such as an analysis model, click the repository icon on the right. The repository list slides open and you can search for the item you want to work on.

    Application Design Home Window

    In Design Mode, when you select an application to work on PhixFlow shows the Application Design Home window. 

    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  Insert excerpt_design_mode_design_modenopaneltrue, PhixFlow loads the application. This means the repository shows only the items for the application.

    From continueto the Application Design Home window. From here you can select one an aspect of main your application items on which to work.

    PhixFlow Window Areas

    PhixFlow is a visual tool for developing applications or modelling data. There are several different diagrams that you can work on, such as workflows, ERDs, screen layouts and analysis models.

    The following labelled screenshot shows the main areas of the PhixFlow window when you are working on a diagram, in this case an ERD.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  Insert excerpt_repository_repositorynopaneltrue icon in the bottom left of the window.

    The Header Bar 
    Anchor
    TaskBar
    TaskBar

    ??Search and replace whole help task bar → header barOn Desktop or Laptop Computers

    For desktop or laptop computers, the task bar shows:

    on the left:the  Insert excerpt_logout_logoutnopaneltrue button
  • the number of currently running actions
  • in design mode, the number of windows open in the workspace
  • the 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
  • AnchorformBarformBarWhen 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.

    The header bar runs across the full width of the PhixFlow Window. It shows, from left to right:

    • The Application list icon and, optionally the PhixFlow logo. Both these act as a home button, returning you to the Welcome window and list of applications
    • Quick access to the main application aspects, Application Home, Data, Screens and Analysis models. 
    • The name of the PhixFlow server 
    • Insert excerpt
      _user_details
      _user_details
      nopaneltrue
      . This provides access to your user account and the 
      Insert excerpt
      _
      console
      logout
      _
      console
      logout
      nopaneltrue
       button
    • Insert excerpt
      _
      administration
      repository
      _
      administration
      repository
      nopaneltrue
       –  the options available depend on your permissions.
    • Insert excerpt
      _
      palette
      console
      _
      palette
      console
      nopaneltrue
    • Insert excerpt
      _
      repository
      administration
      _
      repository
      administration
      nopaneltrue
       –  the options available to you depend on your permissions.
    • either 
      Insert excerpt
      _design_mode
      _design_mode
      nopaneltrue
       or 
      Insert excerpt
      _app_mode
      _app_mode
      nopaneltrue
      .
    • 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.

    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. 
    • Could this be a slider??

    The Applications Menu Bar

    If the open application has it's own menu bar configured, this appears below the header bar.

    Where are these now??

    • the number of currently running actions
    • the status of any actions,

    Tabs for Open Diagrams

    For every diagram or screen that you open, PhixFlow creates a new tab. You can easily switch between open items using the tabs.

    Property Tabs 

    Click on the name of an item to open its properties tab on the right. Usually PhixFlow opens each property tab in the same space and automatically closes any saved property tab. 

    • To switch between tabs, click on the tab, which shows the name of the item.
    • To keep a property tab open, click the 
      Insert excerpt
      _pin
      _pin
      nopaneltrue
       icon in its tab. 
    • To unpin a property tab, click the 
      Insert excerpt
      _pinned
      _pinned
      nopaneltrue
       icon.
    • To view tabs side-by-side, drag the property tab onto the workspace. This creates a second properties area. You can create several property areas and you can drag properties tabs between them.
    • To close a property tab, click on the white cross on the tab.

    Every properties tab has a toolbar at the top, next to the item name. If the item name is long, toolbar icons are condensed into a 

    Insert excerpt
    _toolbar_squashed
    _toolbar_squashed
    nopaneltrue
     icon.

    For information about the properties tabs and their toolbar options, see Menu Options and Toolbar Buttons.

    Repository

    Accessing Help

    When you first log into PhixFlow in 

    For any task, PhixFlow provides list of the relevant items that you can use. There is also a repository, which lists the items in your application; see Using the Repository. Click the repository icon on the right edge show or hide the repository.

    Notifications

    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.

    Accessing Help

    In 

    Insert excerpt
    _design_mode
    _design_mode
    nopaneltrue
    , you will see a Help tab on the right, as well as the Repository tab. The Help tab provides links to the help and trainingcan click on the Help icon on the right edge to show or hide the Help panel. This provides simple instructions and short videos to help you with your current task. It also links to the Learning Centre, which has more detailed tutorials and reference help.

    If 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
    nopaneltrue
     and tick the Show the Help Tab on Startup check box. Devs - Make sure this going away??

    To open the reference help about the options in a properties tab, click 

    Insert excerpt
    _help
    _help
    nopaneltrue
     in the toolbar 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_removenopaneltrue. 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_deletenopaneltrue

    Selecting and Deleting Items

    Either in the repository or in dashboards or modelsdiagrams, 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,

    1. Select the first item on the list.
    2. Hold down the Shift key.
    3. 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

    Remove from or Delete Everywhere

    When you are working in diagrams and you no longer want an item to appear, you can:

    • either remove it from the diagram. Use this option if you added an item that already existed in the repository and now you do not need it in your diagram.
    • or delete it from this diagram and from the repository. You may want to do this if you created the item for this diagram only, and now no longer need it.

    When you use Delete Everywhere, the item 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.

    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 an item's name in the repository
    • for modelling objects, its icon in a modelfor layout components, its representation in a dashboarddiagrams, an item's icon on the canvas
    • for screens, a components.

    Analysis Model objects always have the context menu entry 

    Insert excerpt
    _model_show
    _model_show
    nopaneltrue
    . 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_deletenopaneltrue 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_removenopaneltrue 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.

    If there is an error that prevents PhixFlow completing something, it will display the system error message.

    The message window can includeIfAdministrator Links
    a More Detail link to technical informationyour user account or user group has the Show Console privilege
    a button to open the log file containing the error messageyour user account or user group has the View Log Files privilege

    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.