SAPERION ECM R/ Link for SAP Customizing - Kofax · PDF file2.1 Maintaining Basic Settings 1 SAPERION ECM R/ Link for SAP Customizing 1 Introduction This documentation shall accompany

SAPERION ECM R/ Link for SAP Customizing

Copyright © 2016 Lexmark. All rights reserved.

Lexmark is a trademark of Lexmark International, Inc., registered in the U.S. and/or other countries. All other trademarksare the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in anyform without the prior written permission of Lexmark.

Table of Contents

1 Introduction ......................................................................................................... 1

2 Basic Configuration ArchiveLink ........................................................................ 1

2.1 Maintaining Basic Settings ................................................................................. 1

2.2 Setting Up an Output Device ............................................................................. 2

2.3 Maintaining Content Repositories ..................................................................... 2

2.4 Defining Document Types .................................................................................. 3

2.5 Maintaining Links ................................................................................................ 4

2.6 Creating Queues .................................................................................................. 4

2.7 Creating Archiving Jobs ...................................................................................... 4

2.8 Maintaining Range of Numbers ......................................................................... 5

3 Configuring Archiving Scenarios ........................................................................ 5

3.1 Introductory Remarks ......................................................................................... 5

3.2 Archiving Outgoing Documents ......................................................................... 5

3.2.1 Configuration in SAP for Outgoing Documents ............................................ 6

3.2.2 Configuration in SAPERION for Outgoing Documents ................................ 6

3.3 Archiving Print Lists resp. DART Files ............................................................... 7

3.3.1 Configuration in SAP for Archiving Print Lists resp. DART Files .................. 7

3.3.2 Configuration in SAPERION for Print Lists resp. DART Files ....................... 7

3.4 Archiving Data Archiving Files ........................................................................... 8

3.4.1 Configuration in SAP for Data Archiving Files .............................................. 8

3.4.2 Configuration in SAPERION for Data Archiving Files .................................. 9

3.5 Archiving Incoming Documents ........................................................................ 9

3.5.1 Archiving Incoming Documents with Integration of SAP Workflow ............. 10

Configuration in SAP for Incoming Documents with Integration of SAP

Workflow ........................................................................................................

10

Configuration in SAPERION for Incoming Documents with Integration of

SAP Workflow ................................................................................................

10

Scenario: Archiving Incoming Documents with the SAPERION Client ...... 11

3.5.2 Archiving Incoming Documents with Barcode .............................................. 12

Configuration in SAP for Incoming Documents with Barcode .................... 12

Configuration in SAPERION for Incoming Documents with Barcode ........ 13

3.6 Archiving Documents via SAP DMS .................................................................. 14

3.6.1 Configuration in SAP for Documents via SAP DMS ..................................... 14

3.6.2 Configuration in SAPERION for Documents via SAP DMS .......................... 14

4 Communication Interface Settings for Document Archiving and Display ........ 15

4.1 Setting up the Communication Interface in SAP .............................................. 15

4.2 Application Maintenance in SAP ........................................................................ 15

4.2.1 Application Maintenance for the Display of Documents .............................. 16

4.2.2 Application Maintenance for Archiving Documents ..................................... 17

4.2.3 Application Maintenance for the Function "Close window" ......................... 17

4.3 Configuration of Protocols for the Display of Documents ................................ 18

4.3.1 Document Display in the SAPERION Client .................................................. 18

4.3.2 Document Display in the SAP Viewer (Standard Communication) .............. 19

4.3.3 Document Display in the Viewer of the Operating System ........................... 19

4.4 Configuration of Protocols for Archiving of Documents ................................... 20

4.4.1 Document Archiving in the SAPERION Client .............................................. 20

4.4.2 Document Archiving in SAP (Standard Communication) ............................. 21

5 Appendix .............................................................................................................. 21

5.1 Configuration Files ............................................................................................. 21

5.1.1 Configuration in the PROGRAM.INI .............................................................. 21

[Setup] Section ............................................................................................. 21

5.1.2 Configuration in the ARCHIEF.INI ................................................................. 21

[RLINK] Section ............................................................................................. 21

[Setup] Section .............................................................................................. 22

5.2 HTTP Return Codes ........................................................................................... 22

5.3 Streaming of Application Files ........................................................................... 23

2.1 Maintaining Basic Settings

1

SAPERION ECM R/ Link for SAP

Customizing

1 Introduction

This documentation shall accompany you during customizing SAPERION ECM R/ Link for SAP.

You will not find any SAPERION implementation description, but we will advise you at the appropriate

situation to refer to the SAPERION administration manual. The installation of the R/ Link Server can

be found in the SAPERION installation documentation. The configuration of application and scenario

of SAP will only be described in selected examples in order to help you get started. Further information

about configuration can also be found in the documentation of SAP ArchiveLink interface and in SAP

scenarios of the application in which single detailed scenarios are described.

This documentation is divided in the following sections:

+ basic configuration

+ configuration of archiving scenarios for outgoing, incoming, DMS-documents and data archiving

objects.

+ communication settings for the display and archiving of documents

+ information for administrators regarding special configuration

2 Basic Configuration ArchiveLink

Basically, the maintenance of archiving systems and linking are necessary for archiving with SAP

ArchiveLink. When specifying a HTTP archiving system, a certificate of the SAP system has to be sent

