Installation Guide Version 5.6

Owned by Mr. Schmittberger
Last updated: Nov 09, 2022 by Technische Redaktion
9 min read

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

Where to Find the Installers

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

Installation Process

Requirements

Also see the System Requirements.

  • Microsoft SQL or Oracle database server in one of the versions specified in the System Requirements.
  • An exclusive database instance for yuuvis®. 
    • The default language of the yuuvis® DB user must be set to English. 
    • The user must be a local database server user. yuuvis® does not currently support logging in the db with a domain user.
    • The user must have "db_owner" (or equivalent) rights on the yuuvis® database instance.
    • The installation on a Microsoft SQL Server High Availability cluster is only possible by removing the yuuvis® 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® 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 may 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® components.
  • Microsoft .NET Framework version 4.6.2 for yuuvis® 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® template-editor.
  • We also recommend installing Notepad++, Baretail, and 7-Zip.

dms-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.
  • The data directory will contain the WORK/CACHE/ARCHIVE area. You can configure the archive area separately after the setup (media management in yuuvis® management studio).
  • Under the heading “Enter E-Mail Parameters" you may leave the parameters empty and enter them at a later time in 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.
  • Start the installation.
  • Immediately initialize the database.
  • Do not start the service yet.
  • To start the server:
    • Run the "enaio_red_dms-servicew.exe" file in the <server>\bin  directory.
    • (Optional) Enter the technical (Windows) user in the "Log On" tab.
    • (Optional) Modify the log directory in the "Logging" tab.
    • In the "Java" tab, modify the "Maximum memory pool" value to the desired maximum amount of working memory for the dms-service (see the System Requirements for recommendations).
    • In the "General" tab, click "Start" to start the server.
    • Check the log file <server>\logs\dms-service.log with a logging program such as Baretail for the successful (or not) start of the server.
    • The server has been successfully started when a large "enaio" logo is displayed as ASCII-art.
  • Modify the data directories:
    • WORK / CACHE / ARCHIVE can be configured in management-studio (menu entry Media)
      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.
  • Modify the log directory:
    • In the directory <dms-service>\bin, run the enaio_red_dms-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

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

enterprise-manager

  • Start the setup by double-clicking.
  • Follow the setup dialogs.
  • In the "enaio dms-service Server" field, enter the IP address of the server that hosts the dms-service.
  • Complete the setup.
  • To test the setup, use the Windows Start menu to start enterprise-manager, then select the correct server connection and log in using root / optimal. Note: If enterprise-manager was installed to C:\Program Files*..., you must start it with administrative rights. Otherwise, no files can be added to its directory or be edited.
  • If the connection has been established, everything is OK.
  • Modify the log directory:
    • Use an unzip program to open the file <enterprise-manager>\lib\jasmonitor-application.jar and unpack the file log4j.xml in the lib folder.
    • In the log4j.xml file, modify all lines that begin with "<param name="File" value=" (relative path to the root directory of enterprise-manager).

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

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 dms-services in 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" />"

The setup MSI supports the following parameters:

INSTALLLOCATION(optional) Target directory for yuuvis® designer in the file system. Preset: "C:\Program Files (x86)\OPTIMAL SYSTEMS\enaio redline\designer\v5\"


Elasticsearch

  • Start the setup by double-clicking.
  • Follow the setup dialogs.
  • Under HTTP-Port, you can configure the port that Elasticsearch will listen on. This port should only be changed if the default port (9200) is already being used. For more details see below.
  • The index directory is the directory where Elasticsearch will put its index (database) files. This can become very large. We recommend to use SSD storage for this directory.
  • When asked for the maximum memory, configure the amount of heap space that Elasticsearch can use. This should be between 4 and 31,5 GB.
  • Start the installation.
  • Do not start the service yet.
  • Change the http and transport ports (optional unless running 2+ instances on the same machine):
    • Edit the file <elasticsearch>\config\elasticsearch.yml
    • Change the "http.port:" property to your desired port. Make sure to reflect this change in the <service-manager>\config\application-es.yml configuration file of the service-manager.
    • Change the "transport.tcp.port" property to your desired port
  • Set the repository path (optional, if no cluster is set up):
    • Edit the file <elasticsearch>\config\elasticsearch.yml
    • Edit the "path.repo:" property and set your desired repository path. Use "/" instead of "\" in the path.
      If you want to run Elasticsearch in a cluster, this path needs to be used by all cluster nodes and thus it needs to be accessible by all cluster nodes.
  • Modify the service user (optional):
    • Run the "elasticsearch-6-service-x64w.exe" file in the <elasticsearch>\bin directory.
    • Enter the technical (Windows) user in the "Log On" tab.
  • Change heap space settings (optional):
    • Run the "elasticsearch-6-service-x64w.exe" file in the <elasticsearch>\bin directory.
    • In the "Java" tab, modify the "Maximum memory pool" value to the desired amount of heap space for the service. Make sure "Initial memory pool" is set to the same value.
    • In the "Java options" section adapt the "-Xmx" and "-Xms" settings to the desired amount of heap space.
  • Modify the data directory (optional):
    • Edit the file <elasticsearch>\config\elasticsearch.yml
    • Edit the "path.data:" property and set your desired data path. Use "/" instead of "\" in the path.
  • Modify the log directory (optional):
    • Run the "elasticsearch-6-service-x64w.exe" file in the <elasticsearch>\bin directory.
    • Modify the log directory in the "Logging" tab.
    • Edit the file <elasticsearch>\config\elasticsearch.yml
    • Add a line with "path.logs: " and the path to your desired logs folder. Use "/" instead of "\" in the path.
  • Start the service. (check es-red.log file in the logs folder for correct startup)


