Versions Compared

Key

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


Page Properties
hiddentrue
idDONE

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje07 FEB 20222022 Springcreated for new client development documentation structure
Agnieszka11 FEB 20222022 SpringrLANG
Antje16 FEB 20222022 Springadministrative roles are configurable
Antje10 OCT 20222022 Summerapp section for bpm configuration parameters added
Antje28 Nov 20222022 Winteradd dashboardWorkspaces 


...

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 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

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
     
    Anchor
    permissions
    permissions
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:
  • 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.

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. 

Anchor
docu
docu

app (as of 2022 Summer)


inboxPageSize

100 (default)

Maximum number of tasks per page in the client's Inbox view.

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 page.
clientdoculink

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
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.

...