additionally to the archiving system.

The following settings have also to be made: basic settings, output devices, queues, jobs and range of

numbers.

i In the following explanations of customizing transaction codes are used instead of menu paths to

reach single screens, because the documentation is then independent from the different releases

of SAP. The documentation contains figures that are mostly screenshots of a SAP system of the

version SAP ERP 6.0.

2.1 Maintaining Basic Settings

You can maintain the basic configuration via the transaction OAG1. In this step, you define first basic

settings for archiving with SAP ArchiveLink. The print list administration in the document administration

system (DMS) has to be deactivated when you are saving print lists via the ArchiveLink interface.


2

When the option "Permit multiple assignments" is selected, it is possible to assign multiple pre-settings

to one document type. "Generate Event ASSIGNED" refers to archiving scenarios where SAP business

workflow is involved. Due to performance reasons you may also deactivate this option.

Fig. 2–1: Transaction OAG1: ArchiveLink basic settings

2.2 Setting Up an Output Device

The output device is the logical printer to which the spool is sending archiving tasks. For archiving of

print lists you have to specify the output device in the spool administration. By default, the output device

ARCH is set up (via the profile parameter "rspo/default_archiver").

You can set up an output device with the transaction SPAD. The following parameters have to be set:

Fig. 2–2: Transaction SPAD: Output device

Transaction SPAD: Output attributes

Parameter Description

Output Device can be freely selected

Short Name ARCH

Device Type To each output device a certain device type has to be defined. From SAP version 4.0 on AR-

CHLINK or ARCHIXOS has to be specified here.

Spool Server will be set automatically

Device Class "A" for Archiver

Model can be freely selected

Location can be freely selected

In the tab "Access Method" you have to make the following settings:

Fig. 2–3: Transaction SPAD: Access method

Transaction SPAD: Access method


Host Spool Access Method "I" for archiving device

2.3 Maintaining Content Repositories

Content Repositories are set up with the archiving type HTTP Content Server. Content Repositories

are specified unambiguously through their names. The name can only be defined when setting up the

content repository and should contain two characters. Editing at a later stage is not possible.

The maintenance of content repositories is possible via the transaction OAC0: Set up a new content

repository and choose "Full administration".

For the configuration of a content repository the following parameters have to be set:

2.4 Defining Document Types

3

Fig. 2–4: Transaction OAC0: Change Content Repositories

Parameter content repository


Content Rep. can be freely selected

Description Enter a meaningful text

Document Area Indication of the context for document processing (ArchiveLink)

Storage Type Select the entry "HTTP content server"

Protocol Select an appropriate protocol. (You can set this parameter also at a later stage).

Version no. "0045", according to the selected protocol

HTTP server Specify the IP address of the R/ Link (IIS) server

Port Number Specify the port of the R/ Link (IIS) server

SSL Port number Specify the SSL port of the R/ Link (IIS) server when communication via SSL is required

HTTP Script Specify the name of the virtual directory at web server and the name of the script

(SARLIIS.DLL)

Basic Path In this directory SAP provides the documents to be stored asynchronously (e.g. ALF). The

here entered path is viewed from the SAP application server and can be defined as desired

(network path, etc.). There must be write and read permissions for the SAP server (central

instance and application server).

Phys. arch. path You have to use the same path as used under basic path in order to enable the data ex-

change between different applications of SAP, e.g., ADK and ArchiveLink.

Output Device Select the set up output device.

No signature This parameter defines whether signature is to be used basically. Further settings in the

configuration files of the R/ Link Server are necessary. We recommend to work with signa-

tures for reasons of safety.

After saving the content repository a certificate needs to be sent to the content server for working with

signed URLs. You have to activate this certificate at the content server to enable the storage of documents

(see also the documentation for the installation of the R/ Link Server).

2.4 Defining Document Types

Document types are configured in the SAP system by default and can be used for archiving scenarios.

If required additional document types can be configured.

The maintenance of document types is accessible via the transaction OAC2. Here, you have the

possibility to add new document types according to the figure below. You are also allowed to copy the

existing document types and then adapt them as needed.


4

Fig. 2–5: Transaction OAC2: Display document types

2.5 Maintaining Links

The maintenance of links between business object, document types, content repository and link table is

a basic component of the administration concept of the ArchiveLink interface. Here, you can specify the

storage system in which document types are copied and which link table is administrating the reference

between business object and archived document.

By default the link tables TOA01 to TOA03, TOAHR (for data from the HR module) and the table TOADL

(for print lists) are available.

i You cannot select the link table TOADL directly. For this purpose select the table TOA01 and via

ArchiveLink the linking entry will be written automatically into TOADL when storing a print list.

Furthermore, you can configure a retention time for the references in the link table. The maintenance of

links is possible via the transaction OAC3. Please make the settings according to the following figure.

Fig. 2–6: Transaction OAC3: Links for content repositories

2.6 Creating Queues

With the transaction OAQI you can create queues (CARA, CFBC, CFBA, CBAR, and also the according

error queues) to the functions represented in the figure below and also a queue administrator.

These queues are required when storing print lists in the archive.

Fig. 2–7: Transaction OAQI: Creating ArchiveLink queues

2.7 Creating Archiving Jobs

With transaction SM36 you are planning the ARCHIVELINK job that is required for processing the queues

