In order to use KGS DocumentRouter tia® Document Router 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.
...
DataInterface for sets with variable length |
---|
[<DataInterface name>] |
DataInterface for sets with fixed length |
[<DataInterface name>] |
...
The following Key types are being supported by KGS DocumentRoutertia® Document Router.
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 |
...
Every row within a DataInterface defines a value. It’s also possible to reuse an already defined value in a DataInterface-definition by putting parameter to be used during archiving or linking. The parameter names can be used in the default value column of other parameters by prefixing them with an @-sign before the values name and, like in the example above, using it e.g. as a fallback / default value.
...
.
Special fields
Fields can reuse values of other fields.
For example in a scenario where no index file exist, all for archive and link relevant information are fetched from file name. So you need to split up the file name an maybe join if you want create additional information for e.g. linking.
Sub-Value by Position
Code Block |
---|
[positionBasedSchema]
FileName = f || |0 |
ArchiveType = C || |0 |N1
DOC_TYPE = c || |0 |
SAP_OBJECT = B || |0 |BKBF
AR_OBJECT = T || |0 |ZFILENAME
ObjectID = O || |0 |@Filename[1,18]
SYS_ID = S || |0 |@Filename[20,22]
MANDANT = M || |0 |@Filename[24,26] |
ObjectID
is an sub string ofFilename
. It uses position 1 until 18 of it.
Sub-Value by Separator
Code Block |
---|
[separatorBaseSchema]
ImageFileName = f |, |0 |
CONTREP = C |, |0 |@ImageFileName[_,1]
ARCHDOCID = D |, |0 |@ImageFileName[_,2] |
field
ImageFileName
is split by_
and then position 1 is used forCONTREP
and position 2 forARCHDOCID
Join
Code Block |
---|
[joinSchema]
FileName = f || |0 |
ArchiveType = C || |0 |N1
DOC_TYPE = c || |0 |
SAP_OBJECT = B || |0 |BKBF
AR_OBJECT = T || |0 |ZFILENAME
ObjectID = O || |0 |@Filename[1,18]
SYS_ID = S || |0 |@Filename[20,22]
MANDANT = M || |0 |@Filename[24,26]
another = X || |0 |@ObjectID@MANDANT |
here the field
another
which is used while linking is a concatenation of the contents ofObjectId
andMandant
.
ArchiveLink Connection mapping
It’s often necessary to define one or many connections to the archiving system, so KGS DocumentRouter tia® Document Router knows how to communicate with the archive and where to exactly archive the processed documents.
...
Sample of multiple archiving connection definitions |
---|
[_ARC_FI] [_ARC_TE] |
Info |
---|
This difinition definition was in DR4 DR3 hold in SIDmappingdefinitionFIle SIDMappingDefFile. |
SIDMapping definition
In document router 4 the SID mapping for linking does not exist anymore via SID mapping file (SIDMappingDefFile).
Instead you can use in schema definition the S like in this example
Code Block |
---|
[foobarInstance] SYSID = X |; |1 | MANDANT = X |; |2 | CONTREP = C |; |3 | LoginCL = S |; |0 |@SYSID@MANDANT |
Example Schemata
here the index files gives mandant and contrep and the LoginCL variable then contains the SAP connector instance id
or this:
Code Block |
---|
[foobarInstance]
CONTREP = C |; |1 |
LoginCL = S |; |2 | |
in this example the index file directly contains the SAP Connector instance id.
As you see, LoginCLis connected to the Variable S. We see it is concatenated from 2 others. So in index file, the concatenation from place 1 and 2 gives the variable value of LoginCL. This value is pointing to an existing SAP-Connector instance with this name.
Real Example
The Document Router is configured with index-Files. Those .idx-Files contain following lines:
Code Block |
---|
Q80;105;XY; |
Code Block |
---|
Q80;103;ND; |
Code Block |
---|
Q80;134;NF; |
Following the previous given Schemata-Example this would mean:
Q80 = SYSID
105,103,134 = MANDANT
XY,ND,NF = CONTREP
In the Schema above is in Line 5 following configured as “S” (SIDLinking) : @SYSID@MANDANT
whereas @SYSID is on place 1 and @MANDANT is on place 2
That means, the DocumentRouter 4.x will concatinate Field 1 and Field 2 and try to find a SAP-Connector-Instance with that Name. In this Example with those three different Index-Files the Document Router tries to call SAP-Connector-Instance:
Q80105
Q80103
Q80134
Means: If those Connections are available (and configured in the SAP-Connector), the DR will Link to those individual SAP-Configurations.