Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Todo - decide if this should be renamed to Screen. Link in Phixflow will need to be updated.

Overview

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

...

  • 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

...

Basic Settings

...

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

...

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

...

Todo - not yet implemented

...

 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

...

.

...

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 height in pixels, for example 150px for a small confirmation window. The default size of a pop-up screen is approximately 500px. 

...

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

...

Dashboard Elements

...

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:

...

  • either Add a new sub-menu
  • or Add a new menu item; see Menu

...

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

...

Using Screen Options

...

  • either using the toolbar 
  • or right-click anywhere in the screen to display the pop-up menu.

Dividing Screens

A screen can be divided into multiple, resizing panes by adding vertical or horizontal splitter bars. Right-click the pane or any dashboard element on the pane to:

  • Add Vertical Bar
  • Add Horizontal Bar

Splitter bars can be removed by right clicking on an empty pane and selecting Delete Pane.

Check with David if this is being dropped for 9.

Add Dashboard Element

A dashboard element can be added to a screen by dragging predefined Stream Views onto the screen pane.

Remove Dashboard Element

You can remove a Dashboard Element from the screen by right clicking on the view and going to Screen Options → Remove element from screen

Menus and Toolbars

Screen Toolbar

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

...

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

...

Unlock a screen to edit its layout.

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

...

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

Screen Context Menu

Right-click on a screen to display the context menu for it. The options available depend on where you right-click and the options appropriate. 

Where the context menu has many options, some are listed under Dashboard Options (todo -check changing to More...)

...

When dividing a screen layout, specify where you want a new to be added, relative to the currently selected area.

A screen can be divided into multiple, resizing panes by adding vertical or horizontal splitter bars. Right-click the pane or any dashboard element on the pane to:

  • Add Vertical Bar
  • Add Horizontal Bar

Splitter bars can be removed by right clicking on an empty pane and selecting Delete Pane.

...

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

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.

...

 to ...

Opens the Available Attributes Window.

Insert excerpt
_

...

access
_

...

access
nopaneltrue

Insert excerpt
_

...

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_

...

box_tick
_check_box_tick
nopaneltrue
 to open the screen when the application starts.

Insert excerpt
_

...

check_box_untick
_check_box_untick
nopaneltrue

change to Show in layers??

...

 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.