/
Installation Guide Version 9.0

Installation Guide Version 9.0

Jul 04, 2023

This guide describes how to install and configure a complete yuuvis® RAD 9.x system.

Where to Find the Installers

The official installers for the yuuvis® RAD 9.x release can be found in the OS cloud URL listed in the release e-mail.

Installation Process

Requirements

Also see the System Requirements (German version here).

  • Microsoft SQL or PostgreSQL database server in one of the versions specified in the System Requirements (German version here).

  • An exclusive database instance for yuuvis® RAD. 

    • The default language of the yuuvis® RAD DB user must be set to English. 

    • The user must be a local database server user. yuuvis® RAD does not currently support logging in the db with a domain user.

    • The user must have "db_owner" (or equivalent) rights on the yuuvis® RAD database instance.

    • The installation on a Microsoft SQL Server High Availability cluster is only possible by removing the yuuvis® RAD database from the cluster for the duration of the installation, then integrating it back into the cluster afterwards. This can be done while the cluster is online. Later updates of yuuvis® RAD do not require this process.

    • The starting size and "extend by" size of the data and log files should suit your needs. 

    • If the log file size is limited, the recovery model must be set to "simple".

  • The server host names must conform with RFC 952. Specifically, they must not contain underscores ( _ ).

  • Firewall exceptions and/or proxy configurations/exceptions for all ports named in the System Requirements or configured differently to the setup's standard.

  • Anti-virus exceptions for all folders used by yuuvis® RAD components.

  • Microsoft .NET Framework version 4.8 and Microsoft Edge WebView2 for yuuvis® RAD designer.

  • An evergreen browser (Chrome, Firefox, Edge) in the current version for the webclient.

  • Microsoft Office in one of the versions specified in the System Requirements to run Office Add-In, Outlook Add-in (archiving) and yuuvis® RAD template-editor.

  • We also recommend installing Notepad++, Baretail, and 7-Zip.


yuuvis® RAD core-service

  • Start the setup by double-clicking, or, if you need to modify preset parameters, open an administrative command line and enter the setup command with the desired parameters.

  • Follow the dialogs in the setup.

  • Under the heading "Create database structure and base configuration":

    • Choose "yes" if you are doing a fresh install and the database is created but empty. This is the default.

    • Choose "no" if you already have an existing yuuvis® RAD database. This is the case if you are upgrading from a yuuvis® RAD 5.x installation or for example in disaster recovery situations.

  • If you chose "yes":

    • Under the heading “Enter E-Mail Parameters" you may leave the parameters empty and enter them at a later time in yuuvis® RAD management-studio. 

    • The data directory will contain the WORK/CACHE/ARCHIVE area. You can configure the archive area separately after the setup (media management in yuuvis® RAD management-studio).

    • Under the sidecar service URL, instead of localhost, you must enter the IP of the server hosting the service-manager. It doesn't matter whether or not the address or the dms-sidecar microservice can already be accessed. 

    • Note the systemuser API key. You will need to enter it during the service-manager setup.

  • Start the installation.

  • Immediately initialize the database. (This is only shown if you chose "yes" in the "Create database structure and base configuration" step)

  • Do not start the service yet.

  • If the database is an Oracle database:
    By default, the oracle schema name is equal to the upper case user name and this is used automatically.
    If you have the case / the requirement, that the schema name is different from the upper case user name, please configure it as follows:

    • Open the file <core-service>\standalone\configuration\standalone-full-ha.yml

    • Naviagte to the line "<subsystem xmlns="urn:jboss:domain:datasources:5.0">" and there to "<datasource jndi-name="java:/JASDB"..."

    • Within this section, add the following new line under the line beginning with "<connection-property": <new-connection-sql>ALTER SESSION SET current_schema=schemaname</new-connection-sql>
      Replace 'schemaname' with the name of the schema. (Do not use any quotation marks.)

  • Modify the data directories (optional) :

    • For optimal configuration of the media sets please see: Configuring Media settings for Optimal Harddisk and Inode Usage

    • The JBoss data and temp directories can be configured using the JVM-options jboss.server.data.dir and jboss.server.temp.dir.

    • WORK / CACHE / ARCHIVE can be configured in the management-studio (menu entry Media) after the core-service and the service-manager have successfully started. 

  • Modify the log directory (optional) :

    • In the directory <core-service>\bin, run the yuuvis_rad_core-servicew.exe file:

      • In the Logging tab, change the log path and if desired, change the routing for stdout and stderr.

      • In the Java tab, in Java Options, modify the values for -Djboss.server.log.dir and -Dorg.jboss.boot.log.file

  • Change the service-user (optional):

    • Run the "yuuvis_rad_core-servicew.exe" file in the <server>\bin  directory.

    • Enter the technical (Windows) user in the "Log On" tab.

  • Change the heap-space settings (optional):

    • Run the "yuuvis_rad_core-servicew.exe" file in the <server>\bin  directory.

    • In the "Java" tab, modify the "Maximum memory pool" value to the desired maximum amount of working memory for the core-service (see the System Requirements for recommendations).

  • Start the service.

  • Check the log file <core-service>\logs\core-service.log with a logging program such as Baretail for the successful start of the service. The service has been successfully started when a large "yuuvis" logo is displayed as ASCII art.

The setup can be run using the command line. Use the --help option to see a list of all available parameters and options.


yuuvis® RAD designer

  • Start the setup by double-clicking.

  • Follow the dialog boxes in the setup.

  • Complete the setup.

  • You can configure and manage connections to the core-services in the designer under Settings > Connections.

  • Modify the log directory:

    • In the root directory of designer, open the logging.nlog.config file in a text editor and modify the value in the following line:
      "<variable name="logDirectory" value="${specialfolder:folder=LocalApplicationData}\OPTIMAL_SYSTEMS_GmbH\Logs\enaio designer" />"