Open

Desktop Client is the user interface application that enables you to manage, navigate, and monitor the system. Using Desktop Client, you create workflows. A workflow is a set of agents that are connected to each other and represent a flow of data processing. All the agents in a workflow operate on a specific data type, and most agents need to know the structure, the Input/Output data, of the data in order to operate properly.

Open

The Desktop Client User Interface

The Desktop Client 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.

The Desktop Client window is organized into two main sections:

• The left part - Configuration Navigator pane: The Configuration Navigator holds all configurations and enables easy navigation between the different configurations. To create a new configuration, click the New Configuration button. To open an existing configuration, double-click on the configuration in the Configuration Navigator, or right-click on a configuration and then select Open Configuration(s)... . The configuration will be visible in a tab in the right part of the Desktop window. For further information, see the section below Desktop Client User Interface (4.3) | Configuration Browser.

  • Configurations - A configuration is a configurable item, for example, a workflow or a Database profile. 
    For further information about configurations, see Common Configurations(4.3).
    
    

  • Inspection - 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 Data Management (4.3).
    
    

    
    Tools - Usage Engine provides different tools to, for example, view logs, statistics, and pico instance information, and to import and export configurations. To open tools, click on the Tools button . The tools are described in Tools(4.3).

    The right part - Tabs: The right part of the Desktop window holds all Configurations, Inspectors and Tools that have been opened, each of them shown in a separate tab.

Configuration Browser

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. 

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 Platform Properties(4.3).

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 Workflow Types(4.3).

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:

Properties

To open the Properties dialog, right-click a configuration and then select Show Properties.

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:

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:

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.

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 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:

In the version table, the following columns are included:

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.

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(4.3) tool. When you have completed the text you want to include, click OK to save. 

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.

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

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.

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

This chapter describes applications, features and settings used in the Desktop Client and contains the following sections: