Versions Compared

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 has the reference documentation for dashboard properties. For information on how to divide a screen into different panes, and how to add things to a screen, 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 screen.Open Maximised Insert excerpt_check_box_tick_check_box_ticknopaneltrue to open the screen maximised. Insert excerpt_check_box_untick_check_box_unticknopaneltrue to open the screen 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 screen. Insert excerpt_check_box_untick_check_box_unticknopaneltrue to keep the screen size fixed when running in in  Insert excerpt_app_mode_app_modenopaneltrue.This option does not affect resizing the screen in  Insert excerpt_design_mode_design_modenopaneltrue.Show Toolbar  Insert excerpt_check_box_tick_check_box_ticknopaneltrue to display a toolbar for the screen todo - currently not working?? Insert excerpt_check_box_untick_check_box_unticknopaneltrue Always On Top Insert excerpt_check_box_tick_check_box_ticknopaneltrue to keep the screen on top of other screens. This is useful for a pop-up window that you want a user to complete before returning to another screen. Insert excerpt_check_box_untick_check_box_unticknopaneltrue to allow other screens to be displayed in front. Keep Data Insert excerpt_check_box_tick_check_box_ticknopaneltrue 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
_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_

untick

tick
_check_box_

untick

tick
nopaneltrue

 is the default. The screen data is not required once the screen is closed.Preload

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.

excerpt-include
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. 

 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 

_check_box_tick

Insert excerpt
_app_mode
_app_mode
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

, to resize the screen.

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.

Cache Locally

 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

cache

keep the screen on

the application user's client computer when the screen first opens

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

 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.

Open on Startup

Todo - not yet implemented

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

 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

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

For screens that are not set to Open maximised.

By default, pop-up screens are opened floating centrally. If you want a screen to open with a fixed position, select one of the drop-down options:

  • Pinned to top
  • Pinned to bottom
  • Pinned to left
  • Pinned to right
  • Floating (default)

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 pop-up screen approximately 800px.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 pop-up screen is approximately 500px. 

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 pop-up window towards the top left of the screen set:

  • Top: 60px
  • Left: 60px
LeftRightBottom

Dashboard Elements

This section lists the Dashboard Elements on this screen.

PhixFlow creates dashboard elements when you use the pop-up menu Add Area... options to divide up the screen. In PhixFlow version 8.3 and earlier, dashboard elements enabled different parts of the screen to be bound to different sources of data, either a stream (table) or view.

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 /wiki/spaces/HELP12/pages/9909895169.

Menu Items