(created in the previous step). The ARCHIVELINK job validates in the first step whether the queues are

containing any entries. If so, the according jobs of single queues are called and executed.

The ARCHIVELINK job can be planned periodically as circumstances require in the production system.

The job name can be freely selected, the job class must be entered. After saving you can specify further

parameters for the job. Select the ABAP program and enter "ILQBATCH". After validation you can save

your entries. Then you are led to the initial screen. When you are creating the job for the production

system you are allowed to specify the starting conditions and the interval for the periodic execution of

the job. In development or integration systems the creation of jobs is not necessary, here, archiving can

be processed also manually.

2.8 Maintaining Range of Numbers

5

Fig. 2–8: Transaction SM36: Creating archiving jobs

2.8 Maintaining Range of Numbers

For the creation of unambiguous file names for archived documents and order numbers for

asynchronous orders, ARCHIVELINK range of numbers must be configured. With transaction OANR

you can create, view and modify intervals of range of numbers.

! Range of numbers must not be transported into other systems because by doing so

inconsistencies in the database may occur. Furthermore, range of numbers depends on tenants

and have to be maintain in each tenant.

Fig. 2–9: Transaction OANR: Display ArchiveLink range of numbers

3 Configuring Archiving Scenarios

3.1 Introductory Remarks

The SAP ArchiveLink interface supports in conjunction with SAPERION SAP Suite Basic (R/ Link) as

external archiving system the archiving and the research od documents in SAP application components.

SAP ArchiveLink enables the archiving of incoming and outgoing documents and print lists and also

the archiving of application data. Possible application scenarios are introduced shortly in the following

chapters. The following illustration of possibilities of SAP ArchiveLink is only a brief overview. You will

find further information in the current document of SAP ArchiveLink interface. Information about which

archiving scenarios are supported for diverse document types are also described here.

3.2 Archiving Outgoing Documents

Outgoing documents are documents that are created in the SAP application components, e.g., invoices

demand notes, delivery notes etc. They are normally printed and sent by users.

Outgoing documents can be outsourced into external storage systems,

+ when created by SAPScript or Smartforms and

+ when archiving is supported by the corresponding business application component.

From SAP release 4.0B on the document type PDF is used exclusively for outgoing documents. The

activation of archiving in SAPERION can be configured in basic setup for SAP ArchiveLink (base

settings). After adjusting the relevant configuration in the message control, messages can be printed,

archived or printed and archived at the same time.

A typical use case for outgoing documents is the order confirmation.


6

3.2.1 Configuration in SAP for Outgoing Documents

Prerequisite for archiving outgoing documents is the configuration of document type in SAP and its

linking to a content repository (basic configuration).

Typically, the document type "Z_AB" is configured in transaction OAC2 for archiving order confirmation

documents.

Fig. 3–1: Transaction OAC2: Creating document type

In transaction OAC3 the document type is linked with the content repository "R2".

Fig. 3–2: Transaction OAC0: Create content repository R2

In transaction OAC3 the document type is linked to the business object and the content repository "R2".

Fig. 3–3: Transaction OAC3: Maintaining the link

In order that outgoing order confirmation for printing is archived automatically also in SAPERION, the

settings in the message control have to be made. The message control can be accessed via transaction

NACE or via the ArchiveLink monitor. You have to configure the archiving system for the used message

type.

Fig. 3–4: Transaction NACE: Customizing message type for the order confirmation

Here, you can link the used message with the configured document type and then choose one of the

archiving mode:

+ print only

+ print and archive

+ archive only

In this example, a new order confirmation will be printed and archived in SAPERION at the same time.

3.2.2 Configuration in SAPERION for Outgoing Documents

For archiving outgoing documents you need to create a new index table that contains at least the field

SAPDOCID. The field SAPDOCID is of the type "Character" (length 40). For completion of the scenario

an index and query is made available.

Then configure the R/ Link Server in SAPERION MMC.

Create the content repository R2 at R/ Link Server. The name of the content repository must be identical

to the name specified in SAP.

Select the "HTTP protocol" checkbox (RFC communication is not supported anymore).

In the "HTTP" tab the index table is assigned to the content repository via the selection button. You can

also activate the "Ignore delete" checkbox if required. The information about the script is only required

for SAPERION multitenant systems.

In the "Field mapping" tab default settings with fix values and variables can be set.

3.3 Archiving Print Lists resp. DART Files

7

All further tabs of this configuration dialog don't need to be considered in this context.

After successful archiving of documents from SAP the documents are searchable and displayable in the

SAPERION index table.

Fig. 3–5: Query form in SAPERION: SAP outgoing documents

3.3 Archiving Print Lists resp. DART Files

Print lists created in the SAP system that are ABAP lists and screen lists can be archived in an external

archiving system. Print lists are archived asynchronously. Further information can be found in the SAP

ArchiveLink documentation.

3.3.1 Configuration in SAP for Archiving Print Lists resp. DART

Files

The basic configuration in SAP is prerequisite for archiving of print lists in SAPERION. When setting

up the content repository, you have to consider that the archiving path of the spool process in SAP is

accessible and appropriately dimensioned.

Fig. 3–6: Transaction OAC0 for print lists

To this content repository a document type is assigned in transaction OAC3 for archiving print lists, the

document type is "ALF".

Fig. 3–7: Transaction OAC3 for print list

