Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

After creating the necessary configuration files you’re ready to set up DocumentRouter instances.

In order to create a new instance or edit an existing one, please click on Main → KGS DocumentRouter. This will lead you to the instance overview. Within in the Instance Overview you may check the status, name, start and end time of each KGS DocumentRouter instance, as well as perform actions like creating a new instance, start or edit or stop an existing one as well as deleting an existing DocumentRouter instance.

Overview of all existing instances in “KGS DocumentRouter”

Image Modified

The Actions column allows you to perform the following actions.

Symbol

Description

Image Modified

The play symbol allows you to start an existing instance.

Image Modified

The stop symbol allows you to stop a running existing instance.

Image Modified

The bin symbol allows you to delete an existing instance.

Image Modified

The gear symbol allows you to open the Instance configuration modal, in which you may set the parameters necessary for DocumentRouter to work with the provided configuration files as well as configure the other available parameters.

Image Modified

The info symbol allows you to open the Volume Information modal, which contains the name of the instance as well as the current status.

Image Modified

The Import properties symbol allows you to open the Import Configuration modal, which allows you to upload an existing configuration to the DocumentRouter instance, overwriting the existing one.

Creating a new DocumentRouter instance

In order to create a new DocumentRouter instance, please click on the New Instance-button. This will open a modal which allows you to define the name of the instance as well as decide whether a configuration file for the instance shall be created.

Please note: It’s always a good practice to enable the Create Configuration File option, so the entered configuration will be stored in an external file.

Opened “New Instance” modal, which checked Create Configuration File option and highlighted New Instance button.

Image Modified

After clicking on the Create button, a new instance of DocumentRouter will be created and displayed within the instance overview.

You may now proceed to configure the created instance by clicking on the gear-symbol in the Action column.

Editing an existing DocumentRouter instance

After clicking on the gear-symbol, you’ll be lead to the configuration of this specific DocumentRouter instance. The configuration will be done in separate tabs, which are being described below.

Please note: After making changes in a tab, please do not forget to press the Save-button, in order to save the changes you made.

Description of the tab “SAP”

Insert excerpt
KGS DocumentRouter (DR4 ) - SAP - Tab
DR4 - SAP KGS DocumentRouter (DR4) - Tab - SAP
nopaneltrue

Description of the tab “License”

Insert excerpt
KGS DocumentRouter (DR4) - Tab - License
KGS DocumentRouter (DR4) - Tab - License
nopaneltrue

Description of the tab “SSL“

Insert excerpt
KGS DocumentRouter (DR4) - Tab - SSL
KGS DocumentRouter (DR4) - Tab - SSL
nopaneltrue

Description of the tab “HTTP”

Insert excerpt
KGS DocumentRouter (DR4) - Tab - HTTP
KGS DocumentRouter (DR4) - Tab - HTTP
nopaneltrue

Description of the tab “Volume”

Insert excerpt
KGS DocumentRouter (DR4 ) - Volume - Tab
DR4 - Volume KGS DocumentRouter (DR4) - Tab - Volume
nopaneltrue

Description of the tab “Protocol”

Insert excerpt
KGS DocumentRouter (DR4 ) - Protocol - Tab
DR4 - Protocol KGS DocumentRouter (DR4) - Tab - Protocol
nopaneltrue

Description of the tab “Common”

Insert excerpt
DR4 - Tab - Common
DR4 - Tab - Common
nopaneltrue

Description of the tab “Database”

Insert excerpt
KGS DocumentRouter (DR4 ) - Database - Tab
DR4 - Database KGS DocumentRouter (DR4) - Tab - Database
nopaneltrue

Description of the tab “SMTP”

Insert excerpt
KGS DocumentRouter (DR4 ) - Tab SMTP - SMTPTABKGS DocumentRouter (
DR4 ) - Tab SMTP - SMTPTAB
nopaneltrue

Description of the tab “Conversion”

Insert excerpt
DR4 - Tab - Common
DR4 - Tab - Common
nopaneltrue

Description of the tab “Prolog”

Insert excerpt
KGS DocumentRouter (DR4 ) - Prolog - Tab
DR4 - Prolog KGS DocumentRouter (DR4) - Tab - Prolog
nopaneltrue

Please note: In case you wish to check the status of multiple instances in a more textual way, you may also use an serverInfo-request against DocumentRouter in order to retrieve the status of all instances of DocumentRouter.

The request has to look like this: http://<IP address or hostname><:Port>/KGSAdmin-DR/documentrouter?serverInfo&pVersion=<0045 or 0046 or 0047>

...