Versions Compared

Key

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

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 to create an application GUI, you add layout components to a dashboard. Layout components include 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 the application
  • access privileges to specify which users can use the application.

Loading an Application

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

  • click the PhixFlow logo to open the
    Insert excerpt
    _app_menu
    _app_menu
    nopaneltrue
    ; see 7273120153see The Application Menu, below
  • in the repository, right-click on the application name and select 
    Insert excerpt
    _app_load
    _app_load
    nopaneltrue
  • in a browser, enter the application URL; see 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 

    Insert excerpt
    _add
    _add
    nopaneltrue

  • or, open the 

    Insert excerpt
    _app_menu
    _app_menu
    nopaneltrue
    ; see 7273120153The Application Menu, below below.
    Click the last card, which is the New Application card:

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 application_name_Menu suffix. When you add the first option to the menu, it is automatically displayed on the right of the top menu bar at the top of the PhixFlow window; see Menu.

For information about sharing components or data between applications, see Package.

Application Properties

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

Basic Settings

Field

Description

Name

The name of the application.

Version

The version number of the application.

Do not show in the Application menu

Controls whether or not this application appears in the 

Insert excerpt
_app_menu
_app_menu
nopaneltrue
.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to include this application.

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to exclude this application. This is useful for test applications that you do not want to appear on the menu.

Default Date Format

Select 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
_format_list
nopaneltrue
: shows the formats available for this application in the repository.

Insert excerpt
_add
_add
nopaneltrue
: create a new format.

Default Date/Time Format

Select the default format for DateTime attributes and components.

Default Number Format

Select the default format for numbers.

Default Component Palette

Select the palette that you want to use when you drag stream attributes onto a layout or area. 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.

Application Icon

Select an uploaded  image to use in the Application Menu card the application menu card for this application. Suggest size??We recommend an image size of approximately:

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



See Image for how to upload an image to PhixFlow.

Application Logo

Select an uploaded image to represent the Application MenuSuggest size??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

In this section, set the default appearance of grid views for the application. You can set:

  • Grid Header Style

  • Grid Header Button Style

  • Grid Header Icon Style

  • Grid Header Drop-down Button Style

  • Grid header Drop-down Pane Style

  • Grid Paging Style

  • Grid Row 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
    _style_list
    _style_list
    nopaneltrue
    : shows the styles available for this application in the repository.

  • Insert excerpt
    _add
    _add
    nopaneltrue
    : create a new style.

Menus

This section has a toolbar with standard buttons. The grid lists the menus that have stream actions that can be applied for this application. 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-click a menu to display the context menu and select:

  • Insert excerpt
    _menu_desktop
    _menu_desktop
    nopaneltrue

  • Insert excerpt
    _menu_mobile
    _menu_mobile
    nopaneltrue

PhixFlow displays the mobile or desktop icon next to the application's name. Using that context menu the user can also load the Application application with selected menu. All options available in the context menu are:

You can also use the context menu to:

  • Insert excerpt
    _add
    _add
    nopaneltrue
    : add  add another menu to the list

  • Insert excerpt
    _delete
    _delete
    nopaneltrue
    : delete  delete the menu from this application.

Access Permissions

Tip

You must have saved the action before you can change its permissions. 

FieldDescriptionAll Users Can View Application Insert excerpt_check_box_ticked_check_box_tickednopaneltrue all users can view this application. Insert excerpt_check_box_untick_check_box_unticknopaneltrue to specify the user groups that can access this application. When unticked, you must add at least one user group before you can save the properties.

User Groups

This 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

    For details about how to control access to an application, see Common Properties → Access Permissions.

    Packages

    This section has a toolbar with standard buttonsThe grid contains a list of packages that contain this application. To add an application to the list:

    1. Click
      Insert excerpt
      _add
      _add
      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

    Menu 
    Anchor
    app_menu
    app_menu

    When you run PhixFlow in 

    Insert excerpt
    _design_mode
    _design_mode
    nopaneltrue
     without loading an application, you will see the PhixFlow logo and text in the top left of the window. You can click this area to open the  
    Insert excerpt
    _app_menu
    _app_menu
    nopaneltrue
    . The menu lists the applications available in the current PhixFlow instance.

    When you run PhixFlow in either 

    Insert excerpt
    _app_mode
    _app_mode
    nopaneltrue
     or 
    Insert excerpt
    _design_mode
    _design_mode
    nopaneltrue
    , if your PhixFlow URL does not specify an application, the 
    Insert excerpt
    _app_menu
    _app_menu
    nopaneltrue
     opens automatically when you log into PhixFlow.  You can   

    To open the 

    Insert excerpt
    _app_menu
    _app_menu
    nopaneltrue
    at any time.:

    • Either either click on the PhixFlow logo and name  Image Removed, logo/name in the top left of the PhixFlow screen. By default this is the PhixFlow logo and name  Image Added.
    • Oror, if your application has been configured to have no menu bar, click the PhixFlow logo Image Removed in in the bottom right of the PhixFlow screen.
    If your application has an image specified in the
    • . By default this is the PhixFlow logo Image Added.

    Your administrator can configure the graphic that appears in the menu bar in the application properties → Basic Settings → Application Logo option, this will replace the  PhixFlow  Insert excerpt_app_menu_app_menunopaneltrue imagebelow.

    The 

    Insert excerpt
    _app_menu
    _app_menu
    nopaneltrue
     lists the available applications as cards, for example:
    Image RemovedNew image required??

    Image Added

    Tip

    The 

    Insert excerpt
    _app_menu
    _app_menu
    nopaneltrue
     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.

    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 Then click the 3-dot icon   icon.

    Repository Application Context Menu

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

    Image RemovedImage Added

    Context Menu Options

    Available in context menu accessed fromOptionDescription

    application card and
    repository application name


    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 nameFilter by NameIn the repository browser, use the application name to display only the repository tree for the selected application. The application is not loaded.
    repository application nameEdit
    In
    Insert excerpt
    _design_mode
    _design_mode
    nopaneltrue
    , open the properties for the selected application.
    repository application name
    Insert excerpt
    _delete
    _delete
    nopaneltrue
    Delete the selected application from the repository. This cannot be undone.