Versions Compared

Version Old Version 87 New Version Current
Changes made by

Fiona Sargeant (Unlicensed)

Zoe Baldwin

Saved on

Key

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

This page is provides the reference information for dashboard properties.

Overview

Create application screens by starting with a dashboard; see Creating or Opening a Screen.

PhixFlow opens existing screens locked, to prevent accidental editing. To edit a screen,  Insert excerpt_layout_unlock_layout_unlocknopaneltrue it:
  • either using the toolbar 
  • or right-click anywhere in the screen to display the pop-up menu.

This page explains the dashboard properties. For information on how to divide a dashboard into different panes, and how to add components to it, see Drag-and-Drop Techniques.

See Also

Properties

Insert excerpt_property_toolbar_property_toolbarnopaneltrue The toolbar includes the button to  Insert excerpt_dashboard_display_dashboard_displaynopaneltrue. Insert excerpt_parent_parentnopaneltrue

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

Basic Settings

FieldDescriptionNameThe name of the dashboard.Open Maximised Insert excerpt_check_box_tick_check_box_ticknopaneltrue to open the dashboard maximised. Insert excerpt_check_box_untick_check_box_unticknopaneltrue to open the dashboard as a pop-up window.Allow User to Resize Insert excerpt_check_box_tick_check_box_ticknopaneltrue to enable the application user, when running in  Insert excerpt_app_mode_app_modenopaneltrue, to resize the dashboard. Insert excerpt_check_box_untick_check_box_unticknopaneltrue to keep the dashboard size fixed when running in in  Insert excerpt_app_mode_app_modenopaneltrue.This option does not affect resizing the dashboard in  Insert excerpt_design_mode_design_modenopaneltrue.Show Toolbar Insert excerpt_design_mode_design_modenopaneltrue always has a toolbar with the dashboard name on the left and toolbar icons on the right.  Insert excerpt_check_box_tick_check_box_ticknopaneltrue to also display the toolbar in  Insert excerpt_app_mode_app_modenopaneltrue. The dashboard name is displayed. Toolbar icons are not displayed. Insert excerpt_check_box_untick_check_box_unticknopaneltrue is the default as the toolbar is usually not required in  Insert excerpt_app_mode_app_modenopaneltrue.Show Window Button Bar Insert excerpt_check_box_tick_check_box_ticknopaneltrue to display a Windows-style bar at the top of the dashboard. This has a maximise/restore button and a close button.

Image Removed

Insert excerpt_check_box_untick_check_box_unticknopaneltrue to have no Windows-style bar at the top of the dashboard.Always On Top Insert excerpt_check_box_tick_check_box_ticknopaneltrue to keep the dashboard on top of other dashboards. This is useful for a pop-up window that you want a user to complete before returning to another dashboard. Insert excerpt_check_box_untick_check_box_unticknopaneltrue to allow other dashboards to be displayed in front. Keep Data Insert excerpt_check_box_tick_check_box_ticknopaneltrue to allow dashboard data to be referenced even after the dashboard is closed. This is useful if an application user needs access to global data available in the system. Insert excerpt_check_box_untick_check_box_unticknopaneltrue is the default. The dashboard data is not required once the dashboard is closed.Preload

Dashboards, especially complex dashboards, can take some time to open, which can feel slow to the application user. Use this option when you need a dashboard to open quickly. Preloading screens adds to the time it takes PhixFlow to initially start up.  For this reason we recommend you only preload dashboards that an application user will always want to open.

Insert excerpt_check_box_tick_check_box_ticknopaneltrue to preload the dashboard when PhixFlow first starts.  When the user then opens the dashboard, it displays immediately. The data itself may still take time to load. Insert excerpt_check_box_untick_check_box_unticknopaneltrue is the default. The dashboard does not need to be preloaded.

Preloading relates to the dashboard itself. Any data backing the dashboard is only loaded when the dashboard opens, and this may also take time to load.

Cache Locally

If an application user is likely to require the same dashboard in different stages of a task. Use this option so that, when the user closes and reopens the dashboard, it loads immediately. 

