...
A property can be classified in the schema definition to be displayed as a dynamic catalog in your client by setting the value dynamic:catalog[<parameters><catalog name>] for the attribute classification. Two comma-separated string parameters are accepted:
...
The catalog name will be the displayed expression in
...
your client per default. It can be localized in order to replace the displayed expression. We recommend naming conventions described below that makes it easy to distinguish between tenant-specific and global catalogs.
...
Catalogs can be set as readonly in the catalog maintenance view of the architect. Thus, the catalog values can not be modified via the dms-controller endpoints of the Web-API gateway. Since the client uses the dms-controller endpoints, the corresponding pick-list elements in the client will also be not editable. Changes can be applied only via the system-controller endpoints in case of global catalogs and via the admin-controller endpoints in case of tenant-specific catalogs.
The catalog values are saved in a JSON file in the config server beside the corresponding schema configuration.
...
In the following code block, an example schema definition of the example string property contract is displayed. The property is classified by line 6 to be a dynamic catalog that is displayed as a pick list with the technical name tenMytenant:contracts in your client. Initially, the list of values offered to users will be empty. Since there is no readonly parameter within the value of the classification attribute, the pick-list will be editable in the client.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<propertyStringDefinition>
<id>contract</id>
<propertyType>string</propertyType>
<cardinality>single</cardinality>
<required>false</required>
<classification>dynamic:catalog[tenMytenant:contracts]</classification>
</propertyStringDefinition>
|
If the example schema is uploaded as a tenant schema via the endpoint POST /api/admin/schema by a user of the example tenant mytenant, the property contract will be available only in the specific tenant mytenant. After restarting your client, the users will get an empty pick list for the field called tenMytenant:contracts.
If a catalog should be stable after setting it up, the parameter readonly can be set into the classification attribute, e.g.:
...
...
<classification>dynamic:catalog[tenMytenant:contracts,readonly]</classification>Global Dynamic Catalogs
If the dynamic catalog should be available to all tenants, it has to be configured as global property. This means that the property definition classified as dynamic catalog has to belong either to the system schema or to an app schema. Its values are stored in the config server besides the global schema or the corresponding app schema.
For catalogs in an app schema we recommend the naming convention app<appname>:<catalogname>. For global catalogs in an app schema we recommend to use no extra prefix but only the catalog name <catalogname>.
...
Users with the role YUUVIS_SYSTEM_INTEGRATOR can set up global catalogs with initial standard elements and set the catalogs readonly.
In this case, you should use only standard values that are suitable for all tenants.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<propertyStringDefinition>
<id>contract</id>
<propertyType>string</propertyType>
<cardinality>single</cardinality>
<required>false</required>
<classification>dynamic:catalog[appMyapplication:contracts,readonly]</classification>
</propertyStringDefinition>
|
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<propertyStringDefinition>
<id>contract</id>
<propertyType>string</propertyType>
<cardinality>single</cardinality>
<required>false</required>
<classification>dynamic:catalog[contracts,readonly]</classification>
</propertyStringDefinition>
|
...
Users with the role YUUVIS_MANAGE_SETTINGS can maintain pick lists that are based on a property classified as a dynamic catalog without the readonly parameter.
The edit dialog can be opened by clicking the pencil symbol at the field. The screenshot below shows the edit dialog for the example pick list contracts where the four values Employment contract, Rental agreement, User contract, and Purchase contract were already added.
...
In order to display a pick lists list of pre-defined elements in metadata forms of your client, the corresponding property definitions have to be classified as dynamic catalogs. They can be global or tenant-specific. The dynamic catalogs can be configured to be editable or not editable for client users.
...