For archiving of DART files the following link must be selected: object type and document type must

not be changed.

Fig. 3–8: Transaction OAC3 for DART files

This can be set in transaction OAC3 or FTWP.

3.3.2 Configuration in SAPERION for Print Lists resp. DART Files

For archiving print lists, an index table has to be created in SAPERION which contains at least the field

SAPDOCID which must be of the type "character" and must have the length of 40. To complete the

scenario an index and query form can be created.

Fig. 3–9: DDC with index field SAPDOCID

Then configure the R/ Link Server in SAPERION MMC.

Create the content repository RP at R/ Link Server. The name of the content repository must be identical

to the name specified in SAP.

Fig. 3–10: Configuration R/ Link in the MMC - general

Select the "HTTP protocol" checkbox (RFC communication is not supported anymore).


8

In the "HTTP" tab the index table is assigned to the content repository via the selection button. You can

also activate the "Ignore delete" checkbox if required. The information about the script is only required

for SAPERION multitenant systems.

Fig. 3–11: Configuration R/ Link in the MMC – assign index table

In the "Field mapping" tab default settings with fix values and variables can be set.

Fig. 3–12: Configuration R/ Link in the MMC - field mapping

All further tabs of this configuration dialog don't need to be considered in this context.

After successful archiving of print lists from SAP the documents are searchable and displayable in the

SAPERION index table.

Fig. 3–13: SAPERION query form

In the structure window of archived print lists two sub-structures are represented, one for the print list

and one for the description file. A viewer for print lists is not a component of the software.

3.4 Archiving Data Archiving Files

Archiving of application data serves to remove mass data which have to be kept for evaluation but are

no longer needed otherwise in the system, from the database. The data archiving concept of SAP is

based on the Archive Development Kit. Data are written from the database to archive files by means of

archiving objects developed by SAP. These objects also reflect business correlations. Archiving files are

stored via SAP ArchiveLink in a connected archiving system. The archiving process consists essentially

of three single steps:

1. Creation of the archiving file

2. Storing of the archiving file

3. Deletion of data from the database

3.4.1 Configuration in SAP for Data Archiving Files

The configuration of data archiving in the SAP system is set by means of the SARA transaction. Here,

you assign a content repository to archiving objects.

Fig. 3–14: Transaction SARA: Configuration data archiving SAP

The content repository for data archiving is reserved exclusively. The document area is "Data archiving".

The archiving paths must be accessible for the SAP system because they are used as writing paths. They

have to be sufficiently dimensioned.

3.5 Archiving Incoming Documents

9

Fig. 3–15: Transaction OAC0: Data archiving

3.4.2 Configuration in SAPERION for Data Archiving Files

For archiving of SAP data archiving files an index table is created which contains at least the field

SAPDOCID. The field SAPEDOCID is a character with 40 characters. For completion of the scenario you

can create a index and query form.

Data archiving files are archived as streamed files in SAPERION. A viewer is not available.

Fig. 3–16: DDC with index field SAPDOCID

Then you have to make the configuration of R/ Link Server in SAPERION MMC.

The content repository "RD" is created at the R/ Link Server. The name of the content repository is

identical to the name in SAP.


Select the "HTTP-Protocol" checkbox (RFC communication is longer supported).

In the "HTTP" tab the index table is assigned to the content repository via selection button. You can also

activate optionally the "Ignore delete" checkbox. The script information is only necessary for multi-client

systems.

Fig. 3–18: Configuration R/ Link in the MMC - HTTP

In the "Field mapping" tab default settings with fixed values are specified..


Fig. 3–20: SAPERION query form: data archiving documents

You can activate the structure window in SAPERION, a viewer is not available.


You will apply this process when you need to archive incoming documents in your storage system and to

link them to the corresponding SAP application receipts. Incoming documents are all documents that

are not created by SAP script or SAP smart forms in its SAP system:

+ scanned documents

+ local desktop files (also files you have created yourself are also incoming documents for this

purpose)

+ faxes and e-mails

ArchiveLink supports different archiving scenarios which are described in detail in the SAP

documentation.


10

3.5.1 Archiving Incoming Documents with Integration of SAP

Workflow

For archiving incoming documents using business workflow you have to make further adaptations in

addition to the described configuration. As an example here, incoming invoices have to be archived.

Settings for the content repository are made by the OAC0 transaction.

Fig. 3–21: Transaction OAC0: Content repository for incoming documents

3.5.1.1 Configuration in SAP for Incoming Documents with Integration of

SAP Workflow

Although the document type is freely selectable but we recommend to adapt the existing document type

(here: ZFIIINVOID). Furthermore, this document type has to be linked to the SAPERION archive (here:

"RE").

Fig. 3–22: Transaction OAC3: Incoming documents with workflow

You have to define the document type as workflow document type in order to assign it to according

presets. This maintenance is executed by means of a wizard that leads you through all necessary steps.

The document wizard is accessible via transaction OAD5. Alternatively the configuration is possible via

the SAP reference IMG or the ArchiveLink monitor.

Fig. 3–23: Transaction OAD5: Document type customizing wizard

You will get further information resp. input help for single steps for workflow document types directly in

the wizard. After having finished the preset click the [Finish] button.

3.5.1.2 Configuration in SAPERION for Incoming Documents with

Integration of SAP Workflow

