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 Image RemovedApp 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 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 Image Removed 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 Image Removed Design Mode. ??Update Icon

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

Table of Contents
indent12px
stylenone

Selecting an Application

??What happens for an AppUser on login

The Welcome window lists all the applications available to you. You can change the view from tile to list view or search for an application by name.

The Welcome window has links to the latest videos from the learning centre.

Image Removed

To return to the Welcome window, click the ??Add Application list icon or PhixFlow logo in the top right.

The PhixFlow 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.

The ??Add Application list icon is always present.

Application Design Home Window

Image Removed

PhixFlow Window Areas

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_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. Insert excerpt_user_details_user_detailsnopaneltrue Insert excerpt_console_consolenopaneltrue Insert excerpt_administration_administrationnopaneltrue –  the options available depend on your permissions. Insert excerpt_palette_palettenopaneltrue Insert excerpt_repository_repositorynopaneltrueeither  Insert excerpt_design_mode_design_modenopaneltrue or  Insert excerpt_app_mode_app_modenopaneltrue.
  • 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 mobile devices, such as tablets

    Insert excerpt
    _Banners
    _Banners
    nameGettingStarted
    nopaneltrue

    Overview

    PhixFlow has two distinct modes depending on what you need to do.

    Insert excerpt
    _design_mode
    _design_mode
    nopaneltrue
     

    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
    nopaneltrue
     and 
    Insert excerpt
    _app_mode
    _app_mode
    nopaneltrue
    , where you can see your application in action by clicking the mode icon in the top right of the PhixFlow window.

    Insert excerpt
    _app_mode
    _app_mode
    nopaneltrue
     

    Application users run PhixFlow applications in this mode.
    PhixFlow displays only essential menus and toolbars in 

    Insert excerpt
    _app_mode
    _app_mode
    nopaneltrue
    . Your administrator usually configures PhixFlow so that an application user has no access to 
    Insert excerpt
    _design_mode
    _design_mode
    nopaneltrue
    . 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 

    Insert excerpt
    _app_menu
    _app_menu
    nopaneltrue
    .

    You can change the layout of the application menu, using icons in the top right of the application window. 

    Insert excerpt
    _card_or_list
    _card_or_list
    nopaneltrue

    Image Added

    To open an application:

    1. Double-click anywhere in a card or on a list line
    2. PhixFlow asks you to confirm
    3. 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 

    Insert excerpt
    _add
    _add
    nopaneltrue
     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

    on the

    field

    move. As mobile devices have less screen space available, the

    task

    header bar is simplified to show the icons:

    • Insert excerpt
      _
    logout
    • user_options
      _
    logout
    • user_options
      nopaneltrue
    • Insert excerpt
      _
    window_bar
    • administration
      _
    window_bar
    • administration
      nopaneltrue
       – option available depending on user's permissions

    Image Added

    How to use Design Mode

    Insert excerpt
    _

    user

    design_

    details

    mode
    _

    user

    design_

    details

    mode
    nopaneltrue
    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 

    Insert excerpt
    _

    administration

    design_mode
    _design_

    administration

    mode
    nopaneltrue

     –  the options available depend on your permissions.

    Application Mode

    Using the Application Menu Changed

    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
    nopaneltrue
     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
      nopaneltrue
    • Insert excerpt
      _
    app
    • show_
    menu
    • list
      _
    app
    • show_
    menu

    Image Removed

    • list
      nopaneltrue
    . This shows the applications available to you as a set of cards. For example:

    To load an application:

    1. 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 
    1. or on a list line
    2. PhixFlow asks how you would like to load the application (load in current tab, new tab or new window) 
    3. 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 

    Insert excerpt
    _

    design_mode

    add
    _

    design_mode

    add
    nopaneltrue
     button on the left of the menu; see Creating an Application.

    Home Window and Workspace

    , 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 
    Anchor
    TaskBar
    TaskBar

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

    • Insert excerpt
      _app_
    mode
    • menu
      _app_
    mode
    • menu
      nopaneltrue
     PhixFlow runs
    • : reopen the application
    . 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 AnchorTaskBarTaskBar

    At the bottom of the PhixFlow window is the grey task bar. The task bar display varies for desktop and mobile devices.

    Design Mode

    Image Removed

    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:

    1. From the repository, open the item's properties.
    2. From the toolbar on the properties tab, click the icon for the item, which is its Display option.
    3. 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
      nopaneltrue
      : 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
      nopaneltrue
      : options to manage your user details, passwords and to 
      Insert excerpt
      _logout
      _logout
      nopaneltrue
    • Open the 
      Insert excerpt
      _repository
      _repository
      nopaneltrue
     icon in the bottom left of the window.
    • Open the Learning Centre 
      Insert excerpt
      _help
      _help
      nopaneltrue
    • Open the 
      Insert excerpt
      _chat_bot
      _chat_bot
      nopaneltrue
       Chat Bot
    • Insert excerpt
      _administration
      _administration
      nopaneltrue
       lists the system options, including the 
      Insert excerpt
      _console
      _console
      nopaneltrue
      , 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
        nopaneltrue
         
      • or 
        Insert excerpt
        _app_mode
        _app_mode
        nopaneltrue
        .

    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.

    Popup Toolbar

    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
    nopaneltrue
     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
    nopaneltrue
     to hide all the tabs that are open in the right panel:

    • Context Help
      Context help is available for all major activities within PhixFlow. It consists of a short video to help you get started and a set of links to key areas within the topic and further informationTo configure whether or not the context help is displayed, use your User Details → Show Contextual Help option.

    • Repository
      List all of the items that you can use; see Using the Repository.

    • Properties
      Click on the name of an item to open its properties

    tab
    • on the right. Usually PhixFlow opens each property

    tab
    • pane in the same space and automatically closes any saved property

    tab
    • pane

      • To switch between
    tabs
      • property panes, click on
    the
      • its tab, which shows the name of the item.
      • To keep a property
    tab
      • pane open, click the 
        Insert excerpt
        _pin
        _pin
        nopaneltrue
         icon in its tab
    . To unpin a property tab,
      • , then click the 
        Insert excerpt
        _pinned
        _pinned
        nopaneltrue
         icon to then close it.
      • To view
    tabs
      • panes side-by-side, drag
    the
      • a property
    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 

    Insert excerpt
    _

    toolbar

    more_

    squashed

    options
    _

    toolbar

    more_

    squashedIf 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_detailsnopaneltrue and tick the Show the Help Tab on Startup check box.To open the help about the options in a properties tab, click 

    options
    nopaneltrue
     icon.

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

    Accessing Help

    When you first log into PhixFlow in  Insert excerpt_design_mode_design_modenopaneltrue, 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 
      Insert excerpt
      _help
      _help
      nopaneltrue
     in
    •  icon on 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 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,

    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. 

    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 AnchorcontextMenucontextMenu

    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_shownopaneltrue. 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
    • . 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
    nopaneltrue
     → 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.

    Image Removed

     You must close these messages individually. 

    Image Added

    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.