Manage the main configuration of a library-based client application via a configuration file.

Table of Contents

Introduction

Users with access to the admin-controller endpoints of the Web-API Gateway (default: users with the YUUVIS_TENANT_ADMIN role) can download the main.json file, modify it and upload it again in order to apply new values to the main configuration. The settings will be applied to the users' tenant.

'`main.json`' Configuration File

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

To customize the main configuration, follow these steps:

Retrieve the currently applied main.json file via the Web-API Gateway endpoints GET /api-web/api/admin/resources/config/{name} or GET /api-web/api/resources/config/{name} with main-config as value for the name path parameter.
Modify the main.json file as described below.
Import the modified main.json file via the Web-API Gateway endpoint POST /api-web/api/admin/resources/config/{name} again with main-config as value for the name path parameter.
Refresh the client in your browser. The new settings will be applied.

The following code block shows the default main.json file defining the main configuration after installation. 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/api",
      "predict": "/predict-api",
      "viewer": "/viewer",
      "logout": "/logout",
      "oauth": "/oauth"
    },
    "languages": [
      {
        "iso": "de",
        "label": "Deutsch"
      },
      {
        "iso": "en",
        "label": "English",
        "fallback": true
      }
    ],
    "logging": {
      "level": "debug"
    }
  }  
}

Note: We recommend to configure only those parameters in your tentant-specific main.json that differ from the standard ones to reduce possible issues when updating the system.

Parameters in the main.json file

Section	Sub-Section / Key	Key	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`	`iso`	`en`	This is the list of languages from which the users can choose in the reference client. Each list entry contains: the internal identification 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`. For several languages, the specific date, time and number formats are automatically used. >> Localization for Clients
		`label`	`English`
		`fallback`	`true`
	`logging`	`level`	`debug`	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
	`permissions` (as of 2022 Spring)	`advancedUserRole`	`YUUVIS_SYSTEM_INTEGRATOR YUUVIS_TENANT_ADMIN`(default)	Name of the role that enables the display of the following administrative information which are hidden for other users: In object views: tags that are not specified in the object type definition history entries corresponding to a `read` action In the BPM processes list My processes: all BPM process variables
		`retentionManagerRole`	`YUUVIS_MANAGE_SETTINGS` (default)	Name of the role that enables to modify the standard configurations of filters and hit lists. The configurations will be applied to all users within the tenant.
		`manageSettingsRole` (as of 2022 Summer)	`YUUVIS_MANAGE_SETTINGS` (default)	Name of the role that enables the retention management view and allows to set or extend the expiration date for individual document objects.
	`clientdefaults` (as of 2022 Spring)	`titleProperty`	`appClient:clienttitle` (default)	ID of an existing property that is referenced in all document or folder object type definitions (either directly or via SOT). This property will correspond to the Name field in the client that is available for all object types.
	`clientdefaults` (as of 2022 Spring)	`descriptionProperty`	`appClient:clientdescription` (default)	ID of an existing property that is referenced in all document or folder object type definitions (either directly or via SOT). This property will correspond to the Description field in the client that is available for all object types.
	`app` (as of 2022 Summer)	`inboxPageSize`	`100` (default)	Maximum number of tasks per page in the client's Inbox view.
	`app` (as of 2022 Summer)	`processesPageSize`	`100` (default)	Maximum number of processes per page in the client's My follow-ups and My processes views.
	features (as of 2022 Winter)	`dashboardWorkspaces`	`false` (default)	Enable (`true`) or disable (`false`) the possibility for users to individually customize their dashboard.
	`gridOptions?` (as of 2023 Spring)			Configuration for the hit list grid that will be used as default for client users who did not save their own hit list configuration.
		rowHeight	`50` (default)	Row height in pixel.
		pageSize	`70` (default)	Maximum number of results within one page of the hit list.
`client`	`docu`	`link`	any valid URL, optionally containing the placeholder `###userLang###` default: `https://help.optimal-systems.com/yuuvis_develop/display/YMY/Adding+Documentation`	The given URL can be called from two places within the client: via the Documentation link provided in the About yuuvis® client menu item accessible via the main menu via the ? icon in the title bar of the client
`client`	`docu`	`language`	`["en","de"]`	List of languages 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

The developer libraries are provided by default with German and English as the application languages. However, the client can be extended with custom language files.

Users with the appropriate permissions can download the <iso>.json file for any language, modify it and upload it again in order to apply new values to the language configuration. The settings will be applied to all users of the users' tenant or to the users of all tenants.
>> Localization for Clients

To display an additional language, it needs to be enabled in the main.json configuration file via core.languages.

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

Browser not supported