Versions Compared

Key

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

...

Inside this tab SAP connections can be defined.

Parameter

...

Name

Type

Description

Default Value

SAPLinkRemoteFunction

String

Within this field you may define the user function used for linking the documents to SAP Business Objects.

By default the following user function will be used: ARCHIV_CONNECTION_INSERT

(e.g.: ZKGS_ARCHIV_CONNECTION_INSERT)

ARCHIV_CONNECTION_INSERT

SAPCommit

...

Checkbox

This parameter may be used togehter with your own user remote function in order to execute explicitily a commit on the SAP database after inserting a link entry into the SAP ArchiveLink table.

...

false = No explicit commit will be done

...

true = An explicit commit will be done

Unchecked

SAPConnection

...

List

DropDown

Choose a SAP connection defined within the KGS SAP Connector.

...

If no connection is required, please choose

...

none

...

.

...

None

...

BCSAPGWHost

...

String

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

In case you’re using an SAP Gateway you may enter the gateway’s IP adress or hostname into this field.

This gateway hostname will serve as fallback for all content repository ID’s in case no explicit definition was provided for the content repository.

Please note: It’s good practice to always provide an explicit definition for the content repositories.

...

BCSAPGWServ

...

String

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

This field should contain the service number of the SAP gateway.

This service number will serve as fallback for all content repository ID’s in case no explicit definition was provided for the content repository.

Please note: It’s good practice to always provide an explicit definition for the content repositories.

...

BCSAPMSHost

...

String

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

If you’re using an SAP Message Server instead, you may enter the message server IP adress or hostname here.

This hostname will serve as fallback for all content repository ID’s in case no explicit definition was provided for the content repository.

Please note: It’s good practice to always provide an explicit definition for the content repositories.

...

BCSAPSystem

...

String

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

In order to use a load balanced RFC configuration this parameter has to contain the SAP systems name.

In load balanced scenarios this parameter requires the following parameters to be defined as well.

  • BCSAPMSHost

  • BCSAPGroup

This SAP system name will serve as fallback for all content repository ID’s in case no explicit definition was provided for the content repository.

Please note: It’s good practice to always provide an explicit definition for the content repositories.

...

BCSAPGroup

...

String

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

Here you may enter the name of the group of SAP application servers.

This SAP application server group will serve as fallback for all content repository ID’s in case no explicit definition was provided for the content repository.

Please note: It’s good practice to always provide an explicit definition for the content repositories.

...

BCSAPClient

...

String

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

Client needef for RFC communication with the SAP application server.

...

BCSAPUser

...

String

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

User name needed for the RFC communication with SAP application server.

...

BCSAPPassword

...

String

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

Password related to the user, which is being used for the RFC communication with SAP application server.

...

BCSAPLanguage

...

String

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

You may enter the language used for RFC ommunication with SAP application server in her.

E.g.: EN

This language will serve as fallback for all content repository ID’s in case no explicit definition was provided for the content repository.

Please note: It’s good practice to always provide an explicit definition for the content repositories.

...

BCSAPHost

...

String

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

The SAP Server’s IP address for RFC communication has to be entered here.

Note

Please note: Only valid IP adresses are allowed for this parameter, names are not being supportet.

This IP adress will serve as fallback for all content repository ID’s in case no explicit definition was provided for the content repository.

Please note also: It’s good practice to always provide an explicit definition for the content repositories.

...

BCSAPSysNr

...

String

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

Within this field you may enter the SAP system number for RFC communication with the SAP application server.

This system number will serve as fallback for all content repository ID’s in case no explicit definition was provided for the content repository.

Please note: It’s good practice to always provide an explicit definition for the content repositories.

...

BCSAPArchivDir

...

String

...

In case the BCSAPALProt-parameter is set to 3.1 you may define her the DMS archive directory from the perspective of the KGS DocumentRouter machine. It’s the same directory where the DMS expects document files when SAP sends an archiving request.

Note

Please note: It’s important the KGS DocumentRouter has to has read/write permissions to that directory.

...

BCSAPALProt

...

String

...

this field defines which ArchiveLink protocol version will be used by KGS DocumentRouter for document archiving.

