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
This pre-documentation is targeting administrators who are responsible for setting up scenarios and use cases in the yuuvis® reference client. 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, yuuvis® architect will offer more features for setting up a system, like modeling schemas, rolesets, localizations, and whatever will help you in your daily work.
After installing the client services, yuuvis® architect can be accessed via the following URL: https://<domain>/architect.
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
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.
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.
"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)
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 | Short | Fields that offered |
|---|---|---|
Object Type | OT | All fields that are directly referenced and those fields that are part of a statically referenced SOT. |
Extendable Floating Secondary Object Type | EFSOT | All fields that are directly referenced. |
| Primary Floating Secondary Object Type | PFSOT | 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
You can open a form preview which 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.