Versions Compared

Version Old Version 34 New Version Current
Changes made by

Fiona Sargeant

Zoe Baldwin

Saved on

Key

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

Insert excerpt
_Banners
_Banners
nameapp
nopaneltrue

This page is for PhixFlow application developers designers who need to create a new application, or change the defaults for an existing application.

Overview

In PhixFlow you can combine layout components, such as tables, charts, menus and buttons, to create screens (dashboards). By connecting the layout components to the data in streams, you can create applications. Application users can load an application to interact with the stream data, for example to view and update it.

You can use the application properties tab to configure the application to set:

  • different data defaults compared to the PhixFlow system defaults
  • default style settings to use for all the layout components in the application
    • the options to appear in the menu bar for

    When you create an application in PhixFlow, you select a template. This configures default styles and formats for your application. For how to create a new application, see Creating an Application.

    When you are working on your application in

    Insert excerpt
    _design_mode
    _design_mode
    nopaneltrue
    , you can:

    This page lists the application properties. To open the application properties tab:

    1. Go to the
      Insert excerpt
      _repository
      _repository
      nopaneltrue
       tab. 
      If the tab is not present, in the PhixFlow toolbar, click the 
      Insert excerpt
      _repository
      _repository
      nopaneltrue
       icon.
    2. In the Applications section, double-click your application's name.
    3. PhixFlow opens the properties tab for the application on the right.

    Use the options to set:

    • icons for the application
    • defaults for:
      • number formats
      • styles for grids
      • components to use for displaying data.
    • menus so that user's can navigate through the application
    • access privileges to specify which users can use the application.
    • any packages containing shared resources that your application can use; see Package.

    Loading an Application

    Application users can load an application into 

    Insert excerpt
    _app_mode
    _app_mode
    nopaneltrue
    to interact with data, for example to view and update it.

    You can work on the files in an application's project without loading it. However, if you load an application, the repository is automatically filtered to show just the files available to the application. 

    There are several ways to load an application. You can:

    click the PhixFlow logo to open

    • From the application menu, click the application card to load it.
      By default, PhixFlow opens with the application menu displayed. To redisplay the menu, in the top left of the PhixFlow window click:
      • either the
        Insert excerpt
        _app_menu
        _app_menu
        nopaneltrue
      ; see Application, belowin
      • or the 
        Insert excerpt
        _phixflow_logo_name
        _phixflow_logo_name
        nopaneltrue
        , if it appears.
    • From the repository, right-click on the application name and select 
      Insert excerpt
      _app_load
      _app_load
      nopaneltrue
      in .
    • In a browser address bar, enter the application URL; see ee Starting PhixFlow on the Client. When PhixFlow is started in this way, you can still navigate to other applications that you have permission to access.
    Panel
    borderColor#7da054
    titleColorwhite
    titleBGColor#7da054
    borderStylesolid
    titleSections on this page

    Table of Contents
    indent12px
    stylenone

    Creating a New Application

    To create a new application:

    either in the repository, right-click Applications and click 

    Application 

    Insert excerpt
    _

    add

    property_toolbar
    _

    add

    property_toolbar
    nopaneltrue

    or, open the 

    Insert excerpt
    _

    app

    property_

    menu

    tabs
    _

    app_menu

    property_tabs
    namebasic-h
    nopaneltrue

    ; see Application, below.
    Click the last card, which is the New Application card:
    Image Removed

    When you create a new application in the repository, PhixFlow automatically creates a menu item for it. You can find the menu in the repository → Menus branch. The menu item has the application name with the _Menu suffix. When you add the first option to the menu, it is automatically displayed on the right of the top menu bar; see Menu.

    Application Properties

    Basic Settings

    Field


    Description

    Name

    		Enter the name of the application.


    Model Validation Status
    Insert excerpt
    _
    standard_settings_standard_settings
    validate
    _validate
    namestatus
    nopaneltrue

    Basic Settings

    FieldDescriptionNameThe name of the application.
    Version
    The
    Enter a version number
    of the
    for your application. Use this to track the stages of development or  maintenance for your application. 
    Do not show in the Application
    menu
    Menu
    Controls

    Select whether or not this application appears in the 

    Insert excerpt
    _app_menu
    _app_menu
    nopaneltrue
    . For example, you may have a test application that should not be visible to other PhixFlow users. Use the repository to open an application that is not present in the Welcome window's application list.

    Insert excerpt
    _check_box_untick
    _check_box_untick
    nopaneltrue
     to include this application.

    Insert excerpt
    _check_box_

    ticked

    tick
    _check_box_

    ticked

    tick
    nopaneltrue
     to exclude this application. This is useful for test applications that you do not want

    to appear on the menu

    anyone else to see.

    Default Date FormatSelect the default format for Date attributes and components.


    Select a format from the drop-down list or click the icons to:

    Insert excerpt
    _

    format_list

    date
    _

    format_list

    date
    nopaneltrue
    : shows the date or date/time formats available for this application in the repository.

    Insert excerpt
    _

    add

    new
    _

    add

    new
    nopaneltrue
    : create a new format.

    Default Date/Time
    Format
    Format Select the default format for DateTime attributes and components.
    Default Number FormatSelect the default format for numbers.

    Select a format from the drop-down list or click the icons to:

    Insert excerpt
    _list_number_formats
    _list_number_formats
    nopaneltrue
    : shows the number formats available for this application in the repository.

    Default Component

    Insert excerpt
    _new
    _new
    nopaneltrue
    : create a new format.

    Default Component Palette

    Select the palette that you want to use when you drag

    stream attributes

    a table, view or attribute onto a

    layout or area. PhixFlow

    screen canvas. 

    PhixFlow uses this palette when its container application is running.

    If the container application for is not running, PhixFlow uses:

    • either the default palette set for the area.

    • or the default palette for the destination application when you are dragging

    stream

    • attributes into a layout for a different (destination) application that is running.

    If you do not set a default palette, PhixFlow uses the system default palette.

    Tip

    Basic palettes are installed with PhixFlow. Additional palettes are available, see Understanding Template Packages and Installing Template Packages.

    Anchor
    images
    images

    Application Icon

    Select an uploaded image to use in

    the Application Menu card for this application.

    the application menu card for this application. We recommend an image size of approximately:

    • height: up to 100 pixels
    • width: 100 to 150 pixels.

    See Adding Images for how to upload an image to PhixFlow. 

    PhixFlow uploads application icons and logos to the images folder in its database. You can see a list of uploaded images in the repository > Images section.

    Application Logo

    Select an uploaded image to

    use as the logo to represent the Application Menu

    provide customised branding for the application. When a user clicks this image, it will open the application menu. We recommend an image size of approximately:

    • height: up to 40 pixels
    • width: up to 300 pixels.

    Style Settings

    When you drag a table or view onto a screen canvas, and select a grid component to display the table data, PhixFlow adds a grid. In this section, set the default appearance of grid views for the application. You can set the following:

    Grid Header
    • Default Header Icon Style
    • Default Header Dropdown Pane Style
    • Default Paging Style
    • Grid Header
    Button
    • Style
    • Grid Header
    Icon
    • Button Style
    • Grid Header
    Drop-down
    • Dropdown Button Style
    • Grid
    header Drop-down Pane
    • Row Style
    • Grid
    Paging
    • Alternate Row Style
    • Grid Row Hover Style - applies when the mouse is over a row in a grid.
    • Grid Column Style
    • Grid Column Header Style
    • Row Selection Style

    The styles you select override any styles set in System Configuration. You can override these defaults for individual grids using the style settings in the Stream View properties.

    To specify a style, select it from the drop-down list or click the icons to:

    • Insert excerpt
      _styles_
    style
    • ccs_list
      _
    style
    • styles_ccs_list
      nopaneltrue
    : shows the styles available for this application in the repository.
    •  to show available styles
    • Insert excerpt
      _add
      _add
      nopaneltrue
    :
    •  to create a new style; see Style.

    The styles you select override any styles set in System Configuration. You can override these defaults for individual grids using the style settings in the View properties.

    Default Components

    In this section, select an appropriate component for PhixFlow to add when you drag attributes onto a form or card container. For information about data types, see Understanding Data Types.

    • String
    • Bigstring
    • Long
    • Float
    • Decimal
    • True/False
    • Date
    • DateTime

    Also set the styling for a:

    • Form
    • Card
    • Drop Down
    • Dynamic Text

    And select a default:

    • Table Action - This is the button that PhixFlow adds when you drag a table-action onto a screen canvas.
    • Menu Button

    Menus

    This section has a toolbar with standard buttons. The grid lists the menus that have

    stream

    actionflows or record-actions that can be applied for this application.

    PhixFlow automatically creates a default menu when you create the application project. PhixFlow will display in the default menu in the menu bar:

    • once you have added options to the menu
    • and when Show Default Menu Bar is selected (see below).

    If there are several menus, listed PhixFlow uses the selected (ticked) menu as the menu bar for the application.

    You can specify that PhixFlow uses a different menu for desktop and mobile devices.

    In the grid, right

    Right-click on a

    menu to display the context menu and select

    line in the list to show the popup menu options:

    • Insert excerpt
      _menu_desktop
      _menu_desktop
      nopaneltrue
      : use this menu on desktop devices. The grid shows the desktop icon next to the menu name.

    • Insert excerpt
      _menu_mobile
      _menu_mobile
      nopaneltrue

    PhixFlow displays

    • : use this menu on mobile devices. The grid shows the mobile

    or desktop

    • icon next to the

    application's name. Using that context menu the user can also load the Application with selected menu. All options available in the context menu are:You can also use the context menu to

    • menu name.

    • Insert excerpt
      _

    add

    • new
      _

    add

    • new
      nopaneltrue

    : add
    : delete

    •  delete the menu from this application.

    Access Permissions

    FieldDescriptionAll Users Can View Application

    Insert excerpt
    _

    check_box_ticked

    access
    _

    check_box_ticked

    access
    nopaneltrue

     all users can view this application. Insert excerpt_check_box_untick_check_box_unticknopaneltrue to specify the user groups that can access this application.User GroupsThis section is only available if All Users Can View Application is unticked. This section has a toolbar with standard buttons and  Insert excerpt_user_group_user_groupnopaneltrue.

    The grid contains a list of user groups that have permission to access to this application. To add a user group to the list:

    Click Insert excerpt_user_group_user_groupnopaneltrue to list all the user groups in the repository.
  • Drag user groups into this list. 
    • To remove a user group from the list, use the Insert excerpt_delete_deletenopaneltrue in the toolbar.

    Advanced

    Field

    		Description
    Backslashes must be escaped in expressions

    There is a change in 9.0.0 which affects escaped backslashes in expressions. This option maintains backwards compatibility. By default this will be ticked for applications created before 9.0.0, and unticked for later applications. 

    Packages

    This section has a toolbar

    with standard

    with standard buttons. The grid contains a list of packages

    that contain this application. To add an application to the list

    .

    A package is a bundle of PhixFlow items that are shared between multiple applications. When you export/import an application to another PhixFlow instance, it is important to export/import all packages with the application; see Application Administration.

    One package will include your applications theme settings. To add another package to the application:

    1. Click
      Insert excerpt
      _
    add
    1. packages
      _
    add
    1. packages
      nopaneltrue
       to list all the packages in the repository.
    2. Drag packages into this list. 

    To remove a package from the list, use the toolbar button  

    Insert excerpt
    _delete
    _delete
    nopaneltrue

     in the toolbar

    .

    Application Menu and Context Menus

    The Application Menu

    In both 

    Insert excerpt
    _

    app_mode

    audit
    _

    app_mode

    audit
    nopaneltrue

     and 

    Insert excerpt
    _

    design_mode

    description
    _

    design_mode

    Application Card Context Menu

    Each application card also has a context menu. To open the application card context menu:

    • either right-click anywhere in the card
    • or hover your mouse pointer over the card to display its 3-dot context menu icon in the top right.
      Click the 3-dot icon Image Removed  icon.

    Repository Application Context Menu

    Applications also have different context menu available from the repository. To open the repository application context menu, right-click the name of an application.

    Image Removed

    Context Menu Options

    Available in context menu

    description
    nopaneltrue

    , if your PhixFlow URL does not specify an application, the  Insert excerpt_app_menu_app_menunopaneltrue opens automatically when you log into PhixFlow. The  Insert excerpt_app_menu_app_menunopaneltrue lists the applications available in the current PhixFlow instance.You can open the  Insert excerpt_app_menu_app_menunopaneltrue at any time.
    • Either click on the PhixFlow logo and name  Image Removed, in the top left of the PhixFlow screen.
    • Or, if your application has been configured to have no menu bar, click the PhixFlow logo Image Removed in the bottom right of the PhixFlow screen.

    The applications are shown in cards, for example:

    Image Removed

    TipThe  Insert excerpt_app_menu_app_menunopaneltrue displays the applications:
    • that have been configured to appear on menu
    • and that you have permission to use.

    The repository → Applications branch displays the applications that you have permission to use.

    Popup Menu Options

    To access popup menus for an application:

    • Either, in the repository, right-click on an application's name to show the popup menu.
        Image Added
    • Or, in the application menu:
      • click the 
        Insert excerpt
        _more_options
        _more_options
        nopaneltrue
      • right-click anywhere on the card

    Image Added

    Available in a popup accessed fromOptionDescription

    application card and
    repository application name


    		Image Added Load Application
    Load the selected application so that it is running in 
    Insert excerpt
    _app_mode
    _app_mode
    nopaneltrue
    .
    application cardLoad application in a New TabOpen a new browser tab with the selected application loaded.
    application cardLoad Application in a New WindowOpen a new browser window with the selected application loaded.
    repository application nameImage Added Filter by NameIn the repository
    browser, use the application name to display only the repository tree for
    . filter the list of applications to only show the selected application. The application is not loaded.
    repository application name
    Edit

    Insert excerpt
    _edit
    _edit
    nopaneltrue

    In
    Insert excerpt
    _design_mode
    _design_mode
    nopaneltrue
    , open the
    properties for the selected application
    application properties tab to make changes.
    repository application name
    Insert excerpt
    _delete
    _delete
    nopaneltrue
    		Delete the selected application from the repository. This cannot be undone.



    Live Search
    spaceKey@self
    additionalnone
    placeholderSearch all help pages
    typepage

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

    Table of Contents
    maxLevel3
    indent12px
    stylenone


    Learn More