Installation

yuuvis® RAD repository-manager • 8.x »

Requirements

As a prerequisite, yuuvis® RAD and all of its components must have been installed.

The Visual C++ Redistributable Package for Visual Studio 2013 (x64) is required. The package must be installed before installing the 'repository-manger' service.

Installation

You will receive the following data to install yuuvis® RAD repository-manager:

  • 'repository-manger' service

  • RMTypes.zip

    Schema provided via yuuvis® RAD designer as part of the active schema.

'repository-manager' Service

The 'repository-manager' service is installed using yuuvis® RAD service-manager.

After installation, yuuvis® RAD repository-manager must be enabled via the servicewatcher-sw.yml configuration file from the \config directory by assigning the instances parameter the value 1:

name: repositorymanager
type: microservice
profiles: prod,cloud,mq
instances: 1
arch: x64
memory: 768M
port: 8010
path: "${appBase}/repositorymanager/repositorymanager-app.jar"

Once completed, yuuvis® RAD service-manager needs to be restarted.

For the communication between yuuvis® RAD core-service and yuuvis® RAD repository-manager, you usually have to increase the memory allocation for the 'dmssidecar' microservice from 512 MB (default) to 1024 MB via the servicewatcher-sw.yml configuration file.

Default Settings

yuuvis® RAD repository-manager is installed using central settings. Customizations, if necessary, should be performed before starting the service. Remember that YML files have a specific syntax.

Port 8010 is the default port for 'repository-manager' services. If you need to change the port, do so in the servicewatcher-sw.yml file. You will need to restart yuuvis® RAD service-manager afterward.
Working directory

By default, the working directory is created in the \rm\working-dir subdirectory of the data directory of yuuvis® RAD service-manager.

You can use the working-dir parameter of the repositorymanager-prod.yml configuration file to customize it.

The repositorymanager-prod.yml Configuration File

The repositorymanager-prod.yml configuration file is installed by yuuvis® RAD service-manager in the \config directory during installation. Use a text editor to enter the parameters in the configuration file.

A template is copied to the \service-manager\rm\config-example directory during installation.

Parameters of the repositorymanager-prod.yml configuration file:

Parameter Type Description Sample value
repository-manager.propagate-retention Boolean

true: retention periods are assigned to the documents.

Default: true

 true
repository-manager.working-dir String Working directory ${yuuvis.data.path}\rm\working-dir
repository-manager.barcode.default-docType String

Default SAP document type, if there is no barcode mapping for the yuuvis® RAD content type.

 TIF
repository-manager.barcode.cntType2docType String

List of entries for mapping the barcode document type, separated by pipe characters.

Entries consist of yuuvis® RAD content type, equals sign, SAP document type.

 Image/TIFF=FAX|application/pdf=PDF
repository-manager.barcode.repository-config String

List of entries separated with the pipe character. The entries are SAP repositories that support barcode documents.

If all SAP repositories support barcode documents, no entry is necessary.

 YT|YR
repository-manager.barcode.work-folder String Directory where KGS stores data in the barcode scenario. ${repository-manager.embedded-tomcat}\webapps\cs\work\contentserver\barcode
repository-manager.logger.path String

Path to the directory for logs

 ${repository-manager.working-dir}\logs
repository-manager.logger.max-history Integer

Maximum retention time for the logs in days.

 7
repository-manager.components.text String

List of formats for the document type for text documents

 text/plain
repository-manager.components.scanned String

List of formats for the document type for scanned documents

 image/tiff
repository-manager.barcode.default-protection   Barcode: document protection, if not provided by SAP rcud
repository-manager.barcode.default-protocol-version   Barcode: version number of the ArchiveLink log, if not provided by SAP 0046
dms.username String Name of the technical user

Default: root

The technical user requires full access rights to the objects.
dms.password String Password of the technical user Default: optimal
dms.uri String

IP address and port used by yuuvis® RAD repository-manager to connect to yuuvis® RAD core-service:

'dmssidecar' service or directly via yuuvis® RAD core-service or via yuuvis® RAD gateway.

http://127.0.0.1:7301 (core-service)

http://<host-gateway>/dms (gateway)

https://<host-gateway>/dms (gateway with SSL)

'gateway' and 'dmssidecar' need to be installed on the same host or 'gateway' must reach 'dmsidecar' via a 'routing-endpoint' in the 'gateway-prod.yml' file for connections via 'gateway':

routing.endpoints:
  - name: 'dms'
    url: 'http://<host-dmssidecar>:8080'
dms.use-sidecar Boolean

true: connection via yuuvis® RAD service-manager to the 'dmssidecar' service If this is not possible, a connection via 'dms.uri' will be tried.

false: Connection via the value of 'dms.uri'.

 Default: false
repository-manager.http-calls.connect-timeout Integer Timeout in seconds for the connection to yuuvis® RAD core-service Default: 30
repository-manager.http-calls.read-timeout Integer Timeout in seconds for reading data Default: 60
repository-manager.http-calls.write-timeout Integer Timeout in seconds for writing data Default: 120