DR4 - Prolog - Tab

Owned by Maik Wodarz
Last updated: Jun 05, 2023 by Simone Conrad
2 min read

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

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