Opening the Online Help

yuuvis® RAD 10.x »

The online help for yuuvis® RAD client can be viewed from yuuvis® RAD client in the browser.

If users do not have access to the Internet, they can still access the help. To facilitate this, the help files are stored locally and the help URL modified accordingly for yuuvis® RAD client.

You can also create your own help documents and integrate them using the help URL.

The help files for yuuvis® RAD client are available on request from the product management of OPTIMAL SYSTEMS GmbH.

To adjust the help URL, follow these steps

Follow these steps to create a custom configuration and adapt the configuration file for yuuvis® RAD client in the respective directory.

  1. File the desired help files locally.
  2. Open the main.json file in a text editor in the <service-manager-data>\webresource\resources\client\custom\assets\config\ directory. The following text will be modified:

    "about": {
    "docu": {
    "link": " rad/user/###userLang###/index.html",
    "label": ""

    The displayed value for the link parameter is the current URL of the standard user help for yuuvis® RAD client. Change these so that the locally filed help is displayed on the home screen.

    The ###userLang### part is optional. If you make the help available in several languages, ###userLang### will be automatically replaced with the ISO code of the language set in yuuvis® RAD client, and the help will be displayed in the appropriate language, provided the corresponding URL is also available.

    You have placed help files for German and English in corresponding local directories: ...\help\yuuvisRAD\user\de\ and ...\help\yuuvisRAD\user\en\. To access the online help in the set language, the URL must be specified as follows: ...\help\yuuvisRAD\user\###userLang###\index.html.

  3. Save the file.
  4. The label parameter corresponds to the text that is displayed in the help link. The parameter is not adjusted. Instead, you can add the key with the respective value for the relevant language in the .\assets\i18n directory for the respective language file (de.json, en.json, etc.).

  5. Restart yuuvis® RAD client.

Changes in the main.json configuration file can be overwritten by updates. If you enter the corresponding parameters in the extend.json configuration file located in the <service-manager-data>\webresource\resources\client\assets\_default\config\< directory, the changes are retained. We recommend you use only the extend.json file for configurations.