Collection Configuration

Purpose

The Collection Configuration is a configuration for grouping element to manage the key-value pairs, groups and subgroups in a meaningful way.

General configuration

This is how the configuration looks like:

Figure 1. The configuration structure of the Collection Configuration

The configuration of Collection Configuration page includes the following parts:

Name	Description	Note
Collection identifier	This option provides to enter the collection identifier.	The following validation is available for the "Collection identifier" field: The identifier must be mandatory; The identifier must be unique; The identifier must consist only of lowercase characters; The identifier must not include special characters.
Description	This option provides to enter a description of the purpose of the collection.	The "Description" field is optional.
Define included groups	The table widget provides to define included key value groups and contains the following columns: Group This option provides to enter the name of the group. Description This option provides to enter a description of the purpose of the group. The table widget also contains the following functions: to add a group; to copy path information, that contains the whole configuration structure to the current item. to delete a group. The function is available only when at least one item is selected.	The configured groups within the table widget can be sorted by arrow icons.

Name

Description

Note

Collection identifier

This option provides to enter the collection identifier.

The following validation is available for the "Collection identifier" field:
- The identifier must be mandatory;
- The identifier must be unique;
- The identifier must consist only of lowercase characters;
- The identifier must not include special characters.

Description

This option provides to enter a description of the purpose of the collection.

The "Description" field is optional.

Define included groups

The table widget provides to define included key value groups and contains the following columns:

Group
This option provides to enter the name of the group.
Description
This option provides to enter a description of the purpose of the group.

The table widget also contains the following functions:

to add a group;
to copy path information, that contains the whole configuration structure to the current item.
to delete a group.
The function is available only when at least one item is selected.

The configured groups within the table widget can be sorted by arrow icons.

How to create a collection

To create a collection, follow these steps in Generic Configuration section:

Click on "Add collection" function in the left panel toolbar.
Enter the collection identifier in the input field on modal (required).
Enter the collection description (optional).
Click on "Create" button.
New collection is available and displayed in generic configuration overview as entry.

The collection identifier needs to consist only of lowercase characters.
No special characters are allowed in collection identifier.
No space is allowed as inputs, space should be transformed automatically to underline '_'.

Figure 2. Creating a collection

Figure 3. Creating a collection with uppercase letters

Figure 4. Creating a collection with special characters

Welcome to the AI Chat!

Write a prompt to get started...