Insert excerpt_check_box_tick_check_box_ticknopaneltrue to cache the dashboard on the application user's client computer when the dashboard first opens. Insert excerpt_check_box_untick_check_box_unticknopaneltrue is the default. The dashboard does not need to be cached.

Caching relates to the dashboard itself. Any data backing the dashboard will be reload each time the dashboard is opened.

Position

By default, new dashboards are set to Floating. If you want a dashboard to open with a fixed position, select one of the Pinned drop-down options:

  • Pinned to top
  • Pinned to bottom
  • Pinned to left
  • Pinned to right

Use the Pinned options to create a permanently visible dashboard. This is useful for a navigation area or toolbar that you want to be visible for all other dashboards. Floating dashboards do not overlap with pinned dashboards. When the user maximises a Floating dashboard, it expands only to the remaining space. 

Width

For dashboards that are not set to Open maximised, specify a dashboard width in pixels, for example 500px for a small confirmation window. The default size for a pop-up dashboard approximately 800px.Height

For dashboards that are not set to Open maximised, specify a dashboard height in pixels, for example 150px for a small confirmation window. The default size of a pop-up dashboard is approximately 500px. 

Top

Available when Position is Floating.

For dashboards that are not set to Open maximised, set an offset value in pixels to position the dashboard where it is required. For example, to display a dashboard as a pop-up window towards the top left of the screen, set:

  • Top: 60px
  • Left: 60px
LeftRightBottom

Dashboard Elements

This section has a toolbar with standard buttons. The grid contains a list of the Dashboard Elements on this dashboard.

To add dashboard elements, on the dashboard, use the pop-up menu Add Area... options to divide up the dashboard. When you add a component to a part of the dashboard, PhixFlow automatically creates a container dashboard element for it. This means different parts of the dashboard can be bound to different data views.

Where dashboard elements are bound to data, you can link them, so that the data in one dashboard element drives the data in another; see Linked and Driving Views or Forms.

To delete a dashboard element, on the dashboard right-click components on part of the dashboard and select Delete. When the dashboard element is empty, right-click it and select  Insert excerpt_delete_item_delete_itemnopaneltrue Element. 

Menu Items

