Versions Compared

Key

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

Within the Protocol tab you may define whether and how KGS DocumentRouter protocols the documents and components it archived and linked as well as prolog errors.

Parameter nameName

Type

Description

Default Value

EnableProtocol

Checkbox

When checking the option EnableProtocol DocumentRouter will start to write information reagarding the documents it archived in KGS ProtocolWriter which is included within the DocumentRouter application.

Checked = DocumentRouter will write a protocol regarding the documents it processed to ProtocolWriter.

Unchecked = DocumentRouter will not write any protocol information regarding the documents it processed.

Unchecked

ProtocolAlias

String

You may define an alias for an instance within KGS DocumentRouter in order to find information regarding a specific instance of DocumentRouter easier.

It’s good practice to name a protocol alias the same as the instance that is creating it, so it’s easier to find the documents that have been processed by that instance.

Empty

ProtocolUserData

Checkbox

TODO

checked:

unchecked:If checked, all information given by index file/schema is stored into the protocol entry, too.

Unchecked

HashAlgorithm

List

When setting the parameter HashAlgorithm to anything else than none, KGS DocumentRouter will also protocol the used hashing algorithm as well as the generated hash value for an archived document.

Currently the following options are available.

  • none = No hashing algorithm will be used and no hash values will be protocoled.

  • MD5 = MD5 will be used as hashing algorithm and the generated values will be stored within ProtocolWriter.

None