1.3 Desktop User Interface
- Jenni Wallin
- Former user (Deleted)
The Desktop provides a tabbed user interface, which allows for having more than one configuration open in the same window and to easily switch between different configurations.
Desktop window
The Desktop window is organized into two main sections:
The left part of the Desktop window includes the pane. The Configuration Navigator holds all the configurations and enables easy navigation between the different configurations. For further information, see the section below, Configuration Navigator.
The right part of the Desktop window holds all , and that have been opened, each of them shown in a separate tab.
- A configuration is a configurable item, for example, a workflow or a Database profile. For further information about configurations, see 2. Configuration.
- When workflows are executed, the agents may generate various kinds of data, such as logging errors into the System Log, or sending erroneous data to the Error Correction System (ECS). The inspectors allow the user to view such information and are further described in 5. Inspection.
-
provides different tools to, for example, view logs, statistics, and pico instance information, and to import and export configurations. The tools are described in 6. Tools.
For information on how to create a new Configuration, and how to open an Inspector or a Tool, refer to the section below, Desktop Standard Buttons.
Tabs
Configurations and tools are opened in separate tabs, in the right part of the Desktop window. However, dialogs that are opened from a tool or configuration, for example, an Agent Configuration dialog or the MIM Browser, will be opened in a dialog box and not in another tab.
| Button | Description |
|---|---|
 | To the right of the list with tabs, you have a button for viewing open tabs, which may be useful in case you have many configurations open at the same time. |
Click this button and a menu will open, containing all the currently opened tabs.
Open Tabs List dialog
When exiting from Desktop, all tabs will be closed, and unless you have set the property mz.gui.restart.tabs to true, they will not be remembered and restored the next time the Desktop is started. For further information, see the 2.6.9 Desktop Properties in the System Administrator's Guide.
To reorder the tabs, click a tab and drag it to a different position along the top of the window.
To move a tab to a separate Desktop window, click it and then drag it outside the current window. This can be useful when running and analyzing several workflows in the Workflow Monitor, to be able to view the monitors side by side. If there is only one tab open in the Desktop and the tab is moved to a separate window, the original Desktop window will be closed. A Tool, Inspector or Configuration can only be open in one tab at a time.
It is possible to move tabs between several Desktop windows.
Menus and Buttons
The Desktop user interface includes the following standard features:
| Feature | Description |
|---|---|
| Desktop Main Menus | The Desktop main menus are found at the top of the Desktop window. The menus are dynamic and change according to the type of Configuration, Inspector or Tool that has been opened in the currently displayed tab. Refer to 2. Configuration, 5. Inspection and 6. Tools for more details about the specific menus and menu items. For a description of the Desktop standard menus, see the section below, Desktop Standard Menus. The following figure shows the main menus that are visible for a workflow configuration.
The Desktop main menus for a workflow configuration |
| Desktop Buttons | There are different closing options available for a tab and these are selected from a right-click menu. See the section below, Tab Right-Click Menu, for more information.  The Desktop buttons |
| Tab Right-Click Menu | There are different closing options available for a tab and these are selected from a right-click menu. See the section below, Tab Right-Click Menu, for more information. The tab right-click menu |
| Tab Button Panel | The button panel is visible at the top of a tab. It is dynamic and changes according to the type of Configuration, Inspector or Tool that has been opened in the currently displayed tab. For a description of the specific buttons, refer to 2. Configuration, 5. Inspection, and 6. Tools. The following figure shows the button panel visible for a workflow configuration.
The tab button panel for a workflow configuration |
Desktop Standard Menus
The following figure shows the Desktop main menus and menu items that are shown in Desktop when starting it for the first time and when there are no tabs open yet:
The Desktop standard main menus
The File Menu
| Item | Description |
|---|---|
| Change Password... | From the File menu, select and the Change Password dialog box opens.  The Change Password dialog box |
Select to exit from the Desktop. If you want to change the Desktop user, select Exit and start the Desktop again. You can then log in with the relevant user name and password in the Login dialog box. |
The Help Menu
Shows all help topics for your installation.
Note!
If you press F1, you will open the relevant topic for the dialog you currently have active. However, for the various configurations in the Configuration menu, you may have to scroll to the right section.
Desktop Standard Buttons
These are the Desktop buttons that are located in the upper left part of the Desktop window.
| Button | Description |
|---|---|
 | To show or hide the Configuration Navigator pane in the left area of the Desktop. The Configuration Navigator is described in more detail in the section below, Configuration Navigator. |
