Versions Compared

Key

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

Cp card macro
database64/EQbwOsAuCeAOCmEBcEBCBBAcpgogJQgBoIAnAewHcBnZARmOAGMyAbAVwFsA7G4JeiBwCGADwDCQkgBNe_Bo0kzkAbXBQ4iPmiy4CwBgEthAc01I1RoaYCqJFsggALSJFhUkAeg-xHBkQDMWSgA6IUgWISoqAyEuYK54SA8KAwBrAw8pSi4goSkPMMghRkcOeC5IKg8ADloAdgAmAAYAFjaAViaPAAVfEQAxIIoAWnRYWDESeDCDMi5h1FiEkmCAK1hjAH4AN3gSaLmAXgBmADIOMikDfwMFSFmuABEw-EPaADZjj-OW9ob397VdqnBQleAANT2By4b1OQlgBkO2waEAAvoYpA5gPApIxaO0AJzwRjDeC0fy0YYtapSKTDAnVY7-YZSBr1drvFoAI3g70Y7yIEFgZGi9zmyCaDDYdixgqgBnCZggY1gLFuMzmAAJJtMxVw5VzLtAsTqZlxjJrYpbxmq7g9NSlII5Nb0_INKGiALqo4BAAA

This page is for application designers who want to create new application project.

Iframe
srchttps://www.youtube.com/embed/jNdlDz9IWmM
width700px
height400px

Are we calling it application properties or settings? Properties. In this case you are using a pop-up window to set specific properties, but it would be good to keep this consistent. Also, the devs have used lots of different terms in the GUI where clicking an option opens its properties (e.g. Show stream configuration or Show dashboard details). The options should be simplified and made consistent: "Properties" or "Open properties"

We need to add this to the terminology document and also let me know so I can update the flow. We call it settings later on. It was already in.

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

Overview

There are several things that happen when you create an application.

  1. PhixFlow creates all the folders in the repository that your project will need.
    This includes 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 on the right of the menu bar at the top of the PhixFlow window; see Menu.
  2. The template that you select is added to your application's Packages folder.
    The template includes the palettes that will give your application a consistent design.
  3. The template sets default properties for your application:
    • 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 - todo-fiona link
    • user groups and access permissions  - todo-fiona check this is happening

You can change all the properties later; see Application properties.

See also

Image Removed

Insert excerpt_card_or_list_card_or_listnopaneltrue

Creating a New Application

To create a new application:

either in the repository → Applications section, click  Insert excerpt_add_addnopaneltrueor, in
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
; see The Application Menu, below.
Click the last card, which is the New Application card:

Image Removed

    • .

Image Added

2. PhixFlow opens the Create Application

window

 wizard.

Image Added

3. Set the following properties for your application:

    • Name: enter a name.

    • Version (Optional): enter a

development
    • version number

, for example 1
    • if applicable.

Description: consider including the purpose
    • Description (Optional): we recommend entering a useful description of the application

and who is responsible for it
    • , potentially the data owner and app creators.

    • Template:

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

Application Icon: This is the image 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  Image Removed to find an image on your file system to load.
      • 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.

     PhixFlow prompts you to load the application. You can work on an application without loading it.

    todo-fiona: check with dev - you have to click load to get the app creation process to complete

    Menu

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

    Application Menu  Anchorapp-menuapp-menu

    Applications are listed as cards on the application menu.

    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.

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

    Each application card also has a pop-up menu; see Application for details.

    PhixFlow's Welcome Window
    PhixFlow's Welcome WindowImage Removed

    Changing Application Settings

    When you create your application project, you are setting up some defaults for the whole application.  We now also take them from a template package. To change or set additional options for your application:

    • either go the the application Home window and use the link in the top right of the window
      Image Removed
    • or open the repository and click on the application name.

    PhixFlow opens the Application properties.

    Your application may also be using defaults set in System ConfigurationFor example, you can optionally specify the formats for dates and times in your application using the settings:

    • Date
    • Date/Time
    • Number

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

    We need to outline the hierarchy of this logic i.e. system properties are overridden by templates etc.

    HTML Comment
    hiddentrue

    Features not yet implemented

    You create a new application project from the PhixFlow Welcome window.

    To open the  Insert excerpt_app_menu_app_menunopaneltrue at any time:either click on the logo/name in the top left of the PhixFlow screen. By default this is the PhixFlow logo and name  Insert excerpt_phixflow_logo_name_phixflow_logo_namenopaneltrue.or, if your application has been configured to have no menu bar, click the logo in the bottom right of the PhixFlow screen. By default this is the PhixFlow logo  Insert excerpt_phixflow_logo_only_phixflow_logo_onlynopaneltrue . 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.

    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)