For archiving of SAP incoming documents an index table is created which contains at least the field

SAPDOCID. The field SAPEDOCID is a character with 40 characters. Additional index fields can be used

for information about scanning.

Fig. 3–24: Creating a DDC for incoming documents


The content repository "RE" is created at the R/ Link Server. The name of the content repository is

identical to the name in SAP.

Fig. 3–25: Configuration R/ Link for content repository RE - general

Select the "HTTP-Protocol" checkbox (RFC communication is longer supported).



systems.

Fig. 3–26: Configuration RE in the MMC – HTTP


11

For archiving incoming documents you have to make the configuration in the "Host" tab and "Logical

system". In the "Host" tab information about the target SAP system is entered.

Fig. 3–27: Configuration RE in the MMC - host

Configuration RE in the MMC – host


Host IP or host name of the SAP system

Service Service port according to the system number

System-Nr. System number of the SAP system

SID System ID of the SAP system for usage in i.e. the presets (optional)

In "Logical system" tab you define via the [New] button a new logical system.

Fig. 3–28: Configuration RE in the MMC – logical system

Logical system


Name Name of the logical system from SAP (Transaction OY25)

Client Used client in SAP

User SAP user for the communication SAPERION-SAP (user type: communication)

Password Password of communication user

Repeat Repeat of password of communication user

Archive Name of the content repository

Form Name of the used index form

Protocol, directory, table These entries are only necessary for RFC communication

In the "Field mapping" tab you can specify default settings with fixed values.

Fig. 3–29: Configuration RE in the MMC – field mapping

Create the necessary index and query forms in SAPERION. Furthermore, maintain the format rules

for archiving structured documents. They are strictly mandatory using the SAP Viewer and also other

external viewers. Make sure that when using scanners multipage-TIFFs are created. This is archived by

configurations in the ARCHIEF.INI of the scan client, see chapter 4.

3.5.1.3 Scenario: Archiving Incoming Documents with the SAPERION Client

Documents are scanned with the SAPERION client and are in the document tray as structured

documents.

Fig. 3–30: SAP document tray SAPERION

Changeover to SAP GUI. You will reach the preset via the SAP menu "Archive business documents" or

via transaction OAWD.

Fig. 3–31: SAP ArchiveLink menu archive document (show default settings)


12

After selection of the required scenario a window opens for capturing documents.

Fig. 3–32: Transaction OAWD – creating a work item

Confirm with the green button. By doing so the SAPERION client is automatically opened. The configured

index form opens, by clicking the [OK] button the document will be archived.

Fig. 3–33: SAPERION index form

After the work item has been created in SAP it can be executed in SAP Business Workplace.

Fig. 3–34: Archiving document

After successful processing in SAP the linking entry is written in SAP and the document is retrievable

from SAP.

Fig. 3–35: Business Workplace

3.5.2 Archiving Incoming Documents with Barcode

You can apply barcode scenarios in your company when you do not want to change the process to work

but need to automatize the archiving of documents.

There are two different scenarios that are supported by ArchiveLink:

+ Late archiving with barcode

The archiving is temporally after the capturing of accounting documents in the SAP system for

example. This scenario is suitable when high number of receipts occurs in order to automatize the

linking process of SAP documents with archived documents. With this scenario it is also possible

to link exactly one document with multiple SAP business objects.

+ Early archiving with barcode

The archiving is temporally before the capturing of accounting documents. The document is

archived early but although will be transported in paper form to the person responsible. With this

scenario it is possible to link multiple incoming documents with exactly one business object. In

addition to the generic object services it is possible to assign a document's barcode to an already

existing application document and therefore to create subsequently a link to this document.

3.5.2.1 Configuration in SAP for Incoming Documents with Barcode

The barcode scenario is configured in transaction OAC5. You can specify for which document type and

user a barcode pop-up appears when capturing the barcode.

For the scenario "Early/ late capturing with barcode" an appropriate document type with the business

object BKPF and a content repository should be assigned for incoming invoices. Also the responsible

user and the barcode type is assigned.

Fig. 3–36: Transaction OAC5: activate barcode

Following options can be selected additionally:


13

Settings for barcode entry

Option Description

Barcode active Activates barcode popup when capturing receipts.

Check is active Only checked barcodes are saved.

No cancel The entering of barcode is prerequisite for exit of the dialog.

HoldR/3 entry The internal open barcodes are not removed after linking.

Hold externally The external open barcodes are not removed after linking.

With these entries you have released the barcode scenario for a receipt type. Then you have to define

for which accounting area and account type the barcode scenario is to used. These settings are made

in the transaction OBD5.

i Please consider the OSS hint 76183.

In the application SD you will find these settings in the transaction VNOP and in module HR the table

T5850 has to be maintained.

Fig. 3–37: Transaction OBD5

If you have setup the described configuration the following index form for entering barcodes is available

when capturing incoming invoices.

Fig. 3–38: Enter barcode

This barcode is then assigned to the receipt in SAP. It is in the table of opened barcodes (BDS_BAR_IN)

until the entry with the same barcode is created when document is archived.

3.5.2.2 Configuration in SAPERION for Incoming Documents with Barcode

The customizing is the same as described in chapter "Configuration in SAPERION" for archiving

documents via SAP workflow. Important is the configuration in the "Logical system" dialog of R/ Link

Server.

