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 enter the KGS Document Router istance view by clicking in UI
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.
...
Symbol | Description |
|---|---|
 | The play symbol allows you to start an existing instance. |
 | The stop symbol allows you to stop a running existing instance. |
 | The bin symbol allows you to delete an existing instance. |
 | 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. |
 | The info symbol allows you to open the Volume Information modal dialog, which contains the name of the instance as well as the current status. |
 | 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 dialog which allows you to define the name of the instance as well as decide whether a configuration file for the instance shall be created.
It’s always a good practice to enable the Create Configuration File option, so the entered configuration will be stored in an external file.
...
.
...
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.
| Note |
|---|
After making changes in a tab and in order to take over these changes, please |
...
click the Save |
...
Description of the tab “SAP”
...
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”
...
button! |
SAP tab
| Include Page | ||
|---|---|---|
|
Salesforce tab
| Include Page | ||
|---|---|---|
|
Common tab
| Include Page | ||
|---|---|---|
|
Archiving tab
| Include Page | ||
|---|---|---|
|
SMTP tab
| Include Page | ||
|---|---|---|
|
Conversion tab
| Include Page | ||
|---|---|---|
|
Prolog tab
| Include Page | ||
|---|---|---|
|
Description of the tab
...
“Common”
| Insert excerpt | ||||
|---|---|---|---|---|
| Insert excerpt | ||||
|
Description of the tab “Conversion”
|
Description of the tab “Prolog”
...
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>