Versions Compared

Key

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

Insert excerpt
_Banners
_Banners
nameGettingStarted
nopaneltrue

Overview

PhixFlow appears slightly different has two distinct modes depending on whether you are using it as an Application User or Application Designer.

Application User

Perform all of their activity in PhixFlow application mode. They are not provided access to the design side of the application. A users access is set in their user profile as configured by the System Administrator or Application Designer.

Application Designer

Use PhixFlow to configure applications. They design the screens, data structure and all elements that make up an application. We recommend that 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
 is used on a desktop or laptop computer, as you require screen space to build analysis models and design application screens.

Image Removed Application Mode

Image Removed

Selecting Applications

Applications are shown as a set of cards on the welcome screen. You can use the buttons on the right to switch between a grid and a list view of the application cards or search for an application by name.

Double click anywhere on a card to open the application.

You can return to the Welcome window by clicking on the . 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
 icon in the top left.

Opening Specific Application with URL

To open a specific PhixFlow application using a URL, the address must include the following at the end. Note that APP is the name of your application.

?application=APP

To see the URL for any PhixFlow application simply open the application and copy the address from the address bar

On Mobile Devices

PhixFlow applications support

.

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 fieldmove. As mobile devices have less screen space available, the header bar is simplified to show the icons:

  • Insert excerpt
    _user_options
    _user_options
    nopaneltrue
  • Insert excerpt
    _administration
    _administration
    nopaneltrue
     – option available depend depending on user's permissions.

Image Removed

Image Removed Design Mode

PhixFlow Image Added

How to use Design Mode

Insert excerpt
_design_mode
_design_mode
nopaneltrue
is a powerful tool for creating configuring applications that help automate business processes. Design mode is where users can setup workflows,

You can:

  • plan the workflows and tasks for application users 
  • define data structures
,
  • design application screens
, configure the actions users can perform and create analysis models that process data and provide integration with external systems. To switch between Design mode and Application mode click: 
  • 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
_design_mode
_design_mode
nopaneltrue
 and Insert excerpt_app_mode_app_modenopaneltrue.The Welcome window lists all , PhixFlow displays the a list of the applications available to you, as for . To return to the application menu at any time, click 
Insert excerpt
_app_
mode
menu
_app_
mode
menu
nopaneltrue
 
(above).

Image Removed

To return to the Welcome window, click 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
    _
app
  • show_
menu
  • card
    _
app
  • show_
menu
  • card
    nopaneltrue
 or, if it is present, the PhixFlow logo 
  • Insert excerpt
    _
phixflow
  • show_
logo_name
  • list
    _
phixflow
  • show_
logo_name
  • list
    nopaneltrue
 in the top left. The PhixFlow logo is not present if your administrator has configured PhixFlow logo to display your company logo instead; see System Configuration.

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.

When you select an application, PhixFlow opens the application Home window; see Building Applications for details.

PhixFlow Window Areas

PhixFlow is a visual tool for configuring applications or modelling data. The arrangement of PhixFlow's window is consistent for designing screens and for the different diagrams that you can work on, such as ERDs 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.

Image Removed

The

To load an application:

  1. Click anywhere in a card 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
_add
_add
nopaneltrue
 button on the left of the menu; see Creating an Application.

Home Window and Workspace

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:

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

  • Insert excerpt
    _app_menu
    _app_menu
    nopaneltrue
    : reopen the application 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 application aspects, Application Home, Data, Screens and Analysis models. activities:
    • Home
    • ERDs
    • Workflows
    • Screens
    • Actionflows
    • Analysis Models
  • The name of the PhixFlow server server on which you are working
  • Insert excerpt
    _user_details
    _user_details
    nopaneltrue
    . This provides access to : options to manage your user account details, passwords and the to 
    Insert excerpt
    _logout
    _logout
    nopaneltrue
     button
  • Open the 
    Insert excerpt
    _repository
    _repository
    nopaneltrue
  • Open the Learning Centre 
    Insert excerpt
    _help
    _help
    nopaneltrue
  • Open the 
    Insert excerpt
    _consolechat_bot
    _chat_consolebot
    nopaneltrue
     Chat Bot
  • Insert excerpt
    _administration
    _administration
    nopaneltrue
     lists the system options, including the 
    Insert excerpt
    _console
    _console
    nopaneltrue
     –  the options available to you , 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 
    •  
    • or 
      Insert excerpt
      _app_mode
      _app_mode
      nopaneltrue
      .

Workspace and Tabs

for Open Diagrams

For every

Every diagram or screen that you

open, PhixFlow creates a new tab. You can easily switch between open items using the tabs

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 

click the 

Insert excerpt
_panel_show_hide
_panel_show_hide
nopaneltrue
 to hide all the tabs that are open

on

in the right

. This is useful if you need more canvas to work on a diagram or screen.Property Tabs 

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
_more_options
_more_options
nopaneltrue
 icon.

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

Repository

For any task, PhixFlow provides list of the relevant items that you can use.  If you want to see all the items in your application click the Insert excerpt_repository_repositorynopaneltrue button; see Using the RepositoryClick on the  Insert excerpt_help_helpnopaneltrue button to open the help panel. 

Left 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. Click the  Insert excerpt_layer_slider_layer_slidernopaneltrue to show or hide the Layers panel.

Accessing Help

There are several ways to get help in PhixFlow.

  • On the Welcome page you can easily access the Learning Centre videos about new features in PhixFlow.
  • Working in  Insert excerpt_design_mode_design_modenopaneltrue, as you use PhixFlow, the Help panel on the right provides simple instructions and short videos to help you with your current task. There are also links to more detailed tutorials and reference in the Learning Centre or PhixFlow's Confluence Help.
    To configure whether or not the Help panel is displayed, use your User Details → Show Contextual Help Panes option

    Accessing Help

    • 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
       icon on the toolbar. This goes directly to the relevant Click the help icon to open the associated reference help page, which has details about each option.

    Notifications and Errors

    PhixFlow displays notification pop-ups popups on the screen. The different coloured notifications are:

    • green Green - information
    • blue Blue - warnings
    • red Red - errors.

    You can click Dismiss notifications to notifications in the header bar to close all green and blue notifications. You must close red error messages individually.

    You may also see a small notification about the number of running actions in the bottom right of the PhixFlow window: Image Removed

    Context Menus AnchorcontextMenucontextMenu

    Right-click any item to display its context menu. You can display a context menu when you right-click:

    • in the repository: an item's name
    • in a diagram: an item's icon on the canvas
    • in a screen: a component.
    Analysis model objects always have the context menu entry 

    In

    Insert excerpt
    _

    model_show

    administration
    _

    model_show

    administration
    nopaneltrue

    . This displays a list of all the models in which the current object exists.

    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 or using an actionflow; see Understanding Actionflows

     → 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 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.