| Page Properties | ||||||
|---|---|---|---|---|---|---|
| Status
| status
| ||||
| colour | Yellow | |||||
| title | progress | |||||
| Priority | 2.3 | |||||
| Note | new tool | |||||
| Assignee | Martin | Inga |
| Product Version | |
|---|---|
| Report Note | |
| Assignee |
Resources & Remarks
- yuuvis® RAD management studio
- designer / schema und role sets / client localization and forms / scripts...
- Oct 2020: Inga reviewed the texts to enable release 2.3
Modification History
| Name |
|---|
| Excerpt |
|---|
As of version yuuvis® Momentum - Version 2.3 (Autumn 2020) - the yuuvis® architect will make you much more effective in modeling client-side forms including scripting for each object type that has been defined in a deployed schema. |
Introduction
...
|
| Excerpt |
|---|
yuuvis® architect makes a client administrator much more efficient in managing settings and users by means of a graphical user interface. |
| Section | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
yuuvis® architect provides a support tool with a graphical user interface for client administrators. Based on the framework library, metadata forms of their client's graphical user interface can be modeled. Furthermore, users can be added or removed from the respective tenant and language settings can be customized.
After installing the client services the , yuuvis® architect can be accessed via the following URL: https://<domain>/architect.
| Info |
|---|
Administrators need the YUUVIS_TENANT_ADMIN role for maintaining object types of the tenant (tenant-specific schema) or YUUVIS_SYSTEM_INTEGRATOR role for maintaining object types of the system (system-schema) including applications (app-schemas). >> Permissions via Roles |
Contents
| Table of Contents |
|---|
Prerequisites
The object types that should be used within the yuuvis® client need some necessities that are described here: Defining Object Types for yuuvis® client
Settings
You can change the language and theme in the settings view. The set language is also used for the form preview that is described below.
Modeling Forms
After logging into the architect you see the dashboard with one tile in the middle. A click onto this tile opens the forms modeling view with a tree that helps to navigate through the object types.
Object Type Selection
Picture: Tree of object types
Administrators with the role YUUVIS_SYSTEM_INTEGRATOR are offered the nodes 'Application', 'System', and 'Secondary Object Type'.
A click onto 'Application' shows further nodes grouping object types by its localized app-Schema name (for localizations see here: Defining Object Types for yuuvis® client).
A click onto 'System' lists all OTs and FSOTs that are part of the system schema.
Administrators with the role YUUVIS_TENANT_ADMINISTRATOR are offered the nodes 'Tenant' and 'Secondary Object Type'.
A click onto 'Secondary Object Type' show all FSOTs that are referenced with "static" = false and that are not classified as primary or required.
A click onto 'Tenent' shows a list of all object types that are part of the tenant schema.
For each object type you can open the form for the EDIT or CREATE situation.
The CREATE form is offered to the client during the creation steps. The EDIT form is offered for changing the metadata for a saved object.
Forms consist of a form model with arranged groups of fields and optionally a script for manipulating field values. For form scripting, read this documentation: Form Scripting (Client-side)
Picture: Forms modeling view
After clicking onto EDIT or CREATE and no model has been saved before you see a list of all object type fields in the left area and a somewhat empty model tree beside. In the case, you have saved a model for EDIT but not for CREATE you are asked whether to reuse the EDIT model for CREATE as well while opening it.
You can export your model as JSON-file and import such. During import, the file is validated and specific errors are reported.
List of Object Type Fields
Depending on the object type you get the following fields to be used in a form
...
Object Type
...
Fields that offered
...
Object Type
...
Extendable Floating Secondary Object Type
...
All fields that are directly referenced, and all fields of the OT that references this PFSOT, and all fields of the Required Floating Secondary Object Type (RFSOT) that are referenced from this OT as well.
The EFSOTs that are referenced from the OT are not part of the list.
Arranging Fields in a Form
You can arrange the form fields using drag and drop to design groups and compositions of fields.
Click the 'x' to delete unwanted compositions, groups, and fields from the form.
Like fields, groups and compositions can be dragged and dropped within a form or copied to another form.
By default, form layouts are organized into a Core Area for the most important index data and a Data Area. This layout structure is optional. You may only use the Core Area. Later in time the Data Area should be used for grouping the metadata within the summary aspect of the object details in the client.
All areas and groups can be collapsed or expanded for a better overview.
Groups combine fields and group them visually. Fields whose contents are related are logically combined (e.g., a person’s name, contact details, and postal address, etc.) in an address book entry.
- In the Core Area of the form, fields are visually combined into groups with a color background and layout.
- In the Data Area, groups are shown as tabs like they are in compositions.
Elements within a group are arranged vertically by default. Elements within a group can also be arranged horizontally. For example, you can arrange a person’s first and last name next to each other in the first row in an address book entry and place the contact details below this as an entire line in a block.
You can give groups a technical name that can be localized in the same way as the technical names for object types and fields can be. Therefore, the naming has to follow the same rules.
Compositions combine several groups. Groups combined via compositions are shown as tabs within the composition area. Groups in compositions logically get a label, which is shown as tabs of the tabs.
The extended area functions automatically like a composition area and displays groups as tabs. No form fields can be arranged here outside of groups.
yuuvis® makes it possible to assign situation-specific scripts to forms. You can open a script editor that lets you edit a script for the current form.
There are various editing features available to help you create the script in the ribbon on the SCRIPT context tab and in the context menu of the script area. In addition, IntelliSense is available as scripting support.
...
yuuvis® architect works with the default roles.
First Steps in yuuvis® architect
The yuuvis® architect dashboard shows the most important application information at a glance.
Rights Provided via Roles
Rights management in yuuvis® Momentum client and yuuvis® architect is role-based.
Depending on the description of the position and tasks, employees work with different data, functions, and applications. User rights for access to data, functions, and applications in accordance with the employees’ fields of duties and responsibility are grouped into roles in yuuvis®. In this way, users with the same fields of duties and responsibility also have the same rights in the system.
Users can view the roles assigned to them via their settings.
Definition of Object Types
Any business object handled in your client has an object type. The available object types are defined in the yuuvis® Momentum schema as document, folder or secondary object type. This article gives an introduction into the basics of the yuuvis® Momentum schema and the particularities for yuuvis® Momentum client and yuuvis® architect.
>> Object Types
Customizing Language Settings
The Localization tile is available on the dashboard for users with the YUUVIS_TENANT_ADMIN or YUUVIS_SYSTEM_INTEGRATOR roles.
In your client, forms are used to present the properties of your business objects. yuuvis® architect allows you to customize the labels of the individual property fields in the forms, the filters and the columns for hit lists.
>> Localization
Modeling Forms for the Presentation of Objects
The Form Modeling tile is available on the dashboard for users with the YUUVIS_TENANT_ADMIN or YUUVIS_SYSTEM_INTEGRATOR roles.
You can model the Metadata aspect area in CREATE and EDIT forms that are offered in your client to view and edit metadata. It also possible to combine the form modeling with situation-specific scripts. To check the current layout during modeling, yuuvis® architect provides a form preview presenting the modeled metadata form as it will appear in your client.
Managing Users of a Tenant
Users with the YUUVIS_MANAGE_SETTINGS or YUUVIS_TENANT_ADMIN or YUUVIS_SYSTEM_INTEGRATOR roles see the User management tile on the dashboard.
This view of yuuvis® architect provides a graphical interface for administrative users in order to manage users belonging to their tenant. Individual users can be edited or deleted and users can be added. New users will be invited via e-mail to set up their passwords.
The functionality is provided by the admin endpoints of the Tenant Management API.
Maintaining Catalogs
Pick lists with pre-defined entries can be used in the forms for the properties of your business objects in your client. Those pick lists are provided by so-called dynamic catalogs of the Web-API Gateway. Thus, yuuvis® architect allows you to create and modify dynamic catalogs leading to changes in the pick lists displayed in your client.
Defining Properties and Object Types
As of 2022 Summer, 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. 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.
Business Processes and Tasks
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
The Process management (BPM) tile is available on the dashboard for users with the YUUVIS_TENANT_ADMIN role.
| Info | |||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
Read on
|