Versions Compared

Key

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

...

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,

...

enter the KGS Document Router istance view by clicking in UI
Main → KGS DocumentRouter.

...


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”

...

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

...

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

...

configuration

...

.

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 dialog which allows you to define the name of the instance

...

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.

...

.

...

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 :

Description of the tab “License”

Description of the tab “SSL“

Description of the tab “HTTP”

Description of the tab “Volume”

Description of the tab “Protocol”

Description of the tab “Common”

Description of the tab “Database”

Description of the tab “SMTP”

Description of the tab “Conversion”

Description of the tab “Prolog”

Please note:

button!

Note

After making changes in a tab and in order to take over these changes, please

do not forget to press

click the Save

-button, in order to save the changes you made.

Description of the tab “SAP”

Insert excerpt
KGS DocumentRouter (DR4) - Tab - SAPKGS DocumentRouter (DR4) - Tab - SAP
nopaneltrue
Insert excerpt
KGS DocumentRouter (DR4) - Tab - LicenseKGS DocumentRouter (DR4) - Tab - License
nopaneltrue
Insert excerpt
KGS DocumentRouter (DR4) - Tab - SSLKGS DocumentRouter (DR4) - Tab - SSL
nopaneltrue
Insert excerpt
KGS DocumentRouter (DR4) - Tab - HTTPKGS DocumentRouter (DR4) - Tab - HTTP
nopaneltrue
Insert excerpt
KGS DocumentRouter (DR4) - Tab - VolumeKGS DocumentRouter (DR4) - Tab - Volume
nopaneltrue
Insert excerpt
KGS DocumentRouter (DR4) - Tab - ProtocolKGS DocumentRouter (DR4) - Tab - Protocol
nopaneltrue
Insert excerpt
DR4 - Tab - CommonDR4 - Tab - Common
nopaneltrue
Insert excerpt
KGS DocumentRouter (DR4) - Tab - DatabaseKGS DocumentRouter (DR4) - Tab - Database
nopaneltrue
Insert excerpt
KGS DocumentRouter (DR4) - Tab - SMTPKGS DocumentRouter (DR4) - Tab - SMTP
nopaneltrue
Insert excerpt
DR4 - Tab - CommonDR4 - Tab - Common
nopaneltrue
Insert excerpt
KGS DocumentRouter (DR4) - Tab - PrologKGS DocumentRouter (DR4) - Tab - Prolog
nopaneltrue

SAP tab

Include Page
DR4 - SAP - Tab
DR4 - SAP - Tab

Salesforce tab

Include Page
DR4 - Salesforce - Tab
DR4 - Salesforce - Tab

Common tab

Include Page
DR4 - Common - Tab
DR4 - Common - Tab

Archiving tab

Include Page
DR4 - Archiving - Tab
DR4 - Archiving - Tab

SMTP tab

Include Page
DR4 - SMTP - TAB
DR4 - SMTP - TAB

Conversion tab

Include Page
DR4 - Conversion - Tab
DR4 - Conversion - Tab

Prolog tab

Include Page
DR4 - Prolog - Tab
DR4 - Prolog - Tab

Authentication tab

Include Page
DR4 - Authentication - Tab
DR4 - Authentication - Tab

Request DocumentRouter instance state by REST

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>