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.

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
additional none
placeholder Search all help pages
type page

Panel

borderColor	#00374F
titleColor	white
titleBGColor	#00374F
borderStyle	solid
title	Sections on this page

Table of Contents

maxLevel	3
indent	12px
style	none

Basic Settings

FieldDescriptionNameThe name of the screen.Open Maximised

Insert excerpt

	_Banners
	_Banners
name	screen
nopanel	true

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
nopanel	true

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Insert excerpt

	_parent
	_parent
nopanel	true

Basic Settings

Field

Description

Name

The name of the screen.

Open Maximised

Insert excerpt

	_check_box_tick
	_check_box_tick
nopanel	true

to open the screen maximised.

Insert excerpt

	_check_box_untick
	_check_box_untick
nopanel	true

to open the screen as a popup window.

Allow User to Resize

Insert excerpt

	_check_box_tick
	_check_box_tick
nopanel	true

to enable the application user, when running in

Insert excerpt

	_app_mode
	_app_mode
nopanel	true

, to resize the screen.

Insert excerpt

	_check_box_untick
	_check_box_untick
nopanel	true

to keep the screen size fixed when running in in

Insert excerpt

	_app_mode
	_app_mode
nopanel	true

.

This option does not affect resizing the screen in

Insert excerpt

	_design_mode
	_design_mode
nopanel	true

.

Show Toolbar

Insert excerpt

	_design_mode
	_design_mode
nopanel	true

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
nopanel	true

to also display the toolbar in

Insert excerpt

	_app_mode
	_app_mode
nopanel	true

. The screen name is displayed. Toolbar icons are not displayed.

Insert excerpt

	_check_box_

ticktick to open the screen maximised.checkbox_untickcheckbox_untick to open the screen as a pop-up window.Allow User to Resize enable the application user, when running in appmodeappmode, to resize untickuntick size fixed when running in in Insert excerpt_app_mode_app_modenopaneltrue.This option does not affect resizing the screen in designmodedesignmodeShow Toolbar display a toolbar for the screen todo - currently not working??

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
nopanel	true

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

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.

Insert excerpt

	_check_box_tick
	_check_box_tick
nopanel	true

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

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
nopanel	true

is the default. The

screen data is not required once the screen is closed.PreloadScreens, 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.

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

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
nopanel	true

to

preload 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_unticknopaneltrue 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

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_ticknopaneltrue to cache the screen on the application user's client computer when the screen first opens. Insert excerpt_check_box_untick_check_box_unticknopaneltrue 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.

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

By default, 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: top left
Pinned to right: top right
Floating (default)

todo - check DEV-9189 as there are problems using these options

Width

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

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.

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 Linked and Driving Views.

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. The grid contains a list of mappings between attributes that are the same but have different names in different streams (tables) or views. PhixFlow will evaluate all the mapped datasets when it runs an action on the dashboard. Todo - check this is the correct mapping.

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

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

Insert excerpt

	_check_box_untick
	_check_box_untick
nopanel	true

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.

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.

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.

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

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
nopanel	true

available from the screen toolbar; see Screen Element.

Menu Items

This section has a toolbar with standard buttons and:

Image Added Show Table-actions
Insert excerpt
_filter
_filter
nopanel true

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

Insert excerpt

	_add
	_add
nopanel	true

Click
Insert excerpt
_add
_add
nopanel true
Select
- either Add a new sub-menu
- or Add a new menu item; see Startup Actions
PhixFlow opens a new properties tab for a menu item or sub-menu; see Startup Actions for details.

To remove a menu, use the toolbar button

Insert excerpt

	_delete
	_delete
nopanel	true

.

Mappings

This section has a toolbar with standard buttons.

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

To configure a mapping, in the screen, right-click a component and select

Insert excerpt

	_mapping
	_mapping
nopanel	true

.

Unreachable Actions

This section has a toolbar with standard buttons. The grid displays a list of actionflows that are linked to components on the screen, 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 record-actions that are linked to the screen.

Tip
Actions and record-actions were the way to configure screen functionality before PhixFlow version 9.0.0; see Using Table-Actions and Record-Action

Insert excerpt

	_description
	_description
nopanel	true

Insert excerpt

	_access
	_access
nopanel	true

Insert excerpt

	_audit
	_audit
nopanel	true

Menus and Toolbars

Screen Toolbar

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

List options

Insert excerpt

	_tables
	_tables
nopanel	true

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

Insert excerpt

	_screen_toolbar
	_screen_toolbar
nopanel	true

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

Insert excerpt

	_actionflow
	_actionflow
nopanel	true

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

Insert excerpt

	_palette
	_palette
nopanel	true

Open the list of palettes.

Insert excerpt

	_styles
	_styles
