Apps
Management of apps that are based on yuuvis® Momentum via schema, permissions and availability configurations.
Table of Contents
Introduction
The yuuvis® Momentum core system can be used as basis for apps. Apps are additional logical units that enhance the core system. The core system itself provides the possibility to define specific configurations for the individual apps. Thus, each app can have its own schema and its own role set. There are endpoints provided by the API gateway that allow for retrieval, validation or update of the configuration files.
The system can support various apps.
App Management
The endpoints for the management of app-specific configuration files are provided by the API gateway and call the SYSTEM Service internally.
App names are case-insensitive. Furthermore, the system stores uppercase letters in app names in a lowercase form. For example, if you post an app schema for the app name myNewApp
(via POST /system/apps/myNewApp/schema
), this new app appears with the name mynewapp
in the results of endpoints like GET /api/dms/apps
or GET /api/system/apps
.
Additionally, app names have to match the regular expression [a-z0-9]* in order to be consistent with the schema validation of app-specific prefixes.
App Schemata
App-specific schemata are managed via the following endpoints:
- GET /api/system/apps/{app}/schema
- POST /api/system/apps/{app}/schema
- POST api/system/apps/{app}/schema/validate
In the multi-tenant landscape of yuuvis® Momentum, any object types or properties that need to be available for multiple or all tenants, need to be introduced to the system schema. To prevent cluttering the system schema, avoid dependencies and allow for duplicate names, the system schema can be structured into applications, which provide a namespace for properties and object types pertaining to a particular use case.
>> Schema - Defining Object Types
Role Sets for Apps
App-specific role sets are managed via the following endpoints:
- GET /api/system/apps/{app}/permissions
- POST /api/system/apps/{app}/permissions
- POST /api/system/apps/{app}/permissions/validate
The permissions to access objects or to perform certain actions are assigned to specific roles that are listed in the role set. yuuvis® Momentum has the ability to further structure the global role set into applications.
>> Access Authorization and Permissions
Summary
Apps based on yuuvis® Momentum can be provided with their own schema and role set for individual configuration.