Fig. 3–39: Dialog "Logical System"

The assignment of the index form to the content repository has to be unique. By means of the index

form the content repository is defined to which barcodes of SAPERION are sent.

In the index form, there must be a variable which name is starting with "R3". The content of this variable

is then sent to the content repository.

The barcode is entered automatically or manually into the index form. After archiving the R/ Link Server is

sending it and SAPDOCID to SAP into the table BDS_BAR_EX. The matching of the tables BDS-BAR_IN

and BDS_BAR_EX in SAP is executed automatically.

Fig. 3–40: Variable "R3Barcode" in the index form


14

The barcode is populated automatically or manually in the index field. After archiving the R/ Link Server

is sending this barcode and the SAPDOCID to the SAP table BDS_BAR_EX. The matching of the tables

BDS-BAR_IN and BDS_BAR_EX in SAP is performed automatically.

3.6 Archiving Documents via SAP DMS

3.6.1 Configuration in SAP for Documents via SAP DMS

For archiving documents via SAP document administration system an archiving category is configured.

Fig. 3–41: Creating archiving category

You assign a content repository to this category. As document area you select "DMS".

Fig. 3–42: Transaction OAC0 for DMS

3.6.2 Configuration in SAPERION for Documents via SAP DMS

For archiving of SAP-DMS documents an index table is created which contains at least the field

SAPDOCID. The field SAPEDOCID is a character with 40 characters. For completion of the scenario you

can create a index and query form.

The documents are archived in SAPERION according to their document type either as application file or

streamed file. Further information can be read in chapter "Streaming of application files when archiving

outgoing SAP documents".

Fig. 3–43: Creating a DDC with index field SAPDOCID


The content repository R1 is created at the R/ Link Server. The name of the content repository is identical

to the name in SAP.


Select the "HTTP-Protocol" in in the checkbox (RFC communication is no longer supported).



systems.

Fig. 3–45: Konfiguration R/ Link in der MMC - Zuordnung Indextabelle

In the "Field mapping" tab default settings with fixed values are specified.


The archived document can be retrieved as application file in SAPERION.

4.1 Setting up the Communication Interface in SAP

15

Fig. 3–47: SAPERION query form: SAP DMS documents

4 Communication Interface Settings for Document

Archiving and Display

By means of the maintenance of the communication interface you can specify how SAP ArchiveLink

functions like display, archiving and supply are processed for used documents types.

Via the application maintenance you can define the sequence of requests for each function which are

sent from the SAP system to SAPERION in order to execute the function.

4.1 Setting up the Communication Interface in SAP

The configuration of protocol settings is for example in transaction OAA3. Here a log can be created.

Fig. 4–1: Create new protocol

The protocol's name can be chosen freely. At HTTP communication select version 0045 or 0046

according to the specification in transaction OAC0 for the content repository.

Fig. 4–2: Version number

Enter any description in the description field. Save the protocol and assign it to a content repository

after confirmation.

The following functions can be maintained in the protocols: display and archiving of documents, closing

the display window.

Fig. 4–3: Assignment in transaction OAC0

4.2 Application Maintenance in SAP

If you want to use the SAPERION client for display resp. archiving documents, you have to make the

application maintenance.

Applications are using a communication with the SAPERION API via OLE automation 2.0.

For each function a sequence of OLE-functions can be defined which are processed at runtime. The call of

SAPERION API is executed via the description of applications in the protocol administration. If you want

to use applications, you have to select the value "OPEN" for the communication type in the protocols.

Prerequisite for the usage of the SAPERION application in SAP is the configuration in the transaction

SOLE. Here, the applications SAPERION.Document and SAPERION.Application are registered. The

following settings are necessary:

4 Communication Interface Settings for Document Archiving and Display

16

Transaction SOLE

OLE Application SAPERION.Document SAPERION.Application

Version number

CLSID {131A23A0-54F3-11CF-BF4D-00AA0057893A} {42a01000-7cd8-11cf-bf51-00aa0057893a}

CLSID TypeLib

OLE-Object name SAPERION.DOCUMENT SAPERION.APPLICATION

TypeInfo-Key NO_TYPELIB NO_TYPELIB

Include Program

Language

Check permission

Text

Fig. 4–4: Application maintenance SAPERION transaction SOLE

The maintenance of registered applications is done via transaction OAA4. Information of maintenance

of activities is in the online help of the SAP system.

For each content repository resp. each assigned SAPERION index table an application has to be created.

The SAPERION index table is specified in the application maintenance. A new application is created via

the [NEW] button.

Fig. 4–5: Transaction OAA4: Application maintenance

With a double click on the application name a functional overview opens in which you have to maintain

each single function.

Fig. 4–6: Functional overview for an application

4.2.1 Application Maintenance for the Display of Documents

The maintenance dialog opens by a double click on "Display archived document".

Fig. 4–7: Application maintenance

For the display of documents with the SAPERION Viewer the function has to be configured as follows:

Application maintenance

Method Command Description

Appplication SAPERION.Document Selction of application

Method Set Get Command Description

x DBName=SAPDoks Set SAPERION.Document property "DBName"

x AddProperty sWindowID,1

x ALLOad@DID Load document with transferred document ID

x Editimage/ show Edit/ display document

4.2 Application Maintenance in SAP

17

Checkbox Command Description

Activated Release created object after call The created object has to be released after call.