This section has a toolbar with standard buttons and:

  •  Image Removed Show stream actions (record-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 Image Removed Delete Everywhere.

    Mappings

    This section has a toolbar with standard buttons

    Components on the screen, such as buttons or data-components, can have actions. You may want an action to take data from attributes in different streams (tables) or views. Where the attributes have different names, you must map the dataset, so that the action recognises the data. This grid contains a list of mappings for components on this screen. PhixFlow evaluates all the mapped datasets when it runs an action.

    You can delete a mapping from the grid.

    To configure a mapping, in the screen, right-click 

    Unreachable Actions

    Todo - New feature related to actionflows?

    Actions

    This section has a toolbar with standard buttons. The grid displays a list of actions and/or (todo - check) stream item actions (record-actions) that are linked to the screen.

    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 tables for your application.

    Insert excerpt_screen_toolbar_screen_toolbarnopaneltrueOpen the repository showing the list of available screens 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 screens. Insert excerpt_property_settings_property_settingsnopaneltrueOpen the properties tab for the screen. Insert excerpt_layout_unlock_layout_unlocknopaneltrueor  Insert excerpt_layout_lock_layout_locknopaneltrue

    Unlock a screen to edit its layout.

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

    Insert excerpt_refresh_refreshnopaneltrue

    Update the screen to reflect changes made elsewhere in PhixFlow, such as the screen 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 screen to edit its layout. Insert excerpt_layout_lock_layout_locknopaneltrueLock a screen 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 screen 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_delete_deletenopaneltrue Pane. Insert excerpt_area_right_area_rightnopaneltrue Insert excerpt_area_below_area_belownopaneltrue Insert excerpt_area_left_area_leftnopaneltrue Insert excerpt_area_lock_width_area_lock_widthnopaneltrueFix the height or width of the selected pane. You will no longer be able to resize a pane by dragging its dividing line. Insert excerpt_area_lock_height_area_lock_heightnopaneltrue Insert excerpt_delete_deletenopaneltrue

    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.

    Insert excerpt_delete_item_delete_itemnopaneltrue 

    Delete options depend on the selected item. Examples are:

    Insert excerpt_delete_item_delete_itemnopaneltrue selected objects Insert excerpt_delete_item_delete_itemnopaneltrue pane Insert excerpt_delete_item_delete_itemnopaneltrue form  Insert excerpt_element_delete_element_deletenopaneltrueDelete a dashboard element. Insert excerpt_form_new_form_newnopaneltrueCreate a new form in the current area. Insert excerpt_pin_unpin_pin_unpinnopaneltrue

    Pin a component to fix its position; see Pinning and Unpinning.

    Insert excerpt_palette_palettenopaneltrueOpen the palette to drag in components. Insert excerpt_autosize_autosizenopaneltrue

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

    Note

    Using this option, or manually resizing a component may change the state of the Layout → Style Settings → Auto Size property.

    Insert excerpt_arrange_components_arrange_componentsnopaneltrue

    Options to arrange the selected components within a pane:

    Insert excerpt_align_left_align_leftnopaneltrue Insert excerpt_align_right_align_rightnopaneltrue Insert excerpt_align_top_align_topnopaneltrue Insert excerpt_align_bottom_align_bottomnopaneltrue Insert excerpt_distribute_horizontal_distribute_horizontalnopaneltrue Insert excerpt_distribute_vertical_distribute_vertical

    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
    .

    Menus and Toolbars

    Screen Toolbar

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

    List options
    Insert excerpt
    _attributes
    _attributes
    nopaneltrue
    Opens the Available Attributes Window.

    Insert excerpt
    _tables
    _tables
    nopaneltrue

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

    Insert excerpt
    _screen_toolbar
    _screen_toolbar
    nopaneltrue
    Opens the repository showing the list of available screens for your application.
    Insert excerpt
    _actionflow
    _actionflow
    nopaneltrue
    Opens the repository showing the list of available Actionflows for your application.
    Insert excerpt
    _palette
    _palette
    nopaneltrue
    Open the list of palettes.
    Insert excerpt
    _template
    _template
    nopaneltrue
    Opens the repository showing the list of available templates for your application.
    Insert excerpt
    _styles_ccs
    _styles_ccs
    nopaneltrue
    Open the repository showing the list of available styles for your application.
    Canvas options
    Insert excerpt
    _property_settings
    _property_settings
    nopaneltrue
    Open the properties tab for the screen.

    Insert excerpt
    _unlock
    _unlock
    nopaneltrue

    or 

    Insert excerpt
    _lock
    _lock
    nopaneltrue

    Unlock a screen to edit its layout.

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

    Insert excerpt
    _refresh
    _refresh
    nopaneltrue

    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
    _screen
    _screen
    nopaneltrue
     Options.

    Menu optionDescription
    Insert excerpt
    _unlock
    _unlock
    nopaneltrue
    Unlock a screen to edit its layout.
    Insert excerpt
    _lock
    _lock
    nopaneltrue
    Lock a screen to prevent accidental edits and to display the data content.
    Insert excerpt
    _context_parameters
    _context_parameters
    nopaneltrue
    Open a window listing the context parameters in alphabetical order, if applicable.
    Insert excerpt
    _element_show
    _element_show
    nopaneltrue
    Open the properties for the screen element.
    Insert excerpt
    _delete
    _delete
    nopaneltrue

    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
    _palette
    _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 screen.
    Insert excerpt
    _record_show
    _record_show
    nopaneltrue

    Display information about the table and its records.

    Insert excerpt
    _show_table_configuration
    _show_table_configuration
    nopaneltrue

    Open the properties for the table.

    Insert excerpt
    _attributes_add
    _attributes_add
    nopaneltrue
     to ...

    Opens the Available Attributes Window.

    Insert excerpt
    _access
    _access
    nopaneltrue

    Insert excerpt
    _

    repository_find

    audit
    _

    repository_find

    audit
    nopaneltrue

    HTML Comment
    hiddentrue
    Open the repository with to see the selected component in the list. This can be useful if you want to move a component

    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_

    screen

    box_

    properties

    tick
    _check_

    screen

    box_

    properties

    tick
    nopaneltrue

    Open the properties tab for the screen. Insert excerpt_record_show_record_shownopaneltrueDisplay information about the stream (table) and its (stream items) records

     to open the screen when the application starts.

    Insert excerpt
    _check_box_

    mapping

    untick
    _check_

    mapping

    box_untick
    nopaneltrue

    Opens a new mapping element properties tab where you can map attributes with different names to components. Insert excerpt_children_childrennopaneltrueFor the selected parent container, select all the child components. Insert excerpt_table_properties_table_propertiesnopaneltrueor Show the Stream ConfigurationOpen the properties for the stream (table). Insert excerpt_attributes_show_attributes_shownopaneltrue...

    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 (table)<name> Insert excerpt_attributes_show_attributes_shownopaneltrue for view <name>

     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.