service-manager

  • Double-click to start the setup.
  • Follow the setup dialogs.
  • Under HTTP-Port, you can configure the service-manager services port. This port has no special significance but should only be changed if the default port (7281) is already being used.
  • Under "Enter enaio dms-service parameter", enter the IP address of the server that hosts the dms-service (Important: do not use localhost; always use IP addresses that are externally visible). Also, enter the credentials of the yuuvis® user (technical user) with whom the service-manager will connect to the dms-service. Usually this is root / optimal.
  • Under "Enter database parameter" at "database server" enter the IP address under which the database used for yuuvis® (dms-service) can be reached. You may need to modify the port (1433 is generally correct for MSSQL databases).
  • Enter the database name of the database used for the yuuvis® (dms-service), as well as the credentials of the database user designated for yuuvis® into the corresponding fields.
  • Under "Enter enaio rendition-plus parameter ", enter the IP address and the port of the server that hosts yuuvis® rendition-plus. rendition-plus does not yet have to be installed. If a different port is selected during installation of rendition-plus, you must enter it instead of the default 8090.
  • Complete the setup but do not start the service yet.
  • (Optional) In the file <service-manager>\config\servicewatcher-sw.yml, modify the memory allocation and instances for the individual services. Note: If a service is allocated more than 1.5 GB of memory, you must set the parameter "arch: x64" for this service to activate the support for 64 bit.

  • In the "<service-manager>\config\gateway-prod.yml" file, you can adjust the authentication mechanism for the services. You can also define additional (external) end points as follows:

    routing.endpoints

  • If a file with a patch level version > 0 is in the <enaio_redline_setup>\enaio_redline_client directory (in a client-3.xy.z.zip, the z is the patch-level version), it means a subsequent hotfix for the client exists. You can install it as follows:
    • From the <enaio_redline_setup>\enaio_redline_client folder, copy the client file with the highest patch level to <service-manager>\tools.
    • In the folder <service-manager>\tools\sam, open a command line window and enter the command "sam update..\client-3.xy.z.zip", substituting xy.z with the respective version.

  • If the Elasticsearch installation is on a different machine than the service-manager installation, edit the <service-manager>\config\application-es.yml file and replace the 127.0.0.1 IP with the IP of the Elasticsearch machine in the following lines:

    spring.data.elasticsearch.cluster-nodes: '127.0.0.1:9300'
    spring.data.elasticsearch.cluster-nodes-rest: '127.0.0.1:9200'
    spring.elasticsearch.rest.uris: '127.0.0.1:9200'

  • Start the services:
    • In the <service-manager>\bin directory, run "enaio_red_service-managerw.exe".
    • (Optional) In the "Log On" tab, enter the technical (Windows) user.
    • (Optional) In the "Logging" tab, modify the log directory.
    • (Optional) In the "Startup" tab, modify the port again. You can also modify the services.log location.
    • In the "General" tab, click "Start" to start the server.
    • You can see an overview of the running services at http://<ip>:7273. This is the Spring Boot Admin service. It can be used to permanently monitor the services.
    • It can take several minutes for all the services to start successfully.
    • "Connection refused" exceptions appearing in the service-manager log file in the first few minutes are nothing to worry about.
  • Modify the data directories:
    • In the <service-manager>\bin directory, run the enaio_red_service-managerw.exe file.
    • In the "Java" tab, under Java Options, set the temp directory with the JVM option Djava.io.tmpdir. You can use the options –Dcatalina.base and –Dcatalina.home to set the Tomcat work directories.
    • In the directory <service-manager>\config, open the application-prod.yml file and modify enaio.data.path. The relative path to the .jar files is <service-manager>\apps\<*service>. If you use './../..', you end up in the service-manager root directory.
  • Modify the log directory:
    • In the <service-manager>\bin directory, run the enaio_red_service-managerw.exe file.
    • In the "Logging" tab, modify the log path and, if desired, set up or change the redirects for stdout and stderr.
    • In the "Startup" tab, modify the "--logging.file" argument. The relative path to the .jar files is under <service-manager>\apps\<*service>. Use './../..' to point to the service-manager root directory.
    • In the <service-manager>\config, open the servicewatcher-sw.yml file and in the "logging" section, modify "file". The relative path to the .jar files is under <service-manager>\apps\<*service>. Use './../..' to point to the service-manager root directory.

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

 
rendition-plus

  • Start the setup by double-clicking.

  • Follow the dialogs in the installer.
  • The HTTP port determines through which port the rendition-plus service can be contacted. If you deviate from the default 8090, you must modify the service-manager configuration file application-red.yml accordingly.
  • In "enaio Rendition sidecar" enter the IP address of the server hosting the service-manager. Important: 127.0.0.1 is only valid if both services are installed on the same machine. If not, you must use an externally visible IP address.
  • Complete the setup but do not start the service yet.

  • In the file <rendition-plus>\webapps\osrenditioncache\WEB-INF\classes\config\config.properties, modify the maximum size of the rendition cache with the cache.maxsize parameter if the preset of 500 GB does not fit your needs. The smaller you make the cache size, the more often existing rendition files are displaced and have to be created again when requested by a call.

  • To start rendition-plus:
    • In the directory <rendition-plus>\bin, run the "enaio red rendition-plusw.exe" file.
    • (Optional) In the "Log On" tab, enter the technical (Windows) user.
    • (Optional) In the "Logging" tab, modify the log directory.
    • In the "General" tab, click "Start" to start the server.
    • In the Windows Services Manager, restart the service-manager.
    • After a successful restart, in the Spring Boot Admin, the service-manager displays whether rendition-plus is correctly available.
  • Modify the data directories:
    • In the <rendition-plus>\bin directory, run "enaio red rendition-plusw.exe".
    • In the "Java" tab, under Java Options, set the temp directory with the JVM option Djava.io.tmpdir. You can use the options –Dcatalina.base and –Dcatalina.home to set the Tomcat work directories.
    • In the file <rendition-plus>\webapps\osrenditioncache\WEB-INF\classes\config\config.properties, you can modify rendition-cache specific data directories.
      • To modify the Cache directory, use the sor.root key.
      • To modify the Jobs directory, use the job.root key.
      • To modify the Temp directory, use the temp-base key.
      • To modify the Database-Root directory, use the db.root key.
    • In the file <rendition-plus>\webapps\renditionplus\WEB-INF\classes\config\config.properties, you can modify rendition-plus specific data directories.
      • The temp directory can be adjusted with the temp-base key.
  • Modify the log directory:
    • In the <rendition-plus>\bin directory, run "enaio red rendition-plusw.exe".
    • In the "Logging" tab, modify the log path and, if desired, set up or change the redirects for stdout and stderr.
    • In the <rendition-plus>\conf directory, open the logging.properties file and modify all lines that correspond to a *.directory key. (As a rule, $(catalina.base) corresponds to the rendition-plus root directory.)
    • Open the <rendition-plus>\webapps\osrenditioncache\WEB-INF\classes\log4j.properties file in a text editor.
      • Modify the log4j.appender.OsRenditionCacheLogFile.File key to change the path of OsRenditionCacheLogFiles.
      • Modify the log4j.appender.JobMonitoringLogFile.File key to change the path of JobMonitoringLogFiles.
    • Open the <rendition-plus>\webapps\renditionplus\WEB-INF\classes\log4j.properties file and modify the log4j.appender.RenditionPlusLogFile.File key to change the path of RenditionPlusLogFiles.

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

Office Add-Ins

  • Start the MSI files for yuuvis® agent, the yuuvis® Office add-in, the yuuvis® Outlook add-in, and the yuuvis® template-editor by double-clicking them.
  • Other than an installation path, the setups need no additional input and complete on their own.
  • Modify the log directories:
    • The log directories cannot be modified at this time. Any log files can be found in %LOCALAPPDATA%\OPTIMAL_SYSTEMS_GmbH\Logs, in the corresponding subfolders.


For security reasons, the passwords for the system accounts should be changed after the installation is complete.