Resources Links, Pictures, whatever Modification History
|
Define properties and object types in a global, app-specific or tenant-specific schema via a graphical user interface. |
As of yuuvis® Momentum release 2022 Summer, the Schema management is available as a beta version. |
|
The Schema management tile is available on the dashboard for users with the YUUVIS_TENANT_ADMIN or YUUVIS_SYSTEM_INTEGRATOR roles.
You can use this graphical user interface provided by yuuvis® architect to define object types and their properties for the business objects in your client application. The object types and properties are defined in schema structures.
>> Object Types
Depending on the roles assigned to the currently logged-in user, it is possible to manage the global schema, app schemata and/or tenant schemata as described below.
The schema management provided by yuuvis® architect uses the corresponding endpoints provided by the Core API and the Web-API Gateway.
The structure of the metadata forms that present the properties of your business objects in your client can be customized by means of the Form Modeling view of yuuvis® architect.
Before you start working on your schemata, it is important to define how the available types of schemata as well as properties and object types will best depict your business use case. Especially as a system integrator with access to the global schema as well as to all tenant and app schemata, you are responsible for the creation and management of a complex configuration with multiple schemata that can refer to each other. With this definition in mind, you can create and edit your schemata. |
Select the schema file you want to read or edit from the Schema selection list on the left side of the Schema management view of yuuvis® architect. Depending on your role, you have read and/or edit permissions:
Icon | Scope | Required Role for Read Access | Required Role for Edit Actions |
---|---|---|---|
system | YUUVIS_SYSTEM_INTEGRATOR or YUUVIS_TENANT_ADMIN | YUUVIS_SYSTEM_INTEGRATOR | |
app | YUUVIS_SYSTEM_INTEGRATOR or YUUVIS_TENANT_ADMIN | YUUVIS_SYSTEM_INTEGRATOR | |
tenant | YUUVIS_SYSTEM_INTEGRATOR or YUUVIS_TENANT_ADMIN | YUUVIS_SYSTEM_INTEGRATOR or YUUVIS_TENANT_ADMIN |
The namespace of the individual schemata indicates their concrete scope: either the entire system, a specific app or a specific tenant.
Note: To create a new app schema, use the endpoint POST /api/system/apps/{app}/schema.
As of 2022 Autumn, a new app schema can be created via the + Plus icon in the top bar of the Schema selection list.
Import an external XML file from a local directory by clicking Import in the bottom left corner.
Classifications can be set for object types and properties in their definition. All available classifications that trigger a specific behavior in a library-based client are described here:
>> Defining Object Types for a Library-based Client
Furthermore, it is possible to specify one or more custom classifications. If you specify a custom classification value, do not use the semicolon character as it is internally used as separator.
yuuvis® architect offers two different display modes.
Click the Model and XML buttons on the top right to toggle between the two views.
After selecting a schema file, the scope of the schema (the tenant name, the app name or system) is displayed in the header of the left side bar. Below, you can switch between the two tabs Object types and Metadata to display the IDs of object types or metadata definitions that are part of the selected schema file. The object type IDs are grouped by base type (Document, Folder, and Secondary (extensions)) whereas the metadata IDs are grouped by metadata type (e.g., DateTime, Integer, String, ...).
If no draft is available for the selected schema file, you can either copy the schema version currently used by yuuvis® Momentum or start with an empty schema file to create a new draft.
After selecting a schema file, the two views DEPLOYED Schema and DRAFT Schema are displayed. Both of them present a schema in its XML structure as described in the following articles:
>> Schema - Defining Object Types
>> Defining Object Types for a Library-based Client
By clicking the arrows in the right sidebar, you can compare the deployed and draft schemata in the Schema Diff view.
The current version of the selected schema file is displayed. This version is currently used by yuuvis® Momentum. Editing is not possible.
Click Export to save a local copy of the displayed XML file.
This view displays the draft version for the selected schema file. You can edit and save it to continue your work at a later time.
Click Import to load an XML file from a local directory.
Click Export to save a local copy of the displayed XML file.
The deployed schema on the left is compared to the draft schema on the right. Differences are highlighted.
Via Validate, it is possible to check whether your draft fulfills all requirements for a valid schema.
Click Deploy to replace the schema version currently used by yuuvis® Momentum by your draft schema. The draft is automatically validated. Thus, the process can only be successful if your draft is valid.
Click Save draft to store your current working status. The draft is not validated.
Schema management via yuuvis® architect supports administrators who are responsible for the creation of object types with a graphical user interface. Schema files containing the property and object type definitions can be edited by means of configuration forms or in their original XML structure.
Read on
|