4.2.2 Application Maintenance for Archiving Documents

The dialog opens after a double click on the function "Archive from frontend". For the maintenance of

documents with SAPERION client the function must be configured as follows:

Fig. 4–8: Application maintenance

Application maintenance


Application SAPERION.Document Selection of application


x DBName=SAPDoks Set SAPERION.Document property "DBName"

x ALGetCurrentDOC 1, separation, ",SAPDoks_i,1 Description see below

x @DID=ALUID Transfer SAPDOCID from SAP to SAPERION

x @EID=ALRETC Transfer of the return code for this action



The parameters of the method "AlGetCurrentDoc" have the following meaning:

ALGetCurrentDOC 1,separation,",SAPDoks_i,1

Parameter 1: document tray

Parameter 2: Name of the format rule or @DTI for the document type

Parameter 3:

Parameter 4: Name of the index form or @ for the activated form

Parameter 5: 1=Multipage TIFF (TRUE), 0 = Multipage TIFF (FALSE)

4.2.3 Application Maintenance for the Function "Close window"

The maintenance dialog opens when double clicking on the function "Close window". This function is

only active in the SAP Business Workflow. After the exit of the transaction the viewer window will be

closed automatically. All other viewer windows have to be closed by the user.

Fig. 4–9: Application maintenance "Close window"

The function has to be configured as follows:


18

Application maintenance "Close window"


Application SAPERION.Application Selection of the application


x closeAll@WID Closing the window with transferred window ID



A list of all possible OLE variables can be found in the documentation of the ArchiveLink interface.

4.3 Configuration of Protocols for the Display of

Documents

The following functions are in the area of display and can be configured individually:

+ display of archived documents

+ providing frontend

+ display of local file

+ close window

The function of display archived documents can be proceeded single-stage or double-stage.

+ Single-stage process: the order to view a document is sent to an internal viewer

+ Double-stage process: In cases the program with which the document is viewed has no access to

the archiving system the function is processed in the following two steps:

1. providing the archived document in a file at frontend

2. display of the file

4.3.1 Document Display in the SAPERION Client

In this chapter the display of documents with the SAPERION Rich Client is described. Information about

display of documents in the SAP Web Viewer is described in the SAPERION documentation portal.

The communication with SAPERION Client is processed in one stage. A OLE communication is executed.

The customizing is made depending on the protocol for each single data type in transaction OAA3. The

customizing for the display of documents with the type "FAX" for example is as follows:

Make a double click on the function "Display stored document" in order to open the maintenance dialog

for the single-stage communication.

Fig. 4–10: Maintenance SAPERION viewer

4.3 Configuration of Protocols for the Display of Documents

19

Select the data type "FAX" by activating the radiobutton and open the maintenance dialog by double click.


Select in the dialog the communication type "OPEN" from the list and also the application. This

application has to be created previously, see above.


Save your settings.

The document type is marked as "Maintained explicitly". When using the SAPERION viewer the login

dialog opens first and after successful login the viewer opens. If users are synchronized the viewer opens

directly.

4.3.2 Document Display in the SAP Viewer (Standard

Communication)

For the display of documents in the SAP viewer no frontend configuration is necessary. The SAP viewer

has to be installed on all working places and basic configuration (transaction OAG1) has to be activated

(select "ECL-Control").

Fig. 4–13: ArchiveLink basic configuration

The document types that should be displayed in the SAP viewer have the notation "Not maintained

explicitly (standard)".

4.3.3 Document Display in the Viewer of the Operating System

The communication with the viewer of the operating system for displaying documents is double-stage.

For this you have to configure the transfer of the file and for the display. This is made depending on the

protocol for each single file type in transaction OAA3.

The configuration for the display of documents of the type "TIF" for example is as follows:

Make a double click on the function "Providing frontend". The list of protocol settings opens for all

document types.

Fig. 4–14: Maintenance operating system viewer

Select data type "TIF" by activating the radiobutton. By a double click the dialog "providing frontend"

opens.

For the transfer of the files select the communication type "TABLE". By confirming the dialog the overview

dialog opens again and the customizing for "Display of local files" has to be opened.

Fig. 4–15: Maintenance operating system viewer

Select the communication type "ARCHIVELNK".

Via the [Program call] button or [Local program call] you can define a path for an application. This implies

that the application is installed there otherwise the document cannot be displayed.


20

Save your settings. The document type is marked as "maintained explicitly".

4.4 Configuration of Protocols for Archiving of Documents

4.4.1 Document Archiving in the SAPERION Client

The communication with the SAPERION client for archiving documents is single-stage. OLE

communication is executed. The configuration has to be protocol-dependent for each single file type in

transaction OAA3.

The configuration of document archiving with type "FAX" for instance can be as follows:

Make a double click on "Archiving at frontend" in order to open the maintenance dialog for single-stage

communication.

Fig. 4–16: Maintenance of archiving with the SAPERION Client

Select the data type "FAX" by activating the corresponding radio button. The maintenance dialog opens

per double click.

Fig. 4–17: Protocol maintenance SAPERION client

Select the communication type "OPEN" from the list and also the application.

Fig. 4–18: Protocol maintenance SAPERION client

Save your settings. The document type is now marked by "Maintained explicitly".

If you want to archive documents with this scenario, you should consider the following behavior pattern:

documents are scanned and have to be archived structured in the document tray. The transaction OAWD

is requested out of SAP and the required scenario will be selected by the user.

Fig. 4–19: Transaction OAWD

5.1 Configuration Files

21

By confirming with the [Continue] button the SAPERION client will be strated. After the login documents

are archived out of the document tray with the specified index mask.

4.4.2 Document Archiving in SAP (Standard Communication)

For the archiving of documents with the SAP GUI no frontend configuration is needed. Protocol settings

are not necessary for this purpose because the standard communication will be executed.

5 Appendix

5.1 Configuration Files

5.1.1 Configuration in the PROGRAM.INI

5.1.1.1 [Setup] Section

Example

[Setup]

FillSAPDocId=TRUE

[Setup] section

Parameter Client Server Description

FillSAPDocId x x The index field SAPDocId is filled. If this is not required

enter the value FALSE.

Default: TRUE

5.1.2 Configuration in the ARCHIEF.INI

5.1.2.1 [RLINK] Section

Example

[RLINK]

BarcodeSpoolDir=<Barcode spool directory>

HTTPTrace=True

MultipageImageComponent=TRUE

StreamThresholdMB=<Threshold value>

UseUnstructuredDocs=True

5 Appendix

22

[RLINK] section


BarcodeSpoolDir x

R/ Link

Enables the user-specific adaptation of barcode spool di-

rectory

HTTPTrace x

R/ Link

TRUE = activates the logging of HTTP calls in the

"*RLINK.LOG" file

MultipageImageComponent x

R/ Link

TRUE = R/ Link can create multipage-TIFFs out of struc-

tured images

Default: FALSE

StreamThresholdMB x

R/ Link

When large print lists are saved in TXT format R/Link

tries to transform them into application files and fails at

saving due to storing restrictions. With this parameter

you can specify a threshold value so that all documents

which are exceeding the stated size are tranformed to

streamed files.

No threshold is defined by default.

UseUnstructuredDocs x

R/ Link

TRUE = outgoing documents are archived unstructured

out of SAP.

This parameter has no effect to archiving structure of

print lists.

Default: FALSE

5.1.2.2 [Setup] Section

Example

[Setup]

DocLoadOriginal=False

[Setup] section


DocLoadOriginal x

Scan Client

TRUE = Forces the archiving of images in original format

at native clients.

FALSE = Scanned single pages are not transformed into

single TIFFs and therefore multipage-TIFFS can be crea-

ted out of scan pages.

Default: TRUE

5.2 HTTP Return Codes

In this section you will find a short compilation of return codes which may appear when archiving out of

SAP. Furthermore we provide information on how to solve possible error causes.

5.3 Streaming of Application Files

23

Return codes

Retrurn Code Meaning Troubleshooting

200, 201 "The request has been

processed successful-

ly."

none

400 "The structure of the

request message is in-

correct."

Was the connection test from transaction "csadmin" executed (unsuitable for the SAPERI-

ON administration)?

401 "Access denied" Was the certificate transmitted from SAP to SAPERION?

Is this certificate active?

Was R/ Link Server restarted after storing the certificate?

Is the "rlink.pab" file accessible for the R/Link Server (correct directory)?

404 "Page not found" Was the connection test successful from SAP (transaction OAC0)?

Was the web directory updated after installation of a hot fix?

Does the requested document exist?

405 "Method not allowed" Check whether the service "WEBDAV publishing" at IIS is deactivated (deinstall possibly).

500 "Server error" Is IIS or the SAPERION system started?

Is it possible to archive in the provided SAPERION index table outside of SAP (media,

pools, etc.)?

Are there any macros on the archiving event?

Are there any mandatory fields in the index table that are not populated by default settings?

Is IIS running in a 32 bit mode?

Does the call of R/ Link work locally on the SAPERION server? http://host:port/virtualDi-

rectory/sarliis.dll?serverinfopVersion=0045?

Is there any file size limitation for IIS?

5.3 Streaming of Application Files

SAP print lists, DART files and SAP archiving files are always stored as streamed files.

The following data types are archived as application files without any configuration:

Data types

Data Type Description

BMP image/bmp

DOC application/msword

DOCM application/vnd.ms-word.document.macroEnabled.12

DOCX application/vnd.openxmlformats-officedocument.wordprocessingml.document

FAX image/tiff

GIF image/gif

HTM text/html

JPG image/jpeg

MPP application/vnd.ms-project

5 Appendix

24

Data Type Description

MSG application/vnd.ms-outlook

OTF application/x-otf

PCX image/pcx

PDF application/pdf

PPT application/vnd.ms-powerpoint

PPTM application/vnd.ms-powerpoint

PPTX application/vnd.ms-powerpoint

PS application/postscript

RAW application/x-raw

RTF application/rtf

SCR application/x-scr

TIF image/tiff

TIF application/tiff

TIFF image/tiff

TXT text/plain

TXT application/x-note

XLS application/vnd.ms-excel

XLSM application/vnd.ms-excel.sheet.macroEnabled.12

XLSX application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

You can configure via the registry the archiving as application file for all other mime types.

For example, the data type "WMV" is represented in the path "HKEY_CLASSES_ROOT" of the registry

which enables the archiving as application file (standard, content type and PerceivedType must be

present).

Fig. 5–1: Registry for data type "WMV"