The following entries are supported.

  • 3.1 → ArchiveLink protocol version 3.1

  • 4.5 → ArchiveLink protocol version 4.5

  • Direct → Setting this parameter to Direct means that the archiving takes places through the archiving vendor’s proprietary interface.
    In order to use the archiving system’s native interface it’s necessary to define the parameters Archive*-parameters (e.g.: ArchiveVendor,ArchivePassword,ArchiveHost, etc).

  • 0 → Setting this parameter to 0 means, that the archiving process is being skipped.

...

BCSAPIndexExportDir

...

String

...

If this parameter has been specified KGS DocumentRouter will use this path in order to generate index output files for every index input file. These output files contain the input index, added by the archived document ID which has been created when archiving the image file. The syntax for the filename is like this.

<Content Repository>_<Document ID>.idx

In order to enable the generation of index export files this parameter has to be supplied with a valid path.

Note

Please note: It’s important the KGS DocumentRouter has to has read/write permissions to that directory.

...

BCSAPLinkObject

...

PerformKeySetBeforeArchiving

...

Info

Please note: As of version 3.1.37, these parameters are deprecated. DocumentRouter will still support the former way of providing the SAP-connection per instance in case you're using old configuration files for setting up DocumentRouter instances.

When creating new instances you may choose from the list of SAP connections created in the SAP Connector.

In case you’re using an SAP Application Server as host, you may put it’s IP adress or hostname name into this field.

This hostname will serve as fallback for all content repository ID’s in case no explicit definition was provided for the content repository.

Please note: It’s good practice to always provide an explicit definition for the content repositories.

Checkbox

It is possible to get information from SAP via document id. If the document id is determined by external system, DocumentRouter can ask SAP before archiving for these information. Then while archiving via SAPALink it is possible to store these additional information as meta data into archive.

In order to get these information before archiving this flag needs to be checked.

Unchecked

BCSAPLinkObject

DropDown

The parameter BCSAPLinkObject defines whether a document should be

...

linked to an SAP business object

...

after archiving.

This parameter serves as fallback in case no explicit definition was found.

...

It’s good practice to always provide an explicit definition for the content repositories.

In case multiple file types are being processed the definition of a single file name extension determines which document types are being linked to SAP (e.g.: pdf|txt → All documents with the file extensions .pdf or .txt will be linked to SAP)

Note

...

In this scenario it’s importat the the parameter DocumentMimetype

...

doesn't contain any value.

File extensions are not limited to specific values.

You may enter the following values.

available settings:

  • Do not link to SAP

...

  • Link to business object

    • After archiving, it will be linked to an SAP business object

...

BCSAPIndexExportKeys

...

String

...

The parameter BCSAPIndexExportKeys defines which key values provided by the index file have to be used for generating index export files. Index values within the index file have to match with the following syntax.

indexname=value

In case multiple values arebeing exported they have to be separated by a vertical bar ( | ) symbol.

E.g.:

  • indexname1|indexname2|indexname3

  • Barcode|Index230

...

BCSAPSkipArchiving

...

Boolean

...

You may control with the parameter BCSAPSkipArchiving whether archiving shall be done or whether the archiving process hall be skipped, but the SAP linking shall be done only. This is especially useful for historical documents that have been archived already and only need to be linked to SAP.

The following values are supported.

  • 0 = Archiving is not being skipped

  • 1 = Archiving is being skipped

...

RecheckingType

...

  • Insert external barcode

    • inserts an external open barcode into the BDS_BAR_EX-table in SAP.

...

3 = KGS DocumentRouter will create an SAP Workitem.

...

file extensions = You may also provide a list of file extensions separated by a vertical bar |

  • Create SAP work item

1

RecheckingType

DropDown

You may define the level of checks done for the linking process to SAP.

You may choose from the following list provided by KGS DocumentRouter.

  • none = No ckecks will be done

  • normal rechecking = KGS DocumentRouter will check whether the document ID as well as the repository exist.

  • deep rechecking = KGS DocumentRouter will check whether document ID, repository and other parameters like Mandant, SAP document type and object ID exist.

None