This section has a toolbar with standard buttons and:

  •  Image Removed Show stream-actions
    • Insert excerpt_filter_filternopaneltrueThe grid contains a list of menu items. To add a menu item to the list, click  Insert excerpt_add_addnopaneltrueclick  Insert excerpt_add_addnopaneltrue
  • Select 
    • either Add a new sub-menu
    • or Add a new menu item; see Menu
  • PhixFlow opens a new properties tab for a menu item or sub-menu; see Menu for details.
    • To remove a menu, use the toolbar button  Insert excerpt_delete_deletenopaneltrue.

    Mappings

    This section has a toolbar with standard buttons. 

    Components on the dashboard, such as buttons or data-components, can have actions or stream-item actions. Stream-item actions can take data from attributes in different streams or views. Where the attributes have different names, you must map the attribute, so that the stream-item action recognises the data. This grid contains a list of mappings for the components on this dashboard. 

    To configure a mapping, in the dashboard, right-click a component and select  Insert excerpt_mapping_mappingnopaneltrue.

    Unreachable Actions

    This section has a toolbar with standard buttons. The grid displays a list of actionflows that are linked to components on the dashboard, but do not exist yet.

    Tip

    Actionflows are a new way to configure actions, introduced in PhixFlow version 9.0.0; see Understanding Actionflows.

    Actions

    This section has a toolbar with standard buttons. The grid displays a list of actions and stream-item-actions that are linked to the dashboard.

    Tip

    Actions and stream-item-actions were the way to configure dashboard functionality before PhixFlow version 9.0.0; see Using Stream Actions and Stream Item Actions

    Insert excerpt_access_accessnopaneltrue Insert excerpt_description_descriptionnopaneltrue Insert excerpt_audit_auditnopaneltrue

    Menus and Toolbars

    Screen Toolbar

    There is a toolbar above the screen canvas. This provides the following options:

    List options Insert excerpt_tables_tablesnopaneltrue

    Open the repository showing the list of available streams for your application.

    Insert excerpt_screen_toolbar_screen_toolbarnopaneltrueOpen the repository showing the list of available dashboards for your application. Insert excerpt_actionflow_actionflownopaneltrueOpen the repository showing the list of available actionflows for your application. Insert excerpt_palette_palettenopaneltrueOpen the list of palettes. Insert excerpt_styles_stylesnopaneltrueOpen the repository showing the list of available styles for your application.Canvas options Insert excerpt_help_helpnopaneltrueOpen the help topic with details about working with dashboards. Insert excerpt_property_settings_property_settingsnopaneltrueOpen the properties tab for the dashboard. Insert excerpt_layout_unlock_layout_unlocknopaneltrueor  Insert excerpt_layout_lock_layout_locknopaneltrue

    Unlock a dashboard to edit its layout.

    Lock a dashboard to prevent accidental edits and to display the data content.

    Insert excerpt_refresh_refreshnopaneltrue

    Update the dashboard to reflect changes made elsewhere in PhixFlow, such as the dashboard properties, layer orders or shared styles.

    Screen Pop-up Menu

    Right-click on a screen to display its pop-up menu. The options available depend on where you click. If there are many options, some are moved onto the sub-menu Insert excerpt_screen_screennopaneltrue Options.Menu optionDescription Insert excerpt_layout_unlock_layout_unlocknopaneltrueUnlock a dashboard to edit its layout. Insert excerpt_layout_lock_layout_locknopaneltrueLock a  dashboard to prevent accidental edits and to display the data content. Insert excerpt_context_parameters_context_parametersnopaneltrueFor dashboards created in PhixFlow versions 8.3 and earlier, open a window listing the context parameters in alphabetical order. Insert excerpt_element_show_element_shownopaneltrueFor dashboards created in PhixFlow versions 8.3 and earlier, open the properties for the dashboard element. Insert excerpt_area_above_area_abovenopaneltrue

    Use these options to divide a dashboard into multiple, resizable panes. Select the option to add a pane relative to the currently selected pane.

    To remove a pane, use the pop-up menu options 

    Insert excerpt
    _Banners
    _Banners
    namescreen
    nopaneltrue

    This page is for application designers who want to create screens for application users.

    Overview

    This page explains the screen properties. For information on how to divide a screen into different panes, and how to add components to it, see Splitting a Screen.

    Insert excerpt
    _property_toolbar
    _property_toolbar
    nopaneltrue

    Insert excerpt
    _property_tabs
    _property_tabs
    namebasic-h
    nopaneltrue

    Insert excerpt
    _parent
    _parent
    nopaneltrue

    Basic Settings

    FieldDescription
    NameThe name of the screen.
    DescriptionWe recommend that you always enter a description to explain the purpose of this item.
    Open Maximised

    Insert excerpt
    _check_box_tick
    _check_box_tick
    nopaneltrue
     to open the screen maximised.

    Insert excerpt
    _check_box_untick
    _check_box_untick
    nopaneltrue
     to open the screen as a popup window.

    Allow Manual Resizing

    Insert excerpt
    _check_box_tick
    _check_box_tick
    nopaneltrue
     to enable the application user, when running in 
    Insert excerpt
    _app_mode
    _app_mode
    nopaneltrue
    , to resize the screen.

    Insert excerpt
    _check_box_untick
    _check_box_untick
    nopaneltrue
     to keep the screen size fixed when running in in 
    Insert excerpt
    _app_mode
    _app_mode
    nopaneltrue
    .

    This option does not affect resizing the screen in 

    Insert excerpt
    _design_mode
    _design_mode
    nopaneltrue
    .

    Always On Top

    Insert excerpt
    _check_box_tick
    _check_box_tick
    nopaneltrue
     to keep the screen on top of other screens. This is useful for a popup window that you want a user to complete before returning to another screen.

    Insert excerpt
    _check_box_untick
    _check_box_untick
    nopaneltrue
     to allow other screens to be displayed in front. 

    Preload

    Some screens, especially complex screens, can take some time to open, which can feel slow to the application user. Use this option when you need a screen to open quickly. Preloading screens adds to the time it takes PhixFlow to initially start up.  For this reason we recommend you only preload screens that an application user will always want to open.

    Insert excerpt
    _check_box_tick
    _check_box_tick
    nopaneltrue
     to preload the screen when PhixFlow first starts.  When the user then opens the screen , it displays immediately. The data itself may still take time to load.

    Insert excerpt
    _check_box_untick
    _check_box_untick
    nopaneltrue
     is the default. The screen does not need to be preloaded.

    Preloading relates to the screen itself. Any data backing the screen is only loaded when the screen opens, and this may also take time to load.

    Screen Elements

    Screen elements are specific sections on a screen that posses their own properties, specifically each element can be backed by a different table.

    To view a list of the elements for a specific screen, open the 

    Insert excerpt
    _property_settings
    _property_settings
    nopaneltrue
    available from the screen toolbar; see Screen Element.  

    Advanced

    FieldDescription
    Show Toolbar
    Insert excerpt
    _design_mode
    _design_mode
    nopaneltrue
     always has a toolbar with the screen name on the left and toolbar icons on the right. 

    Insert excerpt
    _check_box_tick
    _check_box_tick
    nopaneltrue
     to also display the toolbar in 
    Insert excerpt
    _app_mode
    _app_mode
    nopaneltrue
    . The screen name is displayed. Toolbar icons are not displayed.

    Insert excerpt
    _check_box_untick
    _check_box_untick
    nopaneltrue
     is the default as the toolbar is usually not required in 
    Insert excerpt
    _app_mode
    _app_mode
    nopaneltrue
    .

    Show Window Button Bar

    Insert excerpt
    _check_box_tick
    _check_box_tick
    nopaneltrue
     to display a Windows-style bar at the top of the screen. This has a maximise/restore button and a close button.

    Image Added

    Insert excerpt
    _check_box_untick
    _check_box_untick
    nopaneltrue
     to have no Windows-style bar at the top of the screen.

    Keep Data

    Insert excerpt
    _check_box_tick
    _check_box_tick
    nopaneltrue
     to allow screen data to be referenced even after the screen is closed. This is useful if an application user needs access to global data available in the system.

    Insert excerpt
    _check_box_untick
    _check_box_untick
    nopaneltrue
     is the default. The screen data is not required once the screen is closed.

    Cache Locally

    If an application user is likely to require the same screen in different stages of a task. Use this option so that, when the user closes and reopens the screen, it loads immediately. 

    Insert excerpt
    _check_box_tick
    _check_box_tick
    nopaneltrue
     to cache the screen on the application user's client computer when the screen first opens.

    Insert excerpt
    _check_box_untick
    _check_box_untick
    nopaneltrue
     is the default. The screen does not need to be cached.

    Caching relates to the screen itself. Any data backing the screen will be reload each time the screen is opened.

    Insert excerpt
    _property_tabs
    _property_tabs
    namestyle-h
    nopaneltrue

    Style Settings

    FieldDescription
    Position

    By default, new screens are set to Floating. If you want a screen to open with a fixed position, select one of the Pinned drop-down options:

    • Pinned to top
    • Pinned to bottom
    • Pinned to left
    • Pinned to right
    • Floating

    Use the Pinned options to create a permanently visible screen. This is useful for a navigation area or toolbar that you want to be visible for all other screens. Floating screens do not overlap with pinned screens. When the user maximises a Floating screen, it expands only to the remaining space. 

    Width

    For screens that are not set to Open maximised, specify a screen width in pixels, for example 500px for a small confirmation window. The default size for a popup screen approximately 800px.

    If this is left blank, the screen will adjust its width to the content automatically. 

    Height

    For screens that are not set to Open maximised, specify a screen height in pixels, for example 150px for a small confirmation window. The default size of a popup screen is approximately 500px. 

    If this is left blank, the screen will adjust its height to the content automatically. 

    Top

    Available when Position is Floating.

    For screens that are not set to Open maximised, set an offset value in pixels to position the screen where it is required. For example, to display a screen as a popup window towards the top left of the screen, set:

    • Top: 60px
    • Left: 60px


    Left
    Right
    Bottom

    Insert excerpt
    _property_tabs
    _property_tabs
    nameaction-h
    nopaneltrue

    Unconnected Actions

    This section has a toolbar with standard buttons, see Common Properties. The grid displays a list of Actionflows that are linked to components on the screen that are not connected to a component. These can occur when Actionflows are created in a 

    Insert excerpt
    _workflow
    _workflow
    nopaneltrue
    .

    Actions

    This section has a toolbar with standard buttons, see Common Properties. The grid displays a list of Actionflows or Table-Actions (Legacy) that are linked to the screen.

    Menu Items

    This section has a toolbar with standard buttons, see Common Properties and:

    •  Image Added Show Table-actions
    • Insert excerpt
      _filter
      _filter
      nopaneltrue

    The grid contains a list of menu items. To add a menu item to the list, click 

    Insert excerpt
    _add
    _add
    nopaneltrue

    1. Click 
      Insert excerpt
      _add
      _add
      nopaneltrue
    2. Select 
    3. PhixFlow opens a new properties tab for a menu item or sub-menu; see Startup Actions Properties for details.

    To remove a menu, use the toolbar button 

    Insert excerpt
    _delete
    _delete
    nopaneltrue

     Pane_area_right_area_rightnopaneltrue

    .

    Insert excerpt

    Menus and Toolbars

    Screen Toolbar

    There is a toolbar above the screen canvas. This provides the following options:

    List options
    Insert excerpt
    _
    area_below
    attributes
    _
    area_below
    attributes
    nopanel
    true
    true
    		Opens the Available Attributes Window.

    Insert excerpt
    _

    area_left

    tables
    _

    area_left

    tables
    nopaneltrue

    Opens the repository showing the list of available tables for your application.

    Insert excerpt
    _
    area
    screen_
    lock_width
    toolbar
    _
    area
    screen_
    lock_width
    toolbar
    nopaneltrue
    Fix the height or width of the selected pane. You will no longer be able to resize a pane by dragging its dividing line
    Opens the repository showing the list of available screens for your application.
    Insert excerpt
    _
    area_lock_height
    actionflow
    _
    area_lock_height
    actionflow
    nopaneltrue
    		Opens the repository showing the list of available Actionflows for your application.
    Insert excerpt
    _
    delete
    palette
    _
    delete
    palette
    nopanel
    true

    When a specific component is selected, delete the component.

    Other delete options that may be available relate to specific types of component in the selected pane
    true
    		Open the list of palettes.
    Insert excerpt
    _
    delete_item
    template
    _
    delete_item
    template
    nopaneltrue
     Delete options depend on the selected item. Examples are:
    Opens the repository showing the list of available templates for your application.
    Insert excerpt
    _
    delete
    styles_
    item_delete_itemnopaneltrue selected objects
    ccs
    _styles_ccs
    nopaneltrue
    		Open the repository showing the list of available styles for your application.
    Canvas options
    Insert excerpt
    _
    delete
    property_
    item
    settings
    _
    delete
    property_
    item
    settings
    nopaneltrue
     pane
    Open the properties tab for the screen.

    Insert excerpt
    _

    delete_item

    unlock
    _

    delete_item

    unlock
    nopaneltrue

     form 

    or 

    Insert excerpt
    _

    element_delete

    lock
    _

    element_delete

    lock
    nopaneltrue

    Delete a dashboard element

    Unlock a screen to edit its layout.

    Lock a screen to prevent accidental edits and to display the data content.

    Insert excerpt
    _

    form_new

    refresh
    _

    form_new

    refresh
    nopaneltrue

    Create a new form in the current area. Insert excerpt_pin_unpin_pin_unpinnopaneltruePin a component to fix its position; see Pinning and Unpinning.

    Update the screen to reflect changes made elsewhere in PhixFlow, such as the screen properties, layer orders or shared styles.

    Screen Popup Menu

    Right-click on a screen to display its popup menu. The options available depend on where you click. If there are many options, some are moved onto the sub-menu 

    Insert excerpt
    _

    palette

    screen
    _

    palette

    screen
    nopaneltrue

    Open the palette to drag in components.

     Options.

    Menu optionDescription
    Insert excerpt
    _
    autosize
    unlock
    _
    autosize NoteUsing this option, or manually resizing a component may change the state of the Layout → Style Settings → Auto Size property
    unlock
    nopaneltrue

    Toggle whether or not the currently selected component is automatically auto sized when an application window is resized by the user.

    Unlock a screen to edit its layout.
    Insert excerpt
    _
    arrange_components
    lock
    _
    arrange_components
    lock
    nopaneltrue
    Options to arrange the selected components within a pane:
    Lock a screen to prevent accidental edits and to display the data content.
    Insert excerpt
    _
    align
    context_
    left
    parameters
    _
    align
    context_
    left_align_right_align_rightnopaneltrue
    parameters
    nopaneltrue
    Insert excerpt
    Open a window listing the context parameters in alphabetical order, if applicable.
    Insert excerpt
    _
    align
    element_
    top
    show
    _
    align
    element_
    top
    show
    nopaneltrue
    		Open the properties for the screen element.
    Insert excerpt
    _
    align_bottom
    delete
    _
    align_bottom_distribute_horizontalnopaneltrue
    delete
    nopaneltrue
    Insert excerpt_distribute_horizontal

    When a specific component is selected, delete the component.

    Delete options depend on the selected item, for example:

    • Delete Selected Objects
    • Delete Pane
    • Delete Form 

    Insert excerpt
    _

    distribute_vertical

    palette
    _

    distribute_vertical

    palette
    nopaneltrue

    		Open the palette to drag in components.

    Insert excerpt
    _repository_find
    _repository_find
    nopaneltrue

    		Open the repository with to see the selected component in the list. This can be useful if you want to move a component.
    Insert excerpt
    _screen_properties
    _screen_properties
    nopaneltrue
    		Open the properties tab for
    the dashboard
    the screen.
    Insert excerpt
    _record_show
    _record_show
    nopaneltrue

    Display information about the table and its records.

    Insert excerpt

    _record

    _show_table_configuration
    _show

    _

    record

    table_

    show

    configuration
    nopaneltrue

    Display information about the stream and its stream-items
    Open the properties for the table.

    Insert excerpt
    _

    terms

    attributes_

    changing

    add
    _

    terms

    attributes_

    changing

    add
    nopaneltrue
     to ...

    		Opens the Available Attributes Window.

    Insert excerpt
    _

    mapping

    access
    _

    mapping

    access
    nopanel

    trueOpens a new mapping element properties tab where you can map attributes with different names to components.

    true

    Insert excerpt
    _

    children_childrennopaneltrueFor the selected parent container, select all the child components

    audit
    _audit
    nopaneltrue

    HTML Comment
    hiddentrue

    Unreachable Actions

    A workflow can have placeholder actionflows linked to a screen. If the actionflow has not been wired then it is listed here.

    Open on Startup

    You may have a screen that acts as your application's welcome window. Use this option to open a screen whenever the application starts.

    Insert excerpt
    _check_

    table

    box_

    properties

    tick
    _check_

    table

    box_

    properties

    tick
    nopaneltrue

    or Show the Stream ConfigurationOpen the properties for the stream

     to open the screen when the application starts.

    Insert excerpt
    _

    attributes

    check_box_

    show

    untick
    _check_

    attributes

    box_

    show

    untick
    nopaneltrue

    ...

    Show the list of attributes that are bound to the component. The attributes can be from a stream or view. This is shown in the option:

    Insert excerpt_attributes_show_attributes_shownopaneltrue for stream <name> Insert excerpt_attributes_show_attributes_shownopaneltrue for view <name> HTML Comment

    Unreachable Actions

    A workflow can have placeholder actionflows linked to a dashboard. If the actionflow has not been wired then it is listed here.

    Open on Startup

    You may have a screen that acts as your application's welcome window. Use this option to open a screen whenever the application starts.

    Insert excerpt_check_box_tick_check_box_ticknopaneltrue to open the screen when the application starts. Insert excerpt_check_box_untick_check_box_unticknopaneltrue is the default. The screen is opened by a user action within the application. 

     is the default. The screen is opened by a user interacting with the application. 


    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

    For links to all pages in this topic, see Screens.