Versions Compared

Key

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

In order to use KGS DocumentRouter you may provide a configuration file that contains the DataInterface definition, as well as the ArchivingSystem definition and a configuration file that contains the SIDMapping definition.

These three definitions follow a certain structure that will be described in the following sections.

...

DataInterface

...

definition

The data interface describes the data and positions of data which will be used in the linking process. Index files contain these values and needs to fit the definition. Regularly, the DataInterface is derived from the structure defined by from the index files contentsfile content.Any DataInterface follows one of the two following structures.

An DataInterface can be defined in 2 types:

  • Separator based (variable length)

  • fixed length

DataInterface for sets with variable length

[<DataInterface name>]
<Keyname> = <Key type> | <Separator> | <Number in Set> | <Default Value>
<Keyname> = <Key type> | <Separator> | <Number in Set> | <Default Value>

DataInterface for sets with fixed length

[<DataInterface name>]
<Keyname> = <Key type> | <Position> | <Length> | <Default Value>
<Keyname> = <Key type> | <Position> | <Length> | <Default Value>

...

The following Key types are being supported by KGS DocumentRoutertDocumentRouter.

Type symbol / Type value

Symbol / Value description

B

SAP Business Object (e.g. BKPF, VBRK, etc.)

C

SAP Content Repository ID (e.g.: FI, BU, FP, etc.)

D

SAP Archive Document ID

F

Image file name

f

The image filename will be taken the same as the index file.

H

SAP Host

I

Ignores the value

L

SAP Language

M

SAP Client

N

Defines, that the value will not be handed over to the SAP User Link Remote Function

From Version 3.1.39 onward :

Defines the Content of the ‘note’ component

O

SAP Object ID

P

SAP Password

S

SAP SystemID

T

SAP ArchiveLink Document Type (Archiving Object)

U

SAP User

X

Defines that this value will be handed over to the SAP User Link Remote Function

Y

SAP System number

b

Barcode

d

Date

g

SAP Group, which is being used in order to load balance the RFC connection

m

SAP MessageServer Host, which is being used in order to load balace RFC connection

n

SAP Client extracted out of the <SAP SID>M<SAP Client>-notation (e.g.: K47M800 will be translated to SAP Client: 800 in SAP SID K47)

p

ISRA-specific parameter which will be handed over to an ISRA interface

s

SAP System, which is being used for load balancing purposes

o

Offset within the image file (F)

l

Length from the offset within the image file

The following separators are being supported.

  • A semikolon → ;

  • A comma → ,

  • A vertical bar → |

  • A hashtag → #

Sample of “DataInterface”-definition

[BASE_INTERFACE]
Filename = F | , | 1 |
ObjectID = O | , | 0 |@Filename
ContRep = C | , | 0 |FI
Objecttype = B | , | 0 |BKPF
DocType = T | , | 0 |FIIPAYMENT

Please note: Every row within a DataInterface defines a value. It’s also possible to reuse an already defined value in a DataInterface-definition by putting an @-sign before the values name and, like in the example above, using it e.g. as a fallback / default value.

...

Archiving system

...

definition

It’s often necessary to define one or many connections to the archiving system, so KGS DocumentRouter knows how to communicate with the archive and where to exactly archive the processed documents.

...

Sample of multiple archiving connection definitions

[_ARC_FI]
HttpProtocol = http
HttpHost = test.contentservers.kgs-software.com
HttpPort = 1234
HttpPath = /KGSAdmin-CS/contentserver
HttpParameters =
Security = 0
LateLocking = 1

[_ARC_TE]
HttpProtocol = http
HttpHost = 17.59.128.128
HttpPort = 2345
HttpPath = /KGSAdmin-CSV/contentserver
HttpParameters =
Security = 0
LateLocking = 1

...

SIDMapping

...

definition

In case you require a linking to multiple SAP systems within one DocumentRouter instance you may need to define an SID-mapping file which contains the connection information required for RFC communication. Like the DataInterface-definitions the SID mapping definition follows a certain structure which allows you to define the mapping to your needs or requirements.

...