Resources & Remarks

• yuuvis® RAD management studio

Remarks

• designer  / schema und role sets / client localization and forms / scripts...
• Oct 2020: Inga reviewed the texts to enable release 2.3

Excerpt
As of version yuuvis® Momentum Version 2.3 (Autumn 2020): yuuvis® architect will make you much more efficient in modeling client-side forms including scripting for each object type that has been defined in a deployed schema.

Introduction

...

Modification History Name Date Product Version Action Antje 08 FEB 2021 2.4 New page properties macro. Antje 05 MAR 2021 2020 Winter Content replaced by new version. Antje 19 MAY 2022 2022 Summer Schema management added. Antje 24 NOV 2022  2022 Winter add process management

Excerpt
yuuvis® architect makes a client administrator much more efficient in managing settings and users by means of a graphical user interface.

Section
border true
Column Table of Contents Table of Contents exclude (Table of Contents|Read on|Custom Client Build with Libraries|Dashboard and Menus|yuuvis® client as reference implementation|yuuvis® management console)

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, 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

...

border	true

Column
Table of Contents Table of Contents exclude (Table of Contents)

Requirements

The object types that should be available for users within yuuvis® client need some necessities. Please check, whether your object type definitions are ready: "Defining Object Types for yuuvis® client" article.

Settings

In the Settings view you can change the Language and Layout.

Info
title Note that the set language is also used for the form preview that is described below.
Note that the language set is also used for the form preview.

Modeling Forms

After logging in to yuuvis® architect, the Dashboard with the "Forms" tile in the middle is displayed. 

Click the "Forms" tile to open the Forms view for modeling. A tree helps you to navigate through all existing object types in the "Select object type" area.

Image Removed

"Select object type" Area

Administrators with the role YUUVIS_SYSTEM_INTEGRATOR are offered the nodes

• Application - a click shows further nodes grouping object types by their localized app schema name (for information on localization, please refer to the "Defining Object Types for yuuvis® client" article).
• System - a click lists all object types and floating secondary object types that are part of the system schema.
• Secondary Object Type (beginning with version 2.4: Extending types)

Administrators with the role YUUVIS_TENANT_ADMINISTRATOR are offered the nodes

• Tenant - a click shows a list of all object types that are part of the tenant schema.
• Secondary Object Type - a click shows all floating secondary object types that are referenced in the schema ("static" = false) and that are not classified as primary or required and that are used to extend objects with more metadata.

For each object type you can define two form types - EDIT and CREATE. The corresponding form is provided to the user in the yuuvis® client accordingly.

• CREATE form - used during the creation steps
• EDIT form - used for modifying the metadata of a saved object

In general, forms consist of a form model with arranged groups of fields and optionally a script for manipulating field values.

>> Form Scripting (Client-side)

Image Removed

After clicking EDIT or CREATE and no model has been saved before, you see a list of all object type fields in the left-hand area and a somewhat empty model tree next to that. 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 a JSON file and import it. During import, the file is validated and specific errors are reported.

Field Properties

After the click onto a field in the 'Model tree' or 'Layout' area, an additional 'Properties' area is opened on the right-hand side. A field can be set to read-only. For fields of type 'string', the number of rows can be set up.

Beginning with version 2.4 tables are supported as well. The columns of a table can be configured within the properties area.

Available Object Types 

Depending on the object type you get the following object types 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 '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 metadata 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  yuuvis® client.

All areas and groups can be collapsed or expanded for a better overview.

Groups

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 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

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.

Scripts

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.

>> Form Scripting (Client-side)

...

Form preview

...

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.

>> Dashboard and Menus

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.

>> Rights and Roles

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.

>> Form Modeling

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.

>> User Management

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.

>> Catalog Management

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.

>> Schema Management

Business Processes and Tasks

Insert excerpt
Process Management (BPM) Process Management (BPM) nopanel true

The Process management (BPM) tile is available on the dashboard for users with the YUUVIS_TENANT_ADMIN role.

>> Process Management (BPM)

Info
icon false
Read on Section Column width 25% Dashboard and Menus Insert excerpt Dashboard and Menus Dashboard and Menus nopanel true  Keep reading Column width 25% Custom Client Build with Libraries Insert excerpt Custom Client Build with Libraries Custom Client Build with Libraries nopanel true  Keep reading Column width 25% yuuvis® management console Insert excerpt yuuvis® management console yuuvis® management console nopanel true  Keep reading