yuuvis® client as reference implementation

yuuvis® client is a reference implementation, browser-based working environment for the daily work with the yuuvis® Momentum system. The client enables the work with documents and metadata (Document Management System) and provides a basis for further modeled business applications.

Table of Contents

Introduction

yuuvis® Momentum is a state-of-the-art tool for building content and information management solutions that supports a wide range of applications: from on-premises to private or public clouds and hybrid scenarios. The same native cloud technology is used everywhere.

yuuvis® Momentum client requires no installation and can be used on any workstation where a connection to the yuuvis® Momentum server can be established and where an up-to-date browser is available. It runs on stationary computers or notebooks with a Windows operating system as well as on mobile devices such as tablets or smartphones with an Android operating system.

This client is built as a reference implementation based on the published core and framework library. How to build your own client with the help of these libraries is documented here: Custom Client Build with Libraries


Roles for Users and Administrators

The following roles can be assigned to users of the yuuvis® client in order to manage their permissions. Also in the yuuvis® architect, these roles may have an impact on the availability of different functions.

RolePermissions in yuuvis® client as reference implementationPermissions in yuuvis® architect
YUUVIS_DEFAULTThe user has full access to all objects.no impact
YUUVIS_CREATE_OBJECTThe user is allowed to create objects. In the graphical user interface, a + symbol is shown in the yuuvis® Momentum bar.no impact
YUUVIS_MANAGE_SETTINGSThe user is allowed to customize the global standard configurations for hit lists and filters in the settings menu. Those standards will be the default settings for (new) users that didn't save their own user-specific standard configurations so far.no impact
YUUVIS_SYSTEM_INTEGRATORAdministrative object information is provided for the user in the metadata sheets of any object in the system.

The user can modify metadata forms for any object type defined in the global system schema or in an app-specific schema.

As of version 2020 Winter: The user can add or delete users of the own tenant and assign roles to them.

As of version 2020 Winter: The user can customize the language settings for the own tenant.

YUUVIS_TENANT_ADMINAdministrative object information is provided for the user in the metadata sheets of any object in the system.

The user can modify metadata forms for any object type defined in the tenant-specific schema.

As of version 2020 Winter: The user can add or delete users of the own tenant and assign roles to them.

As of version 2020 Winter: The user can customize the language settings for the own tenant.


The roles listed above are defined in a role set provided for yuuvis® Momentum client and yuuvis® architect. The core system of yuuvis® Momentum allows for the definition of custom role sets as well. But be aware that you will not be able to use yuuvis® architect or yuuvis® Momentum client. Instead, you can build your own custom client.
>> Access Authorization and Permissions

Manage Languages and Settings via Configuration Files

Use a custom configuration file to make settings for yuuvis® client as reference implementation.

Beginning with version 2020 Winter, the main settings for yuuvis® client as reference implementation can be customized for each tenant by users with the YUUVIS_SYSTEM_INTEGRATOR role. This article describes how you can use a custom configuration file to make settings for the reference client that are not changed when updating yuuvis® Momentum. An update can overwrite the default configuration file.

Note: After making changes, users must clear the browser cache and press F5 to reload the reference client.

Customizing the Main Configuration

With the installation of yuuvis® client as reference implementation, the default values for the main configuration of the settings are provided in the main.json file.

Users with the YUUVIS_SYSTEM_INTEGRATOR role can download the main.json file, modify it and upload it again in order to apply the new values for the main configuration. The settings will be applied to all users of the users' tenant.

To customize the main configuration, follow these steps:

  • Log in to the reference client as a user with the YUUVIS_SYSTEM_INTEGRATOR role.
  • Open the settings view and find the Main configuration entry in the Configuration section.
  • Click Export standard in order to download the default main.json file.
  • Modify the main.json file as described below.
  • Click Import and select your modified main.json file for upload.
  • Refresh the reference client in your browser. The user-customized settings will be applied.
  • Click Export in order to download the applied user-customized main.json file.

The following code block shows the default main.json file defining the main configuration of the reference client after installation. In order to customize the main configuration, follow the steps above to download this default main.json file. You can now modify the file and upload it afterwards. The individual parameters and their possible values are listed and described in the table below.

Settings in the main.json
{
    "core": {
        "apiBase": {
            "core": "/api",
            "api-web": "/api-web",
            "custom": "/custom"
        } ,
        "languages": [
            {
                "iso": "de",
                "label": "Deutsch"
            },
            {
                "iso": "en",
                "label": "English",
                "fallback": true
            } 
        ],
        "logging": {
            "level": "debug"     
        } 
    },
    "client": {
        "objectDetailsTabs": ["indexdata","preview", "history","summary"],
        "docu": 
        {
            "link": "https://help.optimal-systems.com/yuuvis/client/v23/user/###userLang###/index.html",
            "version": 23,
            "language": ["de", "en"]
        } 
    }
}

Recommendation: Configure only those paremeters in your custom main.json that differ from the standard ones to reduce possible issues when updating the system.

Parameters in the main.json file:

SectionSub-Section / KeyKey

Example Value

Description 
core





apiBase

core/api

Do not change these settings!

These values are required for the connection to yuuvis® Momentum core and client services.

api-web/api-web
custom/custom
languages

isoen

This is the list of languages from which the users can choose in the reference client. Each list entry contains:

  • the internal indifier string iso,
  • the string label shown in the reference client to identify the language and
  • the boolean fallback deciding if the language is used for the first-time login of a new user.

Only one language in the list can have the value true for fallback.



labelEnglish
fallbacktrue
loggingleveldebug

Logging levels:

  • debug logs all issues
  • error logs only errors
  • warn logs only errors and warnings
  • info logs errors, warnings and infos
  • otherwise logs are disabled
client

objectDetailsTabs
["indexdata","preview", "history","summary"]

This list defines which aspect areas will be displayed in the reference client.

Per default, all four aspect areas are referenced in the list and thus displayed in the reference client. By removing one of them from the list, you disable the display of the corresponding aspect area.

doculink

any valid URL, optionally containing the placeholder ###userLang###

default: https://help.optimal-systems.com/yuuvis/client/v23/user/###userLang###/index.html

The given URL is called via the Documentation link provided in the About yuuvis® client menu item accessible via the main menu.
language["en","de"]List of internal language indentifiers (iso) in which the documentation portal is available. Depending on the language set in the reference client, the corresponding iso value is used in the URL instead of the placeholder ###userLang###.

Configuring Additional Client Languages

yuuvis® client as reference implementation is provided by default with German and English as the application languages. However, the client can be extended with custom language files.

Users with the YUUVIS_SYSTEM_INTEGRATOR role can download the <iso>.json file for any language, modify it and upload it again in order to apply the new values for the language configuration. The settings will be applied to all users of the users' tenant. You may change the keys on your own responsibility, but be aware that the standard documentation will not be available in your custom language.

To customize a language configuration, follow these steps:

  • Log in to the reference client as a user with the YUUVIS_SYSTEM_INTEGRATOR role.
  • Open the settings view and find the Main configuration entry in the Configuration section.
  • Click Export standard in order to download the default main.json file.
  • Open the main.json file and add the iso and label for your custom language in the languages section.
  • Open the settings view and find the Language entries in the Configuration section.
  • Click Export default in the corresponding row in order to download the default de.json or en.json file.
  • Open the file locally, modify the values for the labels according to your language and save the file as <iso>.json with the iso code of your custom language.
  • In the reference client, Import the modified main.json file with the additional custom language.
  • Refresh the reference client in your browser. The custom language will appear in the settings view under Configuration.
  • Click Import and select your custom language configuration file <iso>.json.


Read on

yuuvis® architect

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

Custom Client Build with Libraries

Documentation of the client core and framework libraries, as usable for custom client development. Keep reading

Form Scripting (Client-side)

If you configure custom forms for objects, you can additionally use executable scripts to, e.g., validate data, change data, change field properties - such as "read-only" or "mandatory" - and show context-related messages. Form-related scripts enhance your options by adding further functionalities to support your use cases and processes the best.  Keep reading