nopanel	true

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

Canvas options

Insert excerpt

	_help
	_help
nopanel	true

Open the help topic with details about working with screens.

Insert excerpt

	_property_settings
	_property_settings
nopanel	true

Open the properties tab for the screen.

Insert excerpt

	_unlock
	_unlock
nopanel	true

or

Insert excerpt

	_lock
	_lock
nopanel	true

Unlock a screen to edit its layout.

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

Insert excerpt

	_refresh
	_refresh
nopanel	true

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
nopanel	true

Options.

Menu option

Description

Insert excerpt

	_unlock
	_unlock
nopanel	true

Unlock a screen to edit its layout.

Insert excerpt

	_lock
	_lock
nopanel	true

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

Insert excerpt

	_context_

refreshrefreshtrue

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

	true

For screens created in PhixFlow versions 8.3 and earlier, open a window listing the context parameters in alphabetical order.

Insert excerpt

	_element_show
	_element_show
nopanel	true

For screens created in PhixFlow versions 8.3 and earlier, open the properties for the screen element.

Insert excerpt

	_

layoutunlocklayoutunlockUnlock to edit its layout.layout_locklayout_lockLock a screen to prevent accidental edits and to display the data contentcontextparameterscontextparametersnopaneltrueFor dashboards created in PhixFlow versions 8.3 and earlier, open a window listing the context parameters in alphabetical order.elementshowelementshowFor dashboards created in PhixFlow versions 8.3 and earlier, open the properties for the dashboard element.aboveabovetrue

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 delete_delete Panerightrightarea_belowarea_belowarea_leftarea_left_arealockwidtharealock_widthFix the height or width of the selected pane. You will no longer be able to resize a pane by dragging its dividing linearealock_heightarealock_heightdeletedeleteWhen specific is selected, delete the component.Other delete options that may be available relate to specific types of component in the selected panedelete_itemdelete_item Delete options depend on the selected item. Examples are:delete_itemdelete_item selected objects

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

_delete_itemdeleteitem panedeleteitemdeleteitem form elementdeleteelementdeletetrueDelete a dashboard elementformnewformnewCreate a new form in the current areapinunpinpinunpinPin a component to fix its position; see Pinning and UnpinningpalettepaletteOpen the palette to drag in componentsautosize_autosizenopaneltrue

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

NoteUsing this option, or manually resizing a component may change the state of the Layout → Style Settings → Auto Size propertyarrangecomponentsarrangecomponentsOptions to arrange the selected components within a pane:alignleftalignleftalignrightalignright_align_topnopaneltrue Insert excerpt_align_topalign_bottom_alignbottomdistribute_horizontaldistribute_horizontaldistributeverticaldistributeverticalrepositoryfindrepositoryfindOpen the repository with to see the selected component in the list. This can be useful if you want to move a component.screenpropertiesscreenpropertiesOpen the properties tab for the screen.recordrecordDisplay information about the stream (table) and its (stream items) records. Insert excerpt_mapping_mappingnopaneltrueOpens a new mapping element properties tab where you can map attributes with different names to components

for view <name>

HTML Comment

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_box_

childrenchildrenFor the selected parent container, select all the child componentstablepropertiestablepropertiesor 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>

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

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Panel

borderColor	#00374F
titleColor	white
titleBGColor	#00374F
borderStyle	solid
title	Sections on this page

Table of Contents

maxLevel	3
indent	12px
style	none

Learn More

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

Insert excerpt

	_

attributesshowattributesshow for view <name>

Versions Compared

Old Version 78

New Version Current

Key

Overview

See Also

Properties

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Basic Settings

Overview

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Basic Settings

Dashboard Elements

Menu Items

Mappings

Unreachable Actions

Actions

Menus and Toolbars

Screen Toolbar

Screen Elements

Menu Items

Mappings

Unreachable Actions

Actions

Menus and Toolbars

Screen Toolbar

Screen Popup Menu

Screen Pop-up Menu

Unreachable Actions

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Page Comparison

Versions Compared

Old Version 78

New Version Current

Key

Overview

See Also

Properties

Live SearchspaceKey@selfadditionalnoneplaceholderSearch all help pagestypepage

Basic Settings

Overview

Insert excerpt_property_tabs_property_tabsnamebasic-hnopaneltrue

Basic Settings

Dashboard Elements

Menu Items

Mappings

Unreachable Actions

Actions

Menus and Toolbars

Screen Toolbar

Screen Elements

Menu Items

Mappings

Unreachable Actions

Actions

Menus and Toolbars

Screen Toolbar

Screen Popup Menu

Screen Pop-up Menu

Unreachable Actions

Live SearchspaceKey@selfadditionalnoneplaceholderSearch all help pagestypepage

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page