The Desktop provides a convenient user interface, displaying configurations, tools, and inspectors, with different options available for the different views.
...
To open the Properties dialog, right-click a configuration and then select Show Properties.
The Properties dialog box
...
| Configuration Information | Description |
|---|---|
Name | Displays the name of the configuration. |
Type | Displays the configuration type of configuration. |
Key | Displays the internal key used by 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 is shown. For further information about permissions, see The Permissions Tab in Configuration Browser. |
Owner | Displays the username of the user that created the configuration. The owner can:
|
Modified by | Displays the user name username of the user that made the last modifications to the configuration. |
Modified | Displays the date when the configuration was last modified. |
...
| 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 contains information about which other configurations that the current configuration is referring refers to, and which other configurations that the current configuration is referenced by:
...
The References tab contains two sub-tabs: Used By, which displays all the configurations that use the current configuration, and Uses, which displays all the configurations that the current configuration uses.
If you want to To edit any of the configurations, you can double-click the configuration to open it for editing.
...
| 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 Configuration history for the Configuration, click the Clear Configuration History button. The version number is not affected by this.
...
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 Documentation Generator.
Global Search
A field for Click the Search button to be able to make free text searches is available when the Search button is pressed. Two options will be are shown at the top of the list where the individual entries are displayed.
| Option | Description |
|---|---|
| Filter | This Select to filter only those for entries that match the entered string. |
| Search | This will highlight Select to find individual entries that match the entered string. By pressing Press Find Next to go to each individual entry can be shownin turn. |
You can disable the search functionality by setting the cell property mz.use.search to false. This will decrease decreases the startup time of the Platform by approximately 10%.
Each entry in the search results result contains a path to the configuration and a fragment of its settings or code. Double-clicking on click an entry opens to open the corresponding configuration.
...
To search for a phrase you must use quotation marks e g .g. "int myVar".
| Note | ||
|---|---|---|
| ||
The following characters are treated as word separators: When a term contains a quotation mark, it must escaped by |
By default, queries will return all configurations that contain any of the search terms. You You can use boolean operators, i e .e. + or -, to further refine the search results. For instance, the query +tcp_ip +3210 will only return returns configurations that contain both 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.
| |||||
| - | Use this symbol before terms that must not be be included in the configurations that you are searching for.
| |||||
| ? | 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.
| |||||
* | 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.
| |||||
| ^<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.
| |||||
| ~ | 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.
| |||||
| ~<proximity> | You can search for terms that are within a specific distance from another term. To perform this type of search, use the tilde, "~" ~ (tilde) symbol with a proximity value that denotes the row distance.
|
...