Customizing the Main Configuration
- Technische Redaktion
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.jsonfile via the Web-API Gateway endpoints GET /api-web/api/admin/resources/config/{name} or GET /api-web/api/resources/config/{name} withmain-configas value for thenamepath parameter. - Modify the
main.jsonfile 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-configas value for thenamepath 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.
{
"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:
Only one language in the list can have the value For several languages, the specific date, time and number formats are automatically used. | |
label | English | |||
fallback | true | |||
logging | level | debug | Logging levels:
| |
permissions (as of 2022 Spring) | |
| Name of the role that enables the display of the following administrative information which are hidden for other users:
| |
|
| 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. | ||
|
|
| 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. | |
|
| 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. | ||
|
|
| Maximum number of tasks per page in the client's Inbox view. | |
|
| 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 default: | The given URL can be called from two places within the client:
|
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.