Skip to main content
Matrix42 Self-Service Help Center

Non Visual Controls: Dialog Manager

Dialog Manager control settings and usage examples: handling the behavior of the non-visual elements of a Dialog layout

Overview 

A Dialog Manager combines several options intended for handling the behavior of the non-visual elements of a Dialog layout, among them:

  • hide views:  define display conditions for specific tabs of the dialog;
  • manage data update: automatically reload the page or application due to specified settings;
  • configure confirmation dialog: define the conditions when the window is shown and design the content of the suggested window:     

confirmation_dialog_ui.png

Confirmation Dialog displaying example

Particularities

  • Supported Layout types: Dialog Manager is available for the Dialog layouts only.
  • Restrictions: only one Dialog Manager can be applied for the edited layout.
  • Required:  Dialog Manager is an optional element of the layout.

Dialog Manager configuration

Dialog Managesettings are applied for the entire layout, therefore, its settings will be used for all views or so-called tabs of the layout.

To configure a Dialog Manager:

  1. Customize the Dialog layout in the Layout Designer;
  2. In Toolbox find Non-visual controls;
  3. Select Dialog Manageand drag&drop the control on the layout canvas;
  4. Configure Dialog Manageproperties to apply the settings for the entire layout:

dialog_manager_layout_designer2.png

Properties and settings 

All properties except for the Name field are optional. 

Property group Property name Description
Confirmation Dialog  

Holds a set of properties intended for the Confirmation Dialog display conditions and content management:

confirmation_dialog_ui.png

Configured confirmation dialog appears when users click "Save" or "Done" button on the Dialog layout.

 

Skip For Unmodified Objects

Allows skipping confirmation dialog displaying if no changes were introduced to the data of the layout.

The field accepts boolean data type. Possible options:

  • Default: not set. Confirmation dialog display in the user interface depends on the Enabled field property.
  • Model: suggests fields from the data model of the edited layout. Choose the field value from the suggested list or add a new calculated field property which results in true or false statement;
  • Static value checkbox options:
    • disabled: enabled for display confirmation dialog is shown even if the layout data has not been modified;
    • selected: enabled for display confirmation dialog is not shown if the layout data has not been modified.

Enabled

defines whether the confirmation dialog is shown to the end-users of the edited layout.

The field accepts boolean data type. Possible options:

  • Default: not set. Confirmation dialog is not shown in the user interface.
  • Model: suggests fields from the data model of the edited layout. Choose the field value from the suggested list or add a new calculated field property which results in true or false statement;
  • Static value checkbox options:
    • disabled: confirmation dialog is not shown;
    • selected: confirmation dialog is always shown when users click "Save" or "Done" button on the Dialog layout, unless the confirmation dialog has enabled Skip For Unmodified Objects property.

Title

Title of the displayed in the application confirmation dialog:

clipboard_e5031850fac6820bd941fe682d2a3ee59.png

The field accepts string data type from the following sources:

  • Model: suggests fields from the data model of the edited layout. Choose the field value from the suggested list or add a new calculated field property if necessary.
  • Localizable: displayed title can be set per each available in the system locale. Localizable data is retrieved from the specified localizable field and shows appropriate text according to the current user's language specified in the user profile settings;
  • Static value: manually entered text;

Message

Message displayed in the confirmation dialog:

clipboard_ebb7083b7131ed0566635b940c5c10aba.png

The field accepts string data type from the following sources:

  • Model: suggests fields from the data model of the edited layout. Choose the field value from the suggested list or add a new calculated field property if necessary.
  • Localizable: displayed title can be set per each available in the system locale. Localizable data is retrieved from the specified localizable field and shows appropriate text according to the current user's language specified in the user profile settings;
  • Static value:  manually entered text;

Actions

Buttons shown in the confirmation dialog:

clipboard_ed5960b710121ebb0704f311b02747669.png

Add as many as necessary by specifying the following properties for each Action:

  • Name (mandatory): internally used technical name of the configured action;
  • Position (optional): defines the displaying order of the actions. Specify an integer value to reorder the displayed buttons. All buttons are sorted starting from the lowest integer shown on the left side of the confirmation dialog to the highest, shown on the right:
    confirmation_dialog_actions_position.png

Save the Action and proceed to the following settings:

  • Title: localizable or static text of the action button: e.g. Discard, Cancel, Save, etc.
  • Not Save checkbox options:
    • disabled: the action saves the data of dialog layout;
    • selected: closes the confirmation dialog. Introduced on the layout changes are not saved.
  • Is Confirm Button checkbox options:
    • disabled: action button is not highlighted;
    • selected: action button is highlighted.

Highlighting the background color of the action can be used as a visual prompt for the button that should be clicked, but the highlighted button does not define which action will be applied when the user hits "Enter" on the keyboard.  

 

Save Action settings example may look as follows:

confirmation_dialog_actions_example.png

Result

Data model item which stores the technical name of the clicked by the user Action.
Action

Views to hide

defines the displaying conditions of the dialog views:

dialog_manager_manage_views.png

Dialog views and Views To Hide settings

Specify the field value from the suggested data model items or add a new calculated field property if necessary.

As a rule, Views To Hide is used with a calculated field property which is based on a JavaScript expression. The expression should result in true or false statements and hide the views from the layout according to the enumerated in the array Technical Names of the views and applied condition operator:

  hide_views.png

The given example hides "Filters" and "Views" tabs from the layout and shows only "General" tab when a new Dataset view is added to the system. 

Views To Hide can also be used for the dialogs with intersecting views that should be available for one data object but hidden for the other, for instance, standard settings for the Data Definition dialog:

JavaScript expression has the same syntax: 

return schemaType.$value === 2 ? [] : ['data'];

Result: Data Definition of a Pickup type (schemaType=2) allows configuring all available for the dialog views, while the Data Definition of a Classes type does not show "Data" view. 

Trigger Data Reload

The field allows refreshing the dialog page due to a verified condition.

  • Model: select the field of a boolean type from the Data Model.  
  • Static value: 
    • false: select this option if you don't need to refresh the dialog page;
    • true: avoid this option as it may cause the dialog failure resulting in constant reload of the page. 

Reload Application On Save

The field allows refreshing the entire application in order to instantly apply changes saved on the Dialog.

  • Model: select the field of a boolean type from the Data Model.  
  • Static value: 
    • false: select this option if you don't need to refresh the application;
    • true: the browser will always reload the application when the user saves the applied on the Dialog changes.
Common

Name

automatically generated name or identifier of the configured for the layout dialog manager.