Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Toolbar

interface_konfigurator_test01.png

Option

Description

Open

Opens an existing global configuration or an existing scenario configuration for further editing. Global configurations are identified by the IconGlobal.png icon and scenario configurations are indicated by the IconScenario.png.

Provided that this functionality is activated in the global configuration of the running program instance, the file system and, optionally, the administrative database, are supported as a source for configuration data. For using files, a free selection of the directory when loading and saving the configuration data is only provided if it is required. By default, the system assumes the storage location of the files to be the directory in which the global configuration file of the running instance is located.

The configurations have a unique technical name which, in the case of files, corresponds to their base name (i.e., excluding the file extension). The user can enter a meaningful technical name in the configuration properties. This name will be what is seen when the configuration is selected.

When the files from the configuration file directory appear, you can select one of them to open. To search for files in other directories, click Browse2.png Browse file system.

interface_konfigurator_oeffnen_auswahl.png

New

Creates a new configuration based on a template.

Select the template to be used. This option offers blank configuration templates for global configuration and scenario configuration.

Depending on the package delivered, additional templates may also be available containing default settings for certain standardized use cases.

interface_konfigurator_neu_konfigurationsvorlage.png

Save

Saves the current status of the configuration that is being edited.

When a configuration is saved for the first time, the configuration file directory will by default be used as the storage location. When saving, specify the technical Base name (ohne file extension) under which the file is stored. If required, select a different target directory.

When an existing configuration is saved, backup copies are automatically created on a rolling basis in accordance with the global property ConfigService.MaxBackupCount.

Close

Closes the configuration that is currently being edited.

Caution: All unsaved changes will be lost when closing.

Delete

Deletes the currently loaded configuration file from the directory.

When deleting, a backup copy is automatically created according to the global property ConfigService.MaxBackupCount.

Validate

Performs a rudimentary validation of the current configuration.

For more information, see Validation.

Notice

Validation does not apply to content. If validation is successful, it does not mean that a configuration is either operable or meaningful; it only means that basic configuration errors can automatically be detected.

A configuration can still be saved if the validation is not successful.

Validation errors and warnings are displayed as a list. Click on the Error ValidationResult.png or Warning interface_icon_warnung.png button in the menu bar to show or hide this list. The list is retained until a new validation is performed.

interface_validierung_warnung_liste.png

The path to the respective configuration property is displayed in the list for each warning and each error. Click on the path to open the configuration property directly in the configuration form.

Validation

The following basic properties are checked when validation is performed:

Property

Description

Missing entries

  • Missing input value of a single configuration data field. Note that a mandatory field condition may vary depending on the context, especially on the value of another field. Simple dependencies are stored in the metadata model, but in more complex configurations, the check might not find all missing entries.

  • Missing input value in a value list in an input field if more than one value is required. Empty values are automatically removed from the list during validation.

  • Undefined configuration data object within a list of objects, if at least one object is required.

Syntax error

  • Invalid syntax of an input field that requires a literal (i.e., a constant text, number, date, or Boolean value).

  • Invalid syntax of an input field that requires a URL.

  • Invalid value of an input field that requires a value from a predefined value list.

Field Name

  • Doubled field name within a field catalog.

  • Non-existent field name in an input field that requires a field name as a value.

In this section: