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.
The Actions column allows you to perform the following actions.
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. |
 | 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.
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.
After making changes in a tab and in order to take over these changes, please click the Save button!
SAP tab
Salesforce tab
For linkng to salesforce this tab contains the following settings:
Parameter Name | Type | Description | Default Value |
|---|---|---|---|
Salesforce Linking Enabled | Checkbox | to enable Salesforce linking. As counter part a Salesforce-Plugin is required. internal docu: /wiki/spaces/WIKI/pages/2113110021 | Unchecked |
Common tab
Archiving tab
SMTP tab
In this tab the SMTP-Connector-Instances are configured, which shall receive DocumentRouter topic content.
Which topics exist and how DocumentRouter emailing works is described in DR4 - Mail support .
Parameter Name | Type | Description | Default Value |
|---|---|---|---|
SMTPInstanceList | String | One or more SMTP configurations, by their name. The asterisk character acts as a wildcard ( * ), meaning all SMTP instances configured in the KGS SMTP Plugin. In case multiple instances should be notified, they must be separated by comma (,) | * |
Duplication detection time-out | int | An duplicated mail is suppressed (not sent) inside configured period [ms] after sending mail. | 86400000 |
Further information for the KGS SMTP Connector plugin is available here KGS SMTP Connector
Conversion tab
KGS Document Router offers the possibility to convert files before archiving.
Parameter Name | Type | Description | Default Value |
|---|---|---|---|
ConvertTiff2Pdf | Checkbox | If set true, an tiff document file can be converted to pdf. | Unchecked |
Prolog tab
Within the Prolog tab you may define parameters necessary for DocumentRouter to find and use a prolog.
A prolog is an implementation inside a Java-Class residing in a jar file. The prolog mainly is before document router actions take place. In addition a prolog offers the opportunity to define a post action. The post action is called after all document router actions are done.
These actions allow you e.g. to reformat or change index data retrieved from an external source so it can be processed inside your existing workflows.
In case your workflows require one or more prolog classes you may ask KGS. We’ll gladly help you realize the functionality required by your workflows.
If you want use prologues, you need to provide the following parameters within the Prolog tab.
Parameter Name | Type | Description | Default Value |
|---|---|---|---|
PrologClass | String | Within the field PrologClass you may provide a Java class name, with the initialization parameters in brackets, separated by a comma ( , ). Input files for the Prolog class will be gathered by KGS DocumentRouter through the parameter PrologFileFilter and handed over one by one to the Prolog class. Example: KGSCold(param1,param2,param3) Depending on your prolog it’s also possible to use a configuration file as a parameter. Example: KGSCold( C:\PrologConfiguration\config.ini ) | Empty |
PrologFileFilter | String | The file extension used for input files which shall be handed over to the Prolog class may be defined in the field PrologFileFilter. The files matching the filter working like a trigger. Example: .pro | Empty |
PrologLocation | String | In order to find the implementation, DocumentRouter needs the location, where it can find the prolog implementing classes. E.g. /opt/tomcat/prologs/MyExampleProlog.jar | Empty |
PrologUndeletedTriggerFileIsError | Boolean | If checked and the configured prolog is not deleting its trigger file, it will be marked as error. This will cause move/delete of this trigger file and so avoid an endless loop. If unchecked the prolog can skip a trigger file in order to handle it later. | Checked |
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>