Versions Compared

Key

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

This page is for application designers who want to start a new application project. It explains how to create an application.

Overview

You create a new application project from the PhixFlow Welcome window. From the Welcome window, you can also:

  • switch between card and list views using the buttons on the right: ??link
  • select an existing application from the list: ??link
  • import an application using the button on the left: ??link
Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone

PhixFlow's Welcome Window
PhixFlow's Welcome WindowImage Removed

How to Create a New Application

When you create an application project, PhixFlow guides you through the process in 3 steps.

Image Removed

Step 1  Name your application

On the left of the Welcome window, click Create New ??icon. PhixFlow prompts you to enter the following information for the application.

  • Name 
  • a development Version number, for example 1.
  • a Description. Consider including the purpose of the application and who is responsible for it.

Click Next.

Image Removed

Step 2  Choose an icon

PhixFlow needs an icon to display in the application list. To keep the default application icon, click Next. You can change the icon later; see ??link Customising your Applications Icon and Logo.

To change your application icon:

  • either expand the Image list to select an icon that has already been uploaded to PhixFlow
  • or click Add Image to upload a new icon.
    In the file window, find and select the image file you want to use as an icon.
    PhixFlow uploads the file and sets it to be your application icon.

PhixFlow shows the file name in the Image Name field check user doesn't do anything?? and displays the icon in Icon Preview.

Click Next

Image Removed

Step 3  Select a theme

PhixFlow comes with several design themes. The theme sets defaults for various things in your application ??list some things. You can adapt and change your theme at any time ??link to palette and component templates?? 

Use the arrows to scroll through the different themes until you find the one you like. 

When the theme you like is displayed, click Create.

PhixFlow creates the application project files and opens the Application Home widow.

The Application Home Window

Image Removed

From the application Home window you can access:

  • Data: planning data tables and their relationships using entity-relationship diagrams (ERDs)
  • Design: Design the appearence of your application's screens using components from your theme palettes
  • Flows: There are 2 aspects to flows
    • use workflows to model your application's business process or user task. This shows the different screens in your application and the actionflows that can be triggered by a user.
    • use actionflows wire up multiple individual actions and to plug them into components on your screen, such as menu options, buttons, or mouse-clicks.

Additional configuration for your application. Opens application properties on the right- see the properties. Set all the core stuff that applies to the whole application. Your chosen theme has defaults for these things. you can change them at any time.

Customising your Applications Icon and Logo

You can have 2 images for an application:

  • the icon that appears in the application list
  • a logo that can replace the PhixFlow logo in the header bar. 
    Image Removed

You can change your application logo it at any time by:

  1. Upload an image to use as a logo; see Image
    PhixFlow uploads application icons and logos to its database in images/icons ??dev to confirm
  2. Select the image in your application's properties (see Application):
  • Application Iconrecommended size:
    • height: up to 100 pixels
    • width: 100 to 150 pixels.
  • Application Logo recommended size:
    • height: up to 100 pixels
    • width: 100 to 150 pixels.

??sizes are same as in properties. Make this shared text.

More on Themes

In PhixFlow, you can bundle items together into a package. This makes it easy to share items across different applications.

A theme is a package. It has all the different palettes, components and styles that your application may need. When you select a theme for your application, PhixFlow adds the Theme package to it. You can see the theme package contents in the repository Packages folder. 

Where Defaults Are Set

When you create your application project, you are setting up some defaults for the whole application. Others are set in your:

For example, you can optionally specify the formats for dates and times in your application using the settings:

  • Default Date Format
  • Default Date/Time Format

If you do not specify formats, PhixFlow uses the formats specified in the system configuration.

Notes to me

Stuff to go to the  GUI page from XD 1.7 onwards

  • Bottom right, notification of running actions image action-notification.png
  • Also 1.4 Header bar customisation -system config New level called Environment Header logo and icon PhixFlow, compact and Custom
  • And login window screenshot for desktop and mobile
    Insert excerpt
    _Banners
    _Banners
    nameapp
    nopaneltrue

    Overview

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

    Image Added

    Open an Application

    To open an existing application

    1. Double-click on the application's name from the application list that opens with PhixFlow.
      1. If the application list is not displayed, in the top left of the PhixFlow, click 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
        .

    Image Added

    2. PhixFlow opens the Create Application wizard.

    Image Added

    3. Set the following properties for your application:

      • Name: enter a name.

      • Version (Optional): enter a version number if applicable.

      • Description (Optional): we recommend entering a useful description of the application, potentially the data owner and app creators.

      • Template: Template Packages define 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. 

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

        Tip

        Icons for the application menu should be:

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


    4. Click Create Application.

    Templates Packages

    Template Packages contain predefined options to specify a palette and other default properties; these include styling, default settings and templates used to create the content of your application. A Template package is selected when an application is created. See Understanding Template Packages.

    Insert excerpt
    _packages
    _packages
    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 in an application.

    To associate a package to an application:

    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
      _packages
      _packages
      nopaneltrue
       section in the properties.
    3. Click the 
      Insert excerpt
      _packages
      _packages
      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 so that both open tabs can be seen next to each other.
    4. Drag the required package into the packages area for your application and  
      Insert excerpt
      _save
      _save
      nopaneltrue
       your changes.

    Application Properties

    To access the application properties, click the

    Insert excerpt
    _property_settings
    _property_settings
    nopaneltrue
     button on the application home page. 

    Image Added

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

    1. Grid Styling for headers, fonts and row sizes applied to grids by default.
      1. Set in the 
        Insert excerpt
        _property_tabs
        _property_tabs
        namestyle
        nopaneltrue
        .
    2. Default Components, such as the Form Fields template used when creating input forms.
      1. Set in the 
        Insert excerpt
        _property_tabs
        _property_tabs
        namestyle
        nopaneltrue
        .
    3. Formats for numbers and dates, including the number of decimal places.
      1. Set in the 
        Insert excerpt
        _property_tabs
        _property_tabs
        nopaneltrue
        .
    4. The Application Icon used in the application list to identify your application.
      1. Set in the 
        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. If the latter is not set, PhixFlow will prompt you to set them.

    For more detail on this topic see Editing Application Properties.

    Startup Actions

    Startup actions are Actionflows which run when your application initially opens. They can be used to open the default navigation menu and a specific screen, such as a landing page. See Designing Screens and Startup Actions.

    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.
      • Click on the 
        Insert excerpt
        _property_tabs
        _property_tabs
        nopaneltrue
        .
    • Set the Label
      • 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 specific using the colour picker and set this as 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, 21. Security and Access.

    What's Next?

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

    Already started PhixFlow Fundamentals?

    Return to Application Fundamentals

    Further Reading

    Child pages (Children Display)