General control elements of the GUI

Here you will find a description of widely used control elements in the GUI.

Burger menus

images/download/thumbnails/177898627/1233-version-2-modificationdate-1743138072091-api-v2.png

On many pages, a burger menu is available with advanced display features (expand/collapse everything, more columns, multi selection, etc.).

Most of these options are self-explanatory, otherwise they are explicitly listed below.


Option

Description

Re-render

In very rare cases it can happen that empty lines are displayed or that the collapsing/expanding does not work cleanly. The reason usually is the very high frequency of browser updates, which can temporarily lead to display problems. However, the underlying data structure is never affected by this. By re-rendering the displayed page, such display problems can usually be solved.

Multi selection

Allows you to select multiple entries. Note: Hold down the left mouse button and drag over the entries to be selected.

File access (installation folder)


You can access files in the installation directory on several different pages of the GUI.


Editor


A detailed description of the editor can be found here.

Allowed values in function parameters


images/download/attachments/177898627/742-version-2-modificationdate-1743153192503-api-v2.png

images/download/attachments/177898627/1277-version-2-modificationdate-1743153101903-api-v2.png


When configuring functions (in the target structure in phase 3), you will often have the possibility to choose from a list of allowed values for function parameters (e.g. usable encodings or MIME types, available database aliases, certificates, channels, etc.). A useful feature that you should keep in mind. First click on the three dots on the right of the parameter fields (1), then choose "Paste" (2), and then select the desired value under "Allowed values" (3).

Icons in mappings


The following icons are used in the source and target structure in phase 3.


images/download/attachments/177898627/789-version-2-modificationdate-1743155598392-api-v2.png

Source structure node/Target structure node active, without path .

images/download/attachments/177898627/790-version-2-modificationdate-1743155616819-api-v2.png

Source structure node/Target structure node inactive, without path .

images/download/attachments/177898627/788-version-2-modificationdate-1743155631811-api-v2.png

Source structure node/Target structure node active, with path .

images/download/attachments/177898627/791-version-2-modificationdate-1743155645678-api-v2.png

Source structure node/Target structure node inactive, with path .

images/download/attachments/177898627/757-version-2-modificationdate-1743155659570-api-v2.png

A function on a node and field of the target structure.

images/download/attachments/177898627/760-version-1-modificationdate-1736825673214-api-v2.png

A database node.

images/download/attachments/177898627/766-version-2-modificationdate-1743155766819-api-v2.png

An iteration node.

images/download/thumbnails/177898627/764-version-2-modificationdate-1743155779348-api-v2.png

A calculation field.

images/download/attachments/177898627/785-version-2-modificationdate-1743155794339-api-v2.png

Node attribute "Minimum>0".

images/download/attachments/177898627/786-version-2-modificationdate-1743155815132-api-v2.png

Node attribute "Maximum=1".

images/download/attachments/177898627/782-version-2-modificationdate-1743155827838-api-v2.png

Field mapped.

images/download/attachments/177898627/781-version-2-modificationdate-1743155841110-api-v2.png

Field not mapped.

images/download/attachments/177898627/783-version-2-modificationdate-1743155853903-api-v2.png

Match code on a node of the source structure.

images/download/attachments/177898627/787-version-2-modificationdate-1743155867057-api-v2.png

Represents a source structure field with set attribute "New record if value changes".

Context menus


In general, you will find a context menu (right mouse button for 'normal' computers, or corresponding click for pads) with a list of functions in almost all lists and other entries.

In most cases, this is referred to directly in the description of the respective GUI component.

Although this is a control operating concept, it shall be pointed out here in the event that control elements in the GUI are not recognisable at first glance.

Multi selection


Module overviews


See option "Multi selection" in burger menus.

Profile structures


You can achieve a multi selection of nodes and fields in the source and target structure of profiles in phase 3 by holding down the "Ctrl" or "Shift" key.

Saving and caching profiles


images/download/attachments/177898627/754-version-2-modificationdate-1743138612053-api-v2.png


(1) Create intermediate version: This creates an intermediate state of the profile (2). The current profile state is stored internally but not 'published', i.e. the profile is not yet saved. Note: An intermediate version of a profile can be recognised in the profile overview in column "Intermediate version". You will also see a corresponding icon in the context menu of the profile entry.

(2) This can be used to restore the intermediate state. If an intermediate state (2) is available and the server or browser crashes or the session is invalid and the profile is edited again, a dialogue appears asking whether the intermediate status should be used.

(3) Save: The profile is actually saved with this button. The intermediate state (2) is then automatically deleted.

(8) Variables: You can define variables and constants in another dialogue.

Backup of profiles


Via "Save & backup & close" (4), first a backup of the profile is created (unsaved changes are not adopted) and then the profile is saved (with the changes). If the profile is a template that was changed in phases 1, 3-6, another dialogue appears in which you can select which profiles derived from the template are to be synchronised accordingly. Note: In the file system you will find the profile backups under ./datawizard/settings/-1.


images/download/attachments/177898627/1757-version-3-modificationdate-1743157566993-api-v2.png


Via (5) you can enter a change note for the saved changes. You will find these notes on page "Info (Main Settings)", further details there. Please note that the note does not refer to the backup, but to the subsequently saved profile with the changes.

Version of a profile

By creating a backup, a new version of the profile is created (the backup has the current version number). The initial version number 1 is created after the creation and first (normal) saving of the profile. If a backup is imported, the profile takes over the version number of the backup. It is also possible to increase the version number by a "normal" saving (i.e. without a backup). To do this, set the following entry in configuration file ./etc/startup.xml to true (default is "false").


<Set name="incrementVersionOnSave">true</Set>

Deleting a profile and backups


A backup is also created when a profile is deleted. Backups are not deleted when the profile from which they originate is deleted. So if you have accidentally deleted a profile and created backups before, you can create a new profile and load a backup of the old profile (if you name the new profile exactly like the old one).

Importing profile backups

Profile backups can be imported in the Main Settings of a profile in tab "Backup/Limits". Another dialogue will then appear.


images/download/attachments/177898627/1758-version-4-modificationdate-1743157549625-api-v2.png


(6) If you select a profile backup, the change notes of this profile appear in (7) (see above). Please note that the last change you see here does not come from the creation of the backup (see above), as the backup is created first and only then is the profile saved with the new change note.

Exporting and importing profiles


See section Manual Export and Import of Profiles .

Filter fields in tables


images/download/attachments/177898627/1647-version-2-modificationdate-1743156170633-api-v2.png


In all tables, at various places in the GUI (here, for example, in the log overview), filter fields (8) are available for columns.

You can enter search terms in these filter fields. As a result, only rows that contain the search term as a substring in this column are displayed.

The search term can be negated with a preceding exclamation mark "!", e.g. " !searchterm" . As a result, only rows that do not contain the search term as a substring in this column are displayed.

Exceptions


Column "Duration" (at various places in the GUI, e.g. in the log overview).

There, only given values can be selected. In addition, a specific seconds value can be specified, e.g. " 3" , or optionally an interval, e.g. " 2-4" .

Column "Name" in the profile overview.

See section Profile Overview.

Inserting variables and constants


Next to input fields, you will often find button "%". It allows you to insert variables and constants defined in the profile.