Versions Compared

Key

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

...

If only one specific tenant will use a dynamic catalog, it is recommended to configure this catalog as a tenant-specific property. Its technical name should follow the naming convention ten<tenantname>:<catalogname>. A user with access to the Admin Endpoints and admin-controller Endpoints (default: user with the YUUVIS_TENANT_ADMIN role) is required.

The catalog values are saved in the config server beside the tenant schema configuration.

...

Also global dynamic catalogs can be defined to be editable for users with the role the advancedUserRole (default: users with the YUUVIS_MANAGE_SETTINGS role). If the modified catalog values are saved, a tenant-specific copy of the global JSON configuration is saved besides the tenant schema together with the values of tenant-specific catalogs. Whenever a global catalog is retrieved via the Web-API gateway, the tenant-specific copy will be returned for that tenant. If no tenant-specific copy exists, the global configuration is returned. This might happen if the global catalog is not editable or no changes were applied to the global catalog within the active tenant.

Not-Editable Global Catalogs

Users with the Users user with access to the System Endpoints and system-controller Endpoints (default: users with the YUUVIS_SYSTEM_INTEGRATOR role) can set up global catalogs with initial standard elements and set the catalogs to readonly.

...

The following code block shows an example property definition cut from an example app schema. If the example schema is uploaded as an app schema via the the POST /api/system/apps/{app}/schema endpoint for the example app myapplication, the property contract will not only be available for the specific app myapplication, but to all tenants using this app. After restarting your client, the users will get an empty selection list for the field called appMyapplication:contracts.

...

If the catalog parameter readonly is not set, users with the advancedUserRole (default: users with the YUUVIS_MANAGE_SETTINGS role) can change the list elements in your client. With the first update of such a catalog, a new catalog with the same technical name (without additional tenant-specific prefix) is saved for that tenant.

Note: Changes of the global catalog saved by a user with the YUUVIS_SYSTEM_INTEGRATOR role via system-controller do not affect the copy.

Editing Catalog Values

...

  • Create a new list element.
  • Remove a list element. A warning is given if this element is used by an object.
  • Disable a list element. Such elements are offered for search but not while creating or editing an object.

Editing via Client

Users Users with the advancedUserRole (default: users with the YUUVIS_MANAGE_SETTINGS role) can maintain pick lists that are based on a property classified as a dynamic catalog without the readonly parameter.

...

Editing via Web-API Gateway

admin-controller

Users with the Users with access to the admin-controller Endpoints (default: user with the YUUVIS_TENANT_ADMIN role) are offered the maintenance actions also in read-only catalogs via the Web-API Gateway GET and POST endpoints https://<domain>/api-web/admin/catalogs/tenMytenant:contracts of the admin-controller.

The following example shows a tenant-specific list of four elements stored for the tenant Mytenantmytenant:

Code Block
languagejs
titleExample for a tenant-specific dynamic catalog
{
  "tenant": "Mytenant",
  "readonly" true,
  "entries": [
    {
      "name": "Employment contract",
      "disabled": false
    },
    {
      "name": "Rental agreement",
      "disabled": false
    },
    {
      "name": "User contract",
      "disabled": false
    },
    {
      "name": "Purchase contract",
      "disabled": false
    }
  ]
}

...

In case of global catalogs, the Web-API Gateway system-controller endpoints GET and POST are used. The In the default configuration, the role YUUVIS_SYSTEM_INTEGRATOR is required.

...

The client uses the Web-API Gateway dms-controller endpoints that require per default the YUUVIS_MANAGE_SETTINGS role in case of POST and PATCH requests: 

...