New Configuration  | To create a new configuration. The configuration is opened in a tab in the right part of the Desktop window. The different configuration types that can be created are described in more detail in 2. Configuration. |
Inspection
| To open a |
Tools
| To open a |
When you have developed your own DTK plugins available in the Extensions menu, you can press CTRL+F4 to open this menu.
Hint!
You can also activate the button panel by pressing the CTRL key twice. You can then use the arrow keys to move between the different buttons in the panel.
Tab Right-Click Menu
Right-click at the top of a tab and select one of the following options:
| Option | Description |
|---|---|
Select this option to close the selected tab. | |
Select this option to close all other tabs in the Desktop window. | |
Select this option to close all tabs in the Desktop window. |
Configuration Navigator
The Configuration Navigator gives a view of all configurations and makes it possible to easily navigate between different configurations.
In the Configuration Navigator you can also filter what configurations to be shown, by selecting configurations of a specific type. The Configuration Navigator can be hidden or visible. By default, it is visible and all configurations are displayed. In addition, you have the option to display configurations with folders and subfolders.
The Configuration Navigator supports a set of operations that can be performed for the configurations by using the right-click menu. For each configuration you can also open a Properties dialog where permissions can be set and where you can view history, references and basic information. Refer to Properties in 6.2 Configuration Browser for more information.
| Button | Description |
|---|---|
| To show or hide the Configuration Navigator pane, click the Show/Hide Configuration Navigator button in the upper left part of the Desktop. |
Directly above the Configuration Navigator pane there is a filter text box that you can use to search for folders or configurations.
The Configuration Navigator
Directly below the Configuration Navigator pane, there are three buttons that you can use to modify how you want to display the folders in the Configuration Navigator pane.
You can enable subfolders to allow you to sort your configurations within your folders, making it easier to maintain larger implementations. To enable subfolders, you must set the Platform property mz.subfolder.enabled to true. For further information, see 2.6.4 Platform Properties in the System Administrator's Guide.
| Button | Description |
|---|---|
 | Click this button to toggle between displaying the folders only as they were originally created, e g "batch_realtime_happy_workflow", or when subfolders are created in the folders in the Configuration Navigation pane, e g a folder named "batch" with hidden subfolders named "realtime", "happy" and "workflow. When subfolders are created, configurations are sorted into subfolders determined by the separator used in the folder name. The only valid separators in a folder name are "_" or "-". If any other character is used as a separator, or if the Platform property |
 | Click this button to expand all of the folders to display the folders, subfolders and all the configurations that they contain. |
 | Click this button to collapse the folders so only the folders are visible. |
In the Configuration Navigator pane there are two standard folders:
- Default - where all Configurations are stored if no other folder is specified when saving the configuration.
- SystemTask - includes workflows for performing different background routines. For further information, refer to System Task Workflows in 3.1.1 Workflow Types.
The Default and SystemTask folders cannot be renamed or deleted.
Each folder listed in the Configuration Navigator pane has a number attached to its name. This number indicates how many configurations that are stored in the folder.
Right-Click Menu
In this section, the different options available in the right-click menu of the Configuration Navigator are described.
Right-click a configuration and select one of the following options:
| Option | Description |
|---|---|
Refresh
| Select this option to refresh the selected folder, subfolder or configuration. |
Expand
| Select this option to refresh the selected folder, subfolder or configuration. |
Collapse | Select this option to expand the selected folder or subfolder to display all the subfolders and configurations that it contains. |
New Folder...
| Select this option to create a new folder. Note! If you select a folder and select this option from the right-click menu, you create a subfolder. |
Open Configuration(s)...  | Available when at least one configuration is selected. Select this option to open the selected configuration(s). |
Export Configuration(s) | Available when at least one configuration is selected. Select this option to export the selected configurations. The System Exporter dialog opens with the configurations pre-selected. Note! When exporting from the Configuration Navigator, configuration dependencies are not automatically selected. This can be achieved by selecting the "Select Dependencies" check box in the System Exporter dialog. For further information see 6.12 System Exporter. |
Cut  | Select this option to put one or more configurations on the clipboard to move the configuration to another location. Select the menu option Paste in the folder where the configurations should be stored. This option is not applicable if the configuration is locked. For further information see Locks in 1.2 Administration and Management. |
Copy
| Select this option to put one or more configurations on the clipboard to copy the configurations to another location. Select the menu option Paste in the folder where the copied configurations should be stored. |
Paste
| Select this option to store configurations that have been cut or copied to the clipboard into a folder. |
Delete...
| Select this option to delete the selected configuration(s). If the configuration is referenced by another configuration, a warning message will be displayed, informing you that you cannot remove the configuration. For further information see The References Tab in 6.2 Configuration Browser . You can force the deletion of a folder and all the configurations that it contains. A message is displayed asking if you are sure that you want to continue, in order to avoid deletion by mistake. Note that there is no restore option for this function. All the configurations are permanently removed. Note! If you have enabled subfolders, you can only delete the last subfolder within a folder. |
Rename...  | Select this option to change the name of the selected configuration. Take particular care when renaming a configuration. If, for example, an APL script is renamed, workflows that are using this script will become invalid. This is important to know when you rename folders that contain many ultra format configurations or APL configurations. Renaming a folder with ultra formats or APL configurations will make all referring configurations invalid. Note! If you have enabled subfolders, you can only rename the last subfolder within a folder. |
Select this option to encrypt the selected configurations. | |
Select this option to decrypt the selected configurations. | |
Validate... | Select this option to validate the configuration. A validation message will be shown to the user. |
Show Properties  | Select this option to launch the Properties dialog for the selected configuration. For further information, see the section below, Properties. |
| Documentation | Select this option to launch the Documentation dialog for the selected configuration. For further information, see the section below, Documentation. |
Properties
To open the Properties dialog, right-click a configuration and then select Show Properties.
The Properties dialog box
This dialog contains four different tabs: Basic, which contains basic information about the configuration, Permission, where you set permissions for different users, References , where you can see which other configurations that are referenced by the selected configuration, or that refers to the selected configuration, and History which displays the revision history for the configuration. The Basic tab is displayed by default.
The Basic Tab
The Basic tab is the default tab in the Properties dialog and contains the following information:
| Configuration Information | Description |
|---|---|
Name | Displays the name of the configuration. |
Type | Displays the type of configuration. |
Key | Displays the internal key used to identify the configuration. |
Folder | Displays the name of the folder in which the configuration is located. |
Version | Displays the version number of the configuration, see the History tab for further information about the different versions. |
Permissions | Displays the permissions granted to the current user of the configuration. Permissions are shown as R (Read), W (Write) and X (eXecute). If the configuration is encrypted, an E will also be added. For further information about permissions, see The Permissions Tab in 6.2 Configuration Browser. |
Owner | Displays the username of the user that created the configuration. The owner can:
|
Modified by | Displays the user name of the user that made the last modifications to the configuration. |
Modified | Displays the date when the configuration was last modified. |
If you want to use the information somewhere else you can highlight the information and press CTRL-C to copy the information to the clipboard.
The Permissions Tab
The Permissions tab contains settings for what different user groups are allowed to do with the configuration:
The Permissions tab
As access permissions are assigned to user groups, and not individual users, it is important to make sure that the users are included in the correct user groups to allow access to different configurations.
| R | W | X | E | Permission Description |
|---|---|---|---|---|
| R | - | - | - | Allowed only to view the Configuration, given that the user is granted access to the application. |
| - | W | - | - | Allowed to edit and delete the Configuration. |
| - | - | X | - | Allowed only to execute the Configuration. |
| R | W | - | - | Allowed to view, edit and delete the Configuration, given that the user is granted access to the application. |
| - | W | X | - | Allowed to edit, delete and execute the Configuration. |
| R | - | X | - | Allowed to view and execute the Configuration, given that the user is granted access to the application. |
| R | W | X | - | Full access. |
| - | - | - | E | Encrypted. |
The References Tab
The References tab contains information about which other configurations that the current configuration is referring to, and which other configurations that the current configuration is referenced by:
The References tab
The References tab contains two sub tabs: Used By, that displays all the configurations that use the current configuration, and Uses, that displays all the configurations that the current configuration uses.
If you want to edit any of the configurations, you can double-click the configuration to open it for editing.
The History Tab
The History tab contains version information for the configuration:
The History tab
In the version table, the following columns are included:
| Column | Description |
|---|---|
Version | Displays the version number. |
Modified Date | Displays the date and time when the version was saved. |
Modified By | Displays the user name of the user that saved the version. |
Comment | Displays any comments for the version. |
If you want to clear the history for the Configuration, click the Clear Configuration History button. The version number is not affected by this.
Documentation
To open the Documentation dialog, right-click on a configuration and then select Documentation.
The Documentation dialog
In this dialog, you can provide information on the selected configuration, for example, a description and the purpose of the configuration. You can use markdown syntax if preferred. The text entered is then included in the automated documentation that you can generate using the Documentation Generator tool. When you have completed the text you want to include, click OK to save. For further information on the Documentation Generator tool, see 6.5 Documentation Generator.
Global Search
A field for free text searches is available at the top right of the main window. You can use this field to search for saved configurations on your system.
You can disable the search functionality by setting the cell property mz.use.search to false. This will decrease the startup time of the Platform by approximately 10%.
Each entry in the search results contains a path to the configuration and a fragment of its settings or code. Double-clicking on an entry opens the corresponding configuration.
To view a fragment or open a configuration, you must have the required read access permissions.
Global search field
A search query may contain single-word or phrase terms that correspond to code, free text values, or configuration names. These terms are not case sensitive but exact matches are required, unless you are using wildcards.
To search for a phrase you must use quotation marks e g "int myVar".
Note!
The following characters are treated as word separators: : , ; , , , < , = , > , ( , ) , ! , [ , ] , { , }
When a term contains a quotation mark, it must escaped by \ (backslash).
By default, queries will return all configurations that contain any of the search terms. You can use boolean operators, i e + or -, to further refine the search results. For instance, the query +tcp_ip +3210 will only return configurations that contain both tcp_ip and 3210.
The table below describes symbols that you can use to perform complex queries.
| Symbol | Description |
|---|---|
| + | Use this symbol before terms that must be included in the configurations that you are searching for. Example - Searching using + |
| - | Use this symbol before terms that must not be included in the configurations that you are searching for. Example - Searching using - |
| ? | Use the this symbol in a term to perform a single character wildcard search. You cannot use wildcard symbols within phrase queries. You cannot use a wildcard symbol as the first character in a term. Example - Searching using ?
|
* | Use the this symbol in a term to perform a multiple character wildcard search. You cannot use wildcard symbols within phrase queries. You cannot use a wildcard symbol as the first character in a term. Example - Searching using *
|
| ^<factor> | You can change the relevance level of matching configurations based on the terms found. Use the ^ (caret) symbol with a factor value at the end of a term to boost it. The higher the boost factor, the more relevant the term will be. Example - Searching using ^<factor>
|
| ~ | Use this symbol at the end of the terms to perform a fuzzy search. For instance, to search for a term similar in spelling to "roam", use You cannot use fuzzy search in phrase queries. Example - Searching using ~
|
| ~<proximity> | You can search for terms that are within a specific distance from another term. To perform this type of search, use the tilde, "~" symbol with a proximity value that denotes the row distance. Example - Searching using ~<proximity> |
Status Bar
At the bottom of the main window a status bar is shown. It is divided into four sections, which contain information about your system.
The status bar
| Status bar information | Description |
|---|---|
Actions | The first section shows desktop actions. It could either be a text message with user information such as "Saved myWorkflow" or a progress bar when data is being loaded from the Platform to the Desktop. |
Operations Information | An icon for displaying the status of the Configuration Monitor. While operations are being performed, for example when workflows are in building state, the icon will indicate that the operations are in progress. If any warnings have been detected during the operations, a warning sign is shown on top of the Configuration Monitor icon. When you press the icon, the Configuration Monitor will be displayed. For more information regarding the Configuration Monitor, see 6.4 Configuration Monitor. |
User | Specifies the user that is logged into the Desktop. When you hover the pointer over the username, the date/time of the last successful login and the IP address that was used are displayed in a tooltip. |
| System Information | Specifies the system name as well as the host and port that the Desktop is connected towards. |