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

This pre-documentation is targeting administrators that are responsible for setting up scenarios and use cases in the reference client of yuuvis®.  Our new yuuvis® architect tool starts off with modeling client-side forms including scripting for each object type that has been defined in a deployed schema. In later versions, the yuuvis® architect will offer more features for setting up a system, like modeling schemas, rolesets, localizations, and what so ever will help you in your daily work.

After installing the client services the yuuvis® architect can be accessed via the following URL: https://<domain>/architect.

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

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.

Group

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. 

Composition

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 preview

You can open a form preview. The form preview provides a visual aid when you are designing and laying out your form. This preview allows debugging the form via the browser tools as well. Only the scope.data cannot be handled well because no object is touched.