Versions Compared

Key

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

...

Code Block
languagexml
firstline6
linenumberstrue
<classification>dynamic:catalog[tenMytenant:contracts,readonly]</classification>

Thus, the pick-list will not be editable in the client or via the admin-contoller of the Web-API gateway.

Editing via Client

Users with the role YUUVIS_MANAGE_SETTINGS can maintain this list. The following actions are supported:

...

  • The list elements from the catalog are read with the GET endpoint https://<domain>/api-web/dms/catalogs/tenMytenant:contracts.
  • If the catalog does not exist it is created with the POST endpoint https://<domain>/api-web/dms/catalogs/tenMytenant:contracts.
  • If the catalog does exist changes of its list elements are saved with the PATCH endpoint https://<domain>/api-web/dms/catalogs/tenMytenant:contracts.

Editing via admin-controller of Web-API Gateway

Users with the role YUUVIS_TENANT_ADMIN are offered the same maintenance actions via the Web-API Gateway GET, POST and PATCH endpoints: https://<domain>/api-web/admin/catalogs/tenMytenant:contracts of the admin-controller.

...

There is a Swagger-UI that supports you in using the mentioned endpoints: https://<domain>/api-web/swagger-ui.html. The screenshot below displays a part of the Web-API Gateway Swagger-UI showing the first endpoints of the admin-controller.

Global Dynamic Catalogs used by all Tenants

Read-only Global Catalogs

In this case, your tenants should use object types that are configured in a system or app schema and should use only standard values an administrator . Users with the role YUUVIS_SYSTEM_INTEGRATOR can set up global catalogs with initial standard elements and set the catalogs readonly

Recommendation: In an app - schema, use the prefix of the application for your catalog name as given here:

Code Block
languagexml
titleSchema excerpt example of a field of type string of classification dynamic catalog
	<propertyStringDefinition>
		<id>contract</id>
		<propertyType>string</propertyType>
		<cardinality>single</cardinality>
		<required>false</required>
        <classification>dynamic:catalog[appMyapplication:contracts,readonly]</classification>
	</propertyStringDefinition>

Recommendation: In the system - schema, use no perfix prefix for your catalog name as given here:

Code Block
languagexml
titleSchema excerpt example of a field of type string of classification dynamic catalog
	<propertyStringDefinition>
		<id>contract</id>
		<propertyType>string</propertyType>
		<cardinality>single</cardinality>
		<required>false</required>
        <classification>dynamic:catalog[contracts,readonly]</classification>
	</propertyStringDefinition>

In this case the Web-API Gateway system-controller endpoints GET and POST are used.

  • For the catalog contracts in the system - schema: https://<domain>/api-web/system/catalogs/contracts
  • For the catalog contracts in the app - schema businesspartner: https https://<domain>/api-web/system/catalogs/appMyapplication:contracts?appschemaname=appMyapplication

Global catalogs without an appschemaname are saved in the config-service beside the system - schema configuration. Otherwise, the catalogs are saved besides the app - schema configurations.

The Web-API Gateway GET endpoint that the client calls checks first whether a tenant-specific copy of the global catalog does exist. If not the global catalog is read.

Editable

...

Global Catalogs

If the catalog parameter readonly is not set users with the role YUUVIS_MANAGE_SETTINGS can change the list elements. With the first update of such a catalog, a new catalog with the same technical name is saved for that tenant.

...