Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Insert excerpt
_Banners
_Banners
nameapp
nopaneltrue

Image Removed

Overview

The starting point for any application is creating everything you need for your project within PhixFlow. The Create Application window prompts you for the essential information PhixFlow needs to:

  • set up all the folders in the repository that your project will need.
  • create a default menu.
    You can find the menu in the repository → Menus branch → application_name_Menu.
    When you add the first option to the menu, it is automatically displayed in the menu bar; see Startup Actions → Static Menu Creation.
  • add a template to your application's Packages folder.
    The template includes the palettes that will give your application a consistent design; see 
    Understanding Template Packages and Package.
  • set default properties based on the template. Default properties include:
    • formats for dates and numbers
    • the palette and components to use for forms, data fields and cards
    • the styles for data grids
    • the default action which should run when your application is opened. For example, an actionflow to open a navigation window and landing page.

Creating a New Application

To create a new application:

Applications contain everything necessary for it to function, from its data and access permissions to links to external content. Each application has a unique URL and associated styling.

Open an Application

To open an existing application

  1. Double-click on the applications name from the application list the opens with PhixFlow.
    1. If the application list is not displayed, in the top left of the PhixFlow click Image Added.

Image Added

Access an application using its URL

Every application has a URL which allows you to access it directly. 

  1. To obtain the URL for the application, the most reliable method is to open the application and copy the value from the address bar:
    1. For example: https://bigcorp.com/phixflow/?application=Data%20Analysis
Expand
titleMore Detail

The URL is made up of: Server Address + Application Name + Menu Name

For example, 

Server addresshttps://bigcorp.com/phixflow/start?

Application NameData Analysis. Spaces must be replaced by %20 in a URL.

Menu Name: navigation

Result:

https://bigcorp.com/phixflow/?application=Data%20Analysis&menu=navigation

Creating a New Application

  1. Click
    Insert excerpt
    _addIcon
    _addIcon
    nopaneltrue
     Add New from the PhixFlow Landing Screen.
    • If this is not open, click the 
      Insert excerpt
      _app_menu
      _app_menu
      nopaneltrue
       - see Application Menu below.

2. PhixFlow opens the Create Application window wizard.

3. Set the following properties for your application:

    • Name: enter a name.

    • Version (Optional): enter a development version number , for example 1if applicable.

    • DescriptionDescription (Optional): we recommend that you enter the purpose of this application and who is responsible for it.

    • Template: select a template to provide a design theme and to set key properties.

    • Application Icon: select an image that PhixFlow displays in the card on the application menu. If you do not select an icon, PhixFlow uses a default image.

    • Either use the drop-down to select an icon that has already been loaded into PhixFlow

    • Or click  Insert excerpt_addIcon_addIconnopaneltrue to find an image saved on your computer to load it into PhixFlow.
      Tip

      Icons for the application menu should be:

      • up to 100 pixels high
      • between 100 to 150 pixels wide

4. Click Create Application and PhixFlow loads the new application.

Default Properties

PhixFlow sets default style or number/date formats for your application based on your template. You can see or change these in the Application Properties
    • entering a useful description of the application, potentially the data owner and app creators.

    • Template: Template Packages defines the styling, default settings and templates used to create your application. We recommend selecting a PhixFlow template, such as Serene Grey, as this comes complete with everything you need to start creating your application. These can be customised.


    • Tip

      Icons for the application menu should be:

      • up to 100 pixels high
      • between 100 to 150 pixels wide

        Application Icon (Optional): select an image to be used as the icon for your application on the selection screen.



4. Click Create Application.

Templates Packages

Template Packages, are a special type of package which can provide all the items a package can, it also  defines the styling, default settings and templates used to create the content of your application. Template packages are selected when an application is created. See Understanding Template Packages.

Insert excerpt
_package
_package
nopaneltrue

In PhixFlow you can  share the same resources, such as data connectors and styles, with multiple applications by adding them to a package and then adding the package to different applications. A package can contain anything an application can contain.

Packages are associated to an application by:

  1. Open the Application's
    Insert excerpt
    _property_settings
    _property_settings
    nopaneltrue
    1. Click the Home button from the header menu and then click the properties button.
  2. Scroll down to the 
    Insert excerpt
    _package
    _package
    nopaneltrue
     section in the properties.
  3. Click the 
    Insert excerpt
    _package
    _package
    nopaneltrue
     button to open the available packages list.
    1. Tip: If the available packages list opens over the top of the application properties drag the tab header to the left to have the tab move next to it.
  4. Drag the required package into the packages area and  
    Insert excerpt
    _save
    _save
    nopaneltrue
     your changes.

Application Properties

To access the applications properties, click the properties button on the applications home page. 

Image Added

The defaults used by your application based on template package selected when you created it. You can see the default settings or set them in the Application PropertiesThese include:

  1. Default Components, such as the Form Fields template to use when creating input forms.
    1. Set in 
      Insert excerpt
      _styles
      _styles
      nopaneltrue
       tab.
  2. Grid Styling, such as the header, font and row sizes applied to grids by default.
    1. Set it 
      Insert excerpt
      _styles
      _styles
      nopaneltrue
       tab.
  3. Formats for Numbers and dates, such as the number of decimal places by and 31 Dec 2020
    1. set in 
      Insert excerpt
      _property_tabs
      _property_tabs
      nopaneltrue
      .
  4. Application Icon, this is the icon used in the application list.
    1. set in 
      Insert excerpt
      _property_tabs
      _property_tabs
      nopaneltrue
      .

If a default style or number/date format is not set in the application properties, PhixFlow uses defaults set in System Configuration.

Image Removed

Application Menu  Anchorapp-menuapp-menu

Applications are listed as cards.

Image Removed

TipThe 

. If the latter is also not set PhixFlow will prompt you to set them.

For more detail on this topic see Editing Application Properties

Server Properties

The instance of PhixFlow can be labelled and a colour set. This is useful when you have multiple environments such as Development, UAT and Production.

  • Server Properties
    • From the header menu, click 
      Insert excerpt
      _administration
      _administration
      nopaneltrue
       → System → Configuration.
    • On the 
      Insert excerpt
      _
app
    • property_
menu
    • tabs
      _
app
    • property_
menu
    • tabs
      nopaneltrue
      .
 displays
  • Set the
applications:
  • that have been configured to appear on this menu. This is the default setting.
  • and that you have permission to use.

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

 To redisplay the application menu, in the top left of the PhixFlow window click:

  • either the Image Removed Application menu
  • or the Image Removed, if it is presentLabel
    • Set a value in PhixFlow Instance. This will appear in the banner at the top of PhixFlow. For Example, Testing.
  • Banner Colour
    • Choose a colour by clicking the coloured box next to this field. You can pick a colour picker and this set the banner colour.

Security

There are two elements of security:

  • Controlling who can access an application.
  • Controlling their Privileges within an application.

To find out more on this topic see, 20. Security and Access.

What's Next?

PhixFlow Fundamentals, this course provides a practical guide to using PhixFlow including setting up the application properties.

Learn More

Child pages (Children Display)

HTML Comment
hiddentrue
Iframesrchttps://www.youtube.com/embed/P0EeO3bknzk?&rel=0&ytp-pause-overlay=0&list=PLbPt6SI1Zhb8qj71LnwezubFuF7yXWp60width650pxheight400px