Versions Compared

Key

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

The Desktop provides a convenient user interface, displaying configurations, tools, and inspectors, with different options available for the different views.

...

The Browser displays a list of all configurations in and configurations and makes it possible to easily navigate between them.

...

OptionDescription
Column ViewEnables the users you to toggle switch between the  Compact or the  Details viewing modemodes. When the Details mode is selected, additional information will be is shown about each item: the granted permissions, Owner, Modified By, and the Modification Date.  

Refresh

Select this option to refresh the selected folder, subfolder, or configuration. 

Expand

Select this option to refresh expand the selected folder , subfolder, or configurationor subfolder to display all the subfolders and configurations that it contains.

Collapse

Select this option to expand collapse the selected folder or subfolder to not display all the subfolders and or configurations that it contains.

New Configuration

Select this option to create a new profile based on the menu list. 

New Folder...

Select this option to create a new folder.

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 configuration(s) pre-selected.

Note
titleNote!

When exporting from the Configuration Navigator, configuration dependencies are not automatically selected. This can be achieved by selecting the "Select Dependencies" check box checkbox in the System Exporter dialog. For further information see System Exporter.


Download...Downloads the selected configuration. 

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 Administration and Management in Legacy Desktop.

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 in the selected folder.

Delete...

Select this option to delete the selected configuration(s). If the configuration is referenced by another configuration, a warning message will be is 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.

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.

Encrypt...

Select this option to encrypt the selected configurations.

Decrypt...

Select this option to decrypt the selected configurations.

Validate...

Select this option to validate the configuration. A validation message will be is shown to the user.

Show Properties

Select this option to launch the Properties dialog for the selected configuration. For further information, see the Properties section below, Properties.

Documentation

Select this option to launch the Documentation dialog for the selected configuration. For further information, see the Documentation section below, Documentation.

Anchor
ConfigurationNavigator
ConfigurationNavigator

...

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

The Properties dialog box

...

Configuration InformationDescription

Name

Displays the name of the configuration.

Type

Displays the configuration type of configuration.

Key

Displays the internal key used by Image Added 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:

  • Read, modify (write), and execute the configuration.

  • Modify the permissions of user groups to read, modify, and execute the configuration.

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.
RW--Allowed to view, edit, and delete the Configuration, given that the user is granted access to the application.
-WX-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.
RWX-Full access.
---EEncrypted.

...

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.

...

ColumnDescription

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

OptionDescription
FilterThis Select to filter only those for entries that match the entered string.
SearchThis 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. "int myVar"

Note
titleNote!

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 You can use boolean operators, i .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.

SymbolDescription
+

Use this symbol before terms that must be included in the configurations that you are searching for.

Info
titleExample - Searching using +

 +myUdrA


-

Use this symbol before terms that must not be be included in the configurations that you are searching for.

Info
titleExample - Searching using -

 +myUdrA -myUdrB


?

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.

Info
titleExample - Searching using ?

terminated_by("?")
test_1?


*

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.


Info
titleExample - Searching using *

my*Udr*
myUdr*


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

Info
titleExample - Searching using ^<factor>

 myUdrA^1 myUdrB^2 myUdrC^3


~

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 roam~. This search will 
find terms like foam and roams.

You cannot use fuzzy search in phrase queries.

Info
titleExample - Searching using ~

myUdr~


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

Info
titleExample - Searching using ~<proximity>

 "myUdrA myUdrB"~20



Scroll pagebreak