About

The kgs Document Router is web application server based product. Since state of the art for shipping software products is providing preconfigured container images that can be easily deployed on dedicated server or cloud environment, kgs packaged the Document Router with web application server and linux container OS into an image file.

This article describes deployment and configuration of the Document Router as container.

Content

1 About
2 Content
- 2.1 Introduction
- 2.2 Preparation
- 2.3 Deploying tia Document Router
  - 2.3.1 Example docker compose file
3 Configuration in OSGi

Introduction

For technical preparation and prequirements read:

https://kgs-software.atlassian.net/wiki/spaces/~5c8bb2ef33a4404c1086f9b4/pages/2683469825/OSGi+Produkte+in+Container

Preparation

Permanent storage is required for following purposes. Selecte the file system paths and prepare the storage. During the deployment these are using for volume mappings.

Purpose

Purpose

Work directory

This is where the Document Router stores temp files and configuration. It is typically called workwith following subfolder:

work/log for log files

work/configuration/kgs for configuration files as

schema definitions
archive configuration
SID mapping
repository mapping

work/kgs/protocol/store for the protocol database (H2)

Library directory

Location for libraries, that is especially the SAP JCo library.

Scan folder

Input directory for the document router instance.
Depending on the instances configered, multiple scan folders should be configured and volume mappings added.

Download Linux version of SAP JCo library (libsapjco3.so) and sapjco3.jar as described here: https://kgs-software.atlassian.net/wiki/pages/createpage.action?spaceKey=SUPPORT&title=Download%20SAP%20Java%20Connector%20%28SAP%20JCo%29.

Pull the latest tia Document Router image.

Example:

docker pull images.kgs-cloud.de/tia-documentrouter/tia-documentrouter:5.1.3

For more information read How to download kgs software .

Deploying tia Document Router

Adapt the docker compose example configuration to the container runtime environment of the target environment.

Beside the volume mappings below, consider the container name and map the port 8080 to the target port on host.

Example docker compose file

services:
  
  documentrouter:
    container_name: dr513
    ports:
      - "8080:8080"
    image: images.kgs-cloud.de/tia-documentrouter/tia-documentrouter:5.1.3
    volumes:
      - <work folder>:/application/work
      - <lib folder>:/application/lib
      - <scanfolder01>:/application/dr-instance-01-input

start the composition

cd c:\tmp\dr
docker-compose up

docker ps shows the running container

#>docker ps -a
CONTAINER ID   IMAGE                                                                    COMMAND                  CREATED          STATUS                     PORTS                    NAMES
985425db6556   images.kgs-cloud.de/tia-documentrouter/tia-documentrouter:5.0.2   "java -jar app.jar"      10 minutes ago   Up 35 seconds              0.0.0.0:8080->8080/tcp   dr503

Configuration in OSGi

SAP JCO Configuration

When the container is running, access the administration user interface in web browser: http(s)://<host>:<port>/KGSAdmin-DR/
Go to menu Main > KGS SAP Connector
Click Configuration Editor
At the tab Common fill the fields PathToSAPJar and PathToSAPNativeJar where the SAP JCo library files are located in container file system according to the volume mapping of the library folder:

/application/lib/libsapjco3.so

/application/lib/sapjco3.jar

HTTPS-Configuration for Web-Console with HTTPS

See Configuring tia® Classic and tia® Core for HTTPS (container deployment)

Web-Console Authentification

The authentication for the administration user-interface is set using security provider.

The sequence of first adding an user and then a security configuration is important. When adding a security configuration without a user in User/PW Userlist causes lock out.

In this case contact kgs Customer Support to unlock.

Navigate to menu Main > Security Provider
Click User/PW Userlist to add the user:

Click button + Add User in the upper right corner:

Fill in the form for User Name and User Password and click button Add User

Click Security Configurations

Add a config by pressing the + Add Config button (upper right corner)

Fill the form and then hit the OK button

A name for the configuration
A description
Set type to User/PW Userlist

Press the Pencil button ()
Check Enable for Webconsole and press Save & Close

A warning appears that the administration user is modified. Press OK.

Refresh the browser tab and authenticate using the updated credentials.

Deploying KGS DocumentRouter as container