Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue


Status

Status
colourBlue
titlereview

Priority2.3
NoteNew tool - needs more detailed description later on
AssigneeMartin | Inga => Agnieszka

Ressources

  • 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) - the yuuvis® : yuuvis® architect will make you much more effective efficient in modeling client-side forms including scripting for each object type that has been defined in a deployed schema.

...

This pre-documentation is targeting administrators that who are responsible for setting up scenarios and use cases in the yuuvis® 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 whatever 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.

...

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

...

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

Note that the language set language is also used for the form preview.

Modeling Forms

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

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 its their localized app -Schema schema name (for info information on localization check out , please refer to the "Defining Object Types for yuuvis® client" article).
  • System - a click lists all Object object types and floating secondary object types that are part of the system schema.
  • Secondary Object TypType

Administrators with the role YUUVIS_TENANT_ADMINISTRATOR are offered the nodes

...

  • CREATE form - used during the creation steps
  • EDIT form - used for changing 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 besidenext 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 suchit. 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 Type 

Depending on the object type you get the following fields object types to be used in a form

Object Type

Short

Fields that offered

Object Type

OTAll fields that are directly referenced and those fields that are part of a statically referenced SOT.

Extendable Floating Secondary Object Type

EFSOTAll fields that are directly referenced.
Primary Floating Secondary Object TypePFSOT

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.

...

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 the in  yuuvis® 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.

...

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

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.

...

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)

Anchor
architect_formPreview
architect_formPreview

...