Opentext Documentum Content Services For Sap: Configuration Guide
Opentext Documentum Content Services For Sap: Configuration Guide
Opentext Documentum Content Services For Sap: Configuration Guide
Configuration Guide
Legal Notice
Preface ................................................................................................................................. 7
3
Table of Contents
oaws—Settings ............................................................................................. 37
Optional for SAP workflow ........................................................................... 38
Optional for barcode ..................................................................................... 38
OAC5—Bar Code Settings ......................................................................... 38
Testing scanning documents .............................................................................. 39
4
Table of Contents
List of Figures
5
Table of Contents
List of Tables
6
Preface
Intended audience
In order to address the manuals to the correct audience, the roles of the users of the manuals have
been defined as follows:
• System Administrator — This role covers users who install and configure CS SAP. The Content
Services for SAP application integrates Documentum and the SAP R/3 system. Therefore, system
administrators must have experience with the software products listed in the Documentum Content
Services for SAP Release Notes.
• Content Services Administrator — This role covers users who manage CS SAP using WebAdmin.
• Document Controller — This role covers those who release documents to SAP and maintain the
links to those documents.
• Capture Operator — This role covers users who scan documents and create links to the
appropriate records in SAP.
• Standard User — This role covers users who view documents using SAPGUI and the View
component of CS SAP.
This manual is intended for system administrators.
Revision history
This section contains a description of this document’s revision history.
Revision history
7
Preface
Typographic conventions
This guide uses the following text conventions.
Convention Description
> Represents a pop-up or pull-down menu.
<Text enclosed within angle brackets> Represents a variable name for which you must
provide a value, or a defined term.
Represents code samples, user input, and
Information in this font
computer output.
[] square brackets Used in method command syntax specifications,
square brackets indicate an optional argument.
{} curly brackets Used in method command syntax specifications,
curly brackets indicate an optional argument
that can be repeated more than once.
Related documentation
This manual forms part of a documentation suite designed to support those who install, configure,
and use CS SAP. The product and documentation suite can be found on Online Support at
https://support.emc.com.
Documentum Content Services for Describes how to configure Content Services Administrator
SAP Administration Guide Content Services using the
WebAdmin tool.
8
Preface
Note: CS SAP extensively uses the SAP ArchiveLink component. Your SAP ArchiveLink
documentation has more information on how to perform advanced tasks.
9
Preface
10
Chapter 1
Introducing Content Services for SAP
Overview
The ®Documentum® Content Services for SAP (CS SAP) application integrates the Documentum
content management system with the SAP R/3 or ECC system. It is an interface to the SAP R/3 or ECC
system based on SAP standard Document Management System (DMS) and ArchiveLink interfaces.
CS SAP provides the following functions:
• Enables users to easily access and display documents stored in a Documentum repository from
a variety of SAP modules.
• Links documents stored in Documentum to a variety of SAP documents.
• Archives SAP data, reports, and documents through ArchiveLink certified interfaces in
Documentum.
Note: To use CS SAP with HTTP archiving services, install AS SAP, as described in the
Documentum Archive Services for SAP Installation Guide.
• Stores and manages reports and outgoing documents in Documentum.
11
Introducing Content Services for SAP
CS SAP architecture
Figure 1. CS SAP and SAP
Note: Content Services for SAP capture component is not present in the 7.2 release.
12
Introducing Content Services for SAP
13
Introducing Content Services for SAP
Enables you to release Documentum documents to SAP, and to maintain those released
documents.
Note: The Documentum Content Services for SAP Release Notes provides detailed information about
specific OS versions and supported software environments.
Term Definition
CS SAP Product that connects Documentum to and from
SAP.
ArchiveLink Cross-functional interface that is part of the SAP
Basis System. ArchiveLink handles the storing
and retrieval of documents and data to and from
a repository external to SAP.
WebAdmin An administrative console that allows you to
perform:
• Archiving services:
• DMS-related services:
14
Introducing Content Services for SAP
Term Definition
HVPS A server component that allows you to automate
the linking between SAP objects and documents,
as well as maintain those links. This automation
improves productivity, information integrity,
and information availability. This replaces the
CS SAP Agent component present in 5.3 and 6.0
releases. Unlike the previous Agent, HVPS is
completely a Java-based component.
SAP DMS Document Management System that is part
of the SAP Basis System. Presents a logical
layer to integrate with external systems like
AutoCAD or Documentum. Not directly related
to ArchiveLink.
SAP PLM Product Lifecycle Management (PLM). SAP
PLM provides an integrated environment
that ensures all personnel involved in product
development, manufacturing, and service have
quick and secure access to current information.
It provides a set of BAPI calls that can be used
by external systems like Documentum.
SAP Master Record A set of master data, such as customer or vendor
data, which is used in the creation of SAP
documents.
SAP GUI SAP graphical user interface. Graphical
menu/screen tool that connects a client to the
SAP server.
Original document Paper-based version of a document.
15
Introducing Content Services for SAP
16
Chapter 2
Configuring the ArchiveLink Interface
for CS SAP
Overview
You can store and retrieve documents, reports, and data through SAP ArchiveLink and DMS
interfaces.
Once a document is released to Documentum, it is accessible from SAPGUI (the SAP client interface).
It is also accessible from a Documentum Client such as Webtop.
Prior to running CS SAP, the SAP R/3 system must also be configured. This chapter describes how to
configure your R/3 ArchiveLink and other related transactions through SAPGUI and the R/3 system.
Note: The configuration steps often reference direct transaction codes. These codes allow you to
navigate directly to the correct configuration screen. Most of the system configuration is performed in
the SAP Implementation Guide for R/3 customizing (IMG). You can navigate to this screen using
the following transaction code: spro.
Archive Services are configured as an HTTP-based Archive Server.
Note: Documentum recommends that all installations be based on the HTTP-based Archive Server
because SAP has focused development on the HTTP-based archive protocol.
The various configuration tasks that you have to perform are described in the following sections:
• oac0—Defining a logical ArchiveID, page 17
• oag1—Configuring basic settings, page 18
• oanr—Configuring number ranges, page 18
• oaqi—Creating queues, page 19
• oaat—Scheduling jobs, page 19
• spad—Configuring optical archives as output devices, page 20
• sm50—Verifying spool processes, page 22
• sole—Maintaining OLE applications, page 22
• oaa4—Maintaining applications and configuring communications protocol, page 24
17
Configuring the ArchiveLink Interface for CS SAP
18
Configuring the ArchiveLink Interface for CS SAP
oaqi—Creating queues
When Print Lists are archived, the SAP print spooler puts the document into the asynchronous queue.
The scheduler then picks up the document and sends it to the archive. The queue serves as a buffer
for everything sent to an SAP archive. Other queues are used for outgoing documents and barcodes.
These queues can be seen on the ArchiveLink Monitor screen (transaction code: oam1). If this screen
shows the word MISSING instead of zeros, you must create queues and specify an administrator.
Define an SAP user with the proper ArchiveLink administrator profile as the administrator for this
queues. Defining an administrator will automatically create the queues. Check that the queues have
been created by reviewing transaction oam1.
To create queues:
1. Execute the following transaction in the transaction code field:
oaqi
The SAP ArchiveLink: Create All Queues (CFBC, CARA, CGDA) screen appears.
2. Fill in all the options with x.
3. Type a valid SAP login name in the Queue Administrator field.
4. Select Program > Execute.
5. Click Cancel to close the window.
oaat—Scheduling jobs
The SAP schedule job periodically checks the output queue and sends all the items in the queues to
the archive. You must configure the schedule job to successfully archive documents to an SAP archive.
To schedule a job:
1. Execute the following transaction in the transaction code field:
oaat
2. Create a new job.
3. Type the following in the ABAP Program field:
ILQBATCH
4. To verify that there are no errors, click Check.
5. Save your changes.
6. Click Back to return to the Define Background Job window.
19
Configuring the ArchiveLink Interface for CS SAP
20
Configuring the ArchiveLink Interface for CS SAP
8. Press Enter.
The dialog box changes.
9. Save your changes.
For this version, you will need to type additional information after you have configured your
archives.
10. Execute the following transaction in the transaction code field:
oac0
11. Click the pencil button to edit the settings.
12. Click New entries.
The Maintain View for Archive Device screen appears.
13. Fill in the ArchiveID you plan to use for Print lists. For example, AA.
14. Type ARCH in the Output Device field.
Repeat steps 13 and 14 for each archive.
15. Save your changes.
The archive device name changes from ARCH to Archive device.
21
Configuring the ArchiveLink Interface for CS SAP
22
Configuring the ArchiveLink Interface for CS SAP
sole
The Maintenance View for OLE Applications screen opens.
3. Click Edit.
4. Click New Entries to create a new entry for a supported OLE application.
5. Type the OLE application, press Enter, then double-click the selected entry.
The Details screen opens.
6. Fill in the fields listed below.
1. Start SAPGUI.
2. Execute the following transaction in the transaction code field:
sole
The Maintenance View for OLE Applications screen opens.
3. Click Edit.
4. Click New Entries to create a new entry for a supported OLE application.
5. Type the OLE application, press Enter, then double-click the selected entry.
The Details screen opens.
6. Fill in the fields listed below.
23
Configuring the ArchiveLink Interface for CS SAP
To configure applications’ maintenance and the communications protocol to associate the correct OLE
2 method to an SAP archive:
1. Execute the following transaction in the transaction code field:
oaa4
24
Configuring the ArchiveLink Interface for CS SAP
A window opens, listing the available applications configured for your SAP system.
2. Select Application Create.
The Application Maintenance dialog box appears.
3. Type DCTM in the Application field and click Back.
DCTM is added to the list of available applications in the Applications Maintenance window.
4. Select DCTM in the Applications list (usually by double-clicking).
5. Select Displayed Stored Document (usually by double-clicking).
6. For the View application, fill in the following information:
• Application: DMVIEW.DOCUMENT
7. Ensure that the Release generated object after call box is selected.
8. Return to the previous window and select Archive From Frontend (usually by double-clicking).
9. For the Scan application, fill in the following information:
• Application: DOCLINKSCAN.DOCUMENT
10. Ensure that the Release generated object after call box is selected.
11. Return to the previous screen and save your configuration.
12. Display the changes made to transaction oaa4 and be sure that Display Stored Document and
Archive From Frontend show Maintained.
13. Execute the following transaction:
oa3
You should see a screen for SAP ArchiveLink: Communications interface administration.
14. Select Create.
The New Protocol dialog box opens. For example, you may wish to define the protocol name as
CONSVC65 for CS SAP 6.5.
25
Configuring the ArchiveLink Interface for CS SAP
Special protocols
You have options for special use protocols which are configured slightly different from the standards
described earlier. Anonymous login allows your name and password to be provided each time a login
would normally be required. Another option is that you may wish to have Print Lists displayed in
26
Configuring the ArchiveLink Interface for CS SAP
the native proprietary format from SAPGUI instead of viewing them using Documentum renditions
as described earlier.
2. Ensure that the Release generated object after call checkbox is selected. Then continue with
Protocol for anonymous capture login.
27
Configuring the ArchiveLink Interface for CS SAP
2. Click Continue.
3. Ensure that the Release generated object after call checkbox is selected. Then continue with
Protocol for the SAP Inline Print List viewer.
SAP R/3 includes a Print List viewing feature that allows you to view saved Print lists with SAPGUI
in their native ALF format. To enable SAPGUI viewing, you must configure the protocol to support
the viewer.
Note: If you convert Print List to PDF with renditioning, they can be viewed and annotated without
SAPGUI.
To configure the Print List viewer to display the Print Lists in SAPGUI:
1. Select Create.
The New Protocol dialog box opens. For example, you may wish to define the protocol name
as ECONALF for Content Services for SAP with ALF viewer.
2. Type the HTTP-based archiving version of the protocol:
0045
Note: Type the HTTP archiving protocol, for example, ECONHTTPA.
3. Save your changes.
The Overview of a Protocol window opens, displaying your newly defined protocol.
4. Select Display Stored Document (usually by double-clicking).
The Overview of a Protocol window opens showing a list of document classes.
5. Select the * row which indicates all document classes.
6. Click the pencil button.
The Overview of a Protocol dialog box opens.
7. Type OPEN in the Communication Type field.
8. Press Enter.
9. Type DCTM in the Application field, and click Continue.
10. In the Overview of a Protocol window showing the list of document classes, select the ALF
document class.
11. Click the pencil button.
The Overview of Protocol dialog box opens.
12. Type R/3 in the Communication Type field, and then press Enter.
No application is entered here.
28
Configuring the ArchiveLink Interface for CS SAP
1.
29
Configuring the ArchiveLink Interface for CS SAP
30
Chapter 3
Customizing SAP Document Classes
This chapter describes how to archive document classes from SAP. The customization of each SAP
setup is different depending on which document class the archived document belongs to. The
document classes are:
• ALF
• FAX
• OTF
• REO
For all classes you must configure a minimum of:
• OAC0
• OAC2
• OAC3
Plus any specific customizations.
These customizations are described in the following sections:
• oac0—Configuring content repositories, page 31
• oac2—Defining document types, page 33
• oac3—Defining links, page 33
• ALF Reports/Print Lists, page 34
• Deleting archived and linked documents, page 36
• Customizing FAX–scanned documents, page 36
• Testing scanning documents, page 39
31
Customizing SAP Document Classes
folders, retention, and so on) are applied on a SAP document when it is archived. The following
sections explain how to create an archive in SAP for each represented document class.
You can configure HTTP-based archives.
To define a SAP content repository (archive):
32
Customizing SAP Document Classes
• Basic path
Type the file system path to the location where SAP will put archived documents to be picked
up by Archive Services.
• Arch path
Usually, the same as the Basic path.
Repeat this procedure to define additional archives. You may use this procedure to define any
Documentum archives in SAP.
oac3—Defining links
Using the link table, you can categorize SAP documents to define what combination of SAP object
type (for example, SOOD) and SAP document type (for example, GENPRILIS) are stored and linked
to which archive.
The SAP document type is linked to the SAP document class, previously known as SAP document
type (for example, ALF, OTF, REO) which determines how the document is produced and linked.
For example, the ALF class refers to reports, FAX to scanned documents, and OTF to outgoing
SAPSCRIPT documents.
33
Customizing SAP Document Classes
To define links:
1. Execute the following transaction in the transaction code field:
oac3
The Display View “Links for Content Repositories": Overview screen appears.
2. Select Table View > Display > Change.
3. Fill in the fields listed below.
34
Customizing SAP Document Classes
35
Customizing SAP Document Classes
16. To view the archiving parameter details, double-click the Print List entry.
The Archiving request window opens.
Verify that the details are correct
17. To archive the Print List in an archive located in a repository, click Execute.
You should see a confirmation message that the queue has been processed.
If no errors occur, you can continue testing by displaying the archived Print List.
36
Customizing SAP Document Classes
Then you can make specific customizations using the following procedures:
• oaws—Settings, page 37
• Optional for SAP workflow, page 38
• Optional for barcode, page 38
oaws—Settings
OAWS contains the settings for routing and linking newly scanned FAX documents in SAP. For each
document type, you can specify which type of archiving is available:
• Store for subsequent entry (Early)
• Store and Enter (Simultaneous)
• Assign and Store (Late)
For storing for subsequent entry which uses SAP workflow to move the image to the SAP inbox, you
can specify what organizational object will be used for routing (like User) and then what specific
organizational object to route to (like the SAP User ID).
37
Customizing SAP Document Classes
You will need these values to complete later configuration steps. For example, Incoming Invoice
Preliminary Posting has an object type BKPF and object type FIIINPREL.
To configure all SAP object type/document type/User ID combinations for use with bar codes:
1. Type /NOAC5 in the command window.
2. Click Edit.
3. Click New Entries.
The Details of Added Entries window opens.
4. Type any SAP object types for which you want a barcode dialog box to open upon saving of
that object.
5. Type any SAP document types for which you want a barcode dialog box to open upon saving of
that document.
6. Type any User IDs for which you want a barcode dialog box to open upon saving under that
user ID.
7. Save your changes.
8. Type your object, document, and user ID to test your barcode.
38
Customizing SAP Document Classes
39
Customizing SAP Document Classes
40
Customizing SAP Document Classes
41
Customizing SAP Document Classes
42
Chapter 4
Creating Custom BAPIs
CS SAP enables you to create and install custom configuration objects—known as BAPIs—for linking
and querying SAP data.
To create a custom BAPI, you must modify the custom.xml file that is included with the CS SAP
installation files. After modifying the custom.xml file as shown in the example below, when you
install CS SAP, the custom BAPI will be available for linking and querying using WebAdmin.
The following example details creating a custom BAPI to link and query purchase orders. The query
type for this custom BAPI is EKPO Table.
43
Creating Custom BAPIs
<VALUE>Link</VALUE>
</ATTRIBUTE>
<ATTRIBUTE NAME="descriptive_field">EBELP</ATTRIBUTE>
</API_CONFIG>
</OBJECT_CREATE>
The attribute descriptive_field is used by Content Services Manage. The value of this
attribute will be shown as the description in the query result dialog box in Manage as shown in
the following screenshot. In this example, EKPO_Table is used.
44
Creating Custom BAPIs
45
Creating Custom BAPIs
46
Chapter 5
Configuring the DMS Interface for the
Manage and View Components
The procedures in this chapter assume that the software is installed on at least one PC and that the
Documentum repository is configured according to your business needs. It is assumed that a default
installation of SAP has been performed. If this is not the case, you may find that the installation
steps differ in your R/3 system.
You must customize SAP before you can link documents to it. The customization work is necessary to
configure the CAD Interface to your needs. Additionally, you must verify a number of parameters
and certify that everything is configured properly. This chapter discusses the following topics:
• Configuring the Manage component, page 47
• Configuring Document Management Control data, page 48
• Configuring general data, page 50
• Configuring CAD integration, page 54
• Configuring general data sub-levels, page 55
The examples in this chapter also assume a SAP default installation.
47
Configuring the DMS Interface for the Manage and View Components
4. Select Implement Projects > SAP Reference IMG (or click the button for your specific project if
you configure your system on a project basis).
The Implementation Guide for R/3 Customizing screen appears.
5. Click Cross-Application Components, then click Document Management from the expanded
list of items.
48
Configuring the DMS Interface for the Manage and View Components
The Display Number Range Intervals window appears, showing number ranges configured as
shown below.
Example 5-1.
You can assign the value of DocumentType as DES for a DES document type.
For all document types, you can set the value of DocumentType as one of the following:
• DocumentType=*
• DocumentType=
In this case, no value has been assigned to the parameter. The value for the parameter has
been set to blank.
4. Click the box at the beginning of the document type line.
5. Click the magnifying glass button.
6. Define the parameters for DRW as described below. Leave all other fields blank.
49
Configuring the DMS Interface for the Manage and View Components
Parameter Setting
50
Configuring the DMS Interface for the Manage and View Components
51
Configuring the DMS Interface for the Manage and View Components
52
Configuring the DMS Interface for the Manage and View Components
53
Configuring the DMS Interface for the Manage and View Components
If you have installed WebView for viewing documents, you must define the program as
dmwebview.exe. (The previous note about passing program arguments applies also to
dmview.exe. For example, If webview.exe is called without command line parameters, the user
is prompted to fill in the host name under which the Web application runs. To get around this
problem, see OSS notes: 0135155 and 0105208.)
This configuration may look different for a UNIX Web server.
• Path for ref. file = [leave this field empty]
• Start Authorization = X (yes)
5. Save your changes.
6. Close the dialog box.
7. Click Back.
54
Configuring the DMS Interface for the Manage and View Components
Save the settings even if nothing was modified. The parameters given earlier are the default
parameters.
You may receive an error message here stating that control parameters are not defined for the
current client. If this happens, save the settings even if you have not modified anything.
Defining functions
Use the Position button to verify that the following items in the table are defined. This table must
contain about 180 entries.
55
Configuring the DMS Interface for the Manage and View Components
56
Chapter 6
Configuring SAP for PP-PI
CS SAP allows you to link documents stored in a Documentum repository to an SAP Production
Planning for Process Industries (PP-PI) instruction sheet. Documents are directly accessible from
SAP PP-PI sheets.
SAP PP-PI modules control the manufacturing process in process industry environments. PP-PI
allows you to define hyperlinks to external applications, enabling you to retrieve documents (such as
recipes or SOPs) from a Documentum repository by using a configurable query together with specific
parameters. This mechanism is very flexible and is independent of the Documentum or ArchiveLink
system. Documents are linked to SAP PP-PI with a query stored in Documentum.
This information in this chapter assumes that CS SAP View is installed on at least one PC and that the
Documentum repository is configured according to your business needs.
You must customize the SAP server before you can use hyperlinks from a PP-PI sheet. This section
explains how to create and configure the mandatory new process instruction categories. These
concepts are described in the following sections:
• Configuring the Process Instruction category, page 57
• Defining Process Instruction category DCTM, page 58
• Configuring the Characteristics/Process Instruction category, page 58
57
Configuring SAP for PP-PI
58
Configuring SAP for PP-PI
The value of this field is the command line passed to Content Services View. You may either
leave this field blank for now, or enter the repository name and the query name. The command
line has some constraints:
• The maximum string length is 30 characters.
• All letters are capitalized.
8. Type the value for the characteristics listed below.
59
Configuring SAP for PP-PI
60
Appendix A
Configuration and Usability notes
Custom BAPIs
BAPI table queries the SAP API on the client side and loads the whole result table into memory.
You can easily calculate be required (number of rows * row-length) and for large tables this will
not be possible.
61
Configuration and Usability notes
If there are too many rows, the work around is to write a BAPI on the SAP server side which returns
a smaller number of rows.
Implementing this bapi requires coding a a custom BAPI functional module in ABAP which is
RFC-enabled to take any number of input parameters and return a table of results.
As an example BAPI, please look at BAPI_COSTCENTER_GETLIST1 in SE37 which has 13 input
parameters and one result table. Such a custom bapi can then easily be configured on the Content
Services for SAP side via building a custom bapi configuration to match using the CUSTOM.XML
feature of the installer.
Another way to avoid this limitation is to create a custom filter and parse a printlist for the attributes
needed, then modify the Documentum object attributes via this filter when archiving the relevant
printlist.
62
Index
63
Index
F OAC0, 32
f.21, 35 oac2, 33
FAX, 33, 36 oac3, 33
FAX class, 14 oadr, 36
field sets, allocating, 55 oag1, 18
format oam1, 19
ALF, 14 oanr, 18
PDF, 14 oaq1, 19
REO, 14 oaqi, 19
Tiff, 14 OAWS, 37
frequency of archival, 20 OLE, application, 22
optical archive, configuring as output
device, 20
G OTF, 33
General Data, 55 to 56 OTF class, 14
output device
configuring logical archive as, 20
H
High Volume Processing System, 13
P
PDF format, 14
I prerequisites
Inline Print List Viewer system administrator, 7
protocol, 28 Print List, 34
intended audience, 7 archived, displaying in SAPGUI, 36
archiving, 35
J Print Lists, 14
ALF class, 14
jobs, scheduling, 19
ALF format, 14
protocol
L Anonymous Login, 27
linking, 37 Inline Print List Viewer, 28
links purpose of the guide, 7
defining, 34
logical ArchiveID Q
defining, 18
queues, creating, 19
M R
maintaining links, 7
releasing documents to SAP, 7
Manage, 47 to 48
REO, 33
REO class, 14
N REO format, 14
number ranges, configuring, 18 Reports. See Print Lists
O S
oaa4, 24 SAP
oaat, 19 print spooler, 22
oac0, 17, 31 supported document formats in, 14
64
Index
65
Copyright © 2015 EMC Corporation. All rights reserved. Published in USA.
EMC believes the information in this publication is accurate as of its publication date. The information is
subject to change without notice.
The information in this publication is provided as is. EMC Corporation makes no representations or
warranties of any kind with respect to the information in this publication, and specifically disclaims
implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution
of any EMC software described in this publication requires an applicable software license.
EMC², EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the
United States and other countries.
All other trademarks used herein are the property of their respective owners.
For the most up-to-date regulatory document for your product line, go to EMC Online Support
(https://support.emc.com).