Opentext Documentum Content Services For Sap: User Guide
Opentext Documentum Content Services For Sap: User Guide
User Guide
Legal Notice
Preface ................................................................................................................................. 7
3
Table of Contents
List of Figures
4
Table of Contents
List of Tables
5
Table of Contents
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 CS SAP
application integrates Documentum and the SAP R/3 system. Therefore, system administrators
must have experience with the software products listed in the "Content Services for SAP System
Requirements” chapter of the Documentum Environment and System Requirements Guide.
• 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.
• Standard User — This role covers users who view documents using SAPGUI and the View
component of Content Services.
This manual is written for standard users.
7
Preface
Revision history
This section contains a description of this document’s revision history.
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 EMC Online Support
at https://support.emc.com.
From EMC Online Support, you can download the latest version of CS SAP and the related
documentation suite.
CS SAP—Documentation suite
8
Preface
Documentum Content Services for Describes how to configure Content Services Administrator
SAP Administration Guide Content Services using the
WebAdmin tool.
Documentum Content Services for Describes how SAP users view Standard User
SAP User Guide documents.
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
Working with the View component
Non-SAP users can view SAP documents using the View component. This component also provides
you with the ability to define your preferences for the application to be used to open the different
document formats.
You can perform the following tasks using the View component:
• Viewing documents, page 17
• Setting format preferences, page 19
• Viewing PDF documents with Adobe Acrobat, page 22
• Annotating PDF documents, page 22
Viewing documents
To view documents with the View component:
1. Start the View component. The default location is in the Start menu under Programs >
Documentum Content Services for SAP > View.
The application is started and the View window appears.
To retrieve documents, you must open a DRL.
2. Select Open DRL from the File menu.
Note: The View component remembers the last DRL opened and displays it in the Open text field.
The Open DRL dialog box appears.
3. Type a valid DRL and select Debug DRL, if required.
Debug DRL only takes effect when opening a canned query DRL, showing the final DQL
statement. More information about DRLs is in Valid DRLs, page 18.
4. Click Open.
If you are not already connected to a repository, the Connect to Documentum window appears.
5. Select the repository from the list box.
6. Either select Use Windows Login or type your username and password.
7. Type the Domain, if required.
8. Click Connect.
17
Working with the View component
The View component screen is displayed showing all documents retrieved by the DRL. If only
one document was retrieved, the View component starts the appropriate application and displays
the document.
The view shows the folder structure (including queries and virtual documents) of the documents
in the repository.
9. Navigate to the folder that contains the required document.
10. Double-click the document.
The preferred application for the document format is launched and the document is opened.
You can change the preferred application for viewing by changing your format preferences, as
described in Setting format preferences, page 19.
Instead of double-clicking the document, right-click to display the context menu.
You can view or print the document. In addition, you can set the preferred application for all
documents with the format of the currently selected one.
Note: If you made a multiple selection of documents (Ctrl or Shift) the documents can only
be printed.
Valid DRLs
A DRL, very much like a URL, specifies a document that should be retrieved. If the document is a
folder or a cabinet, a virtual document or a query, multiple documents can be retrieved. The view
component then displays an outline view of the retrieved documents.
Valid DRL can have the following formats:
• <repository name>:rel,<rel id>
• <repository name>:id,<id>[,<format>]
• <repository name>:cid,<chronicle id>,<version label>[,<format>]
18
Working with the View component
Sample DRLs
foo1:rel,37001edc80000ac6
This example references a document in repository ’foo1’ with the relation object ID
’37001edc80000ac6’.
foo1:id,09001edc80000cc3
This example references a document in repository ’foo1’ with the object ID ’09001edc80000cc3’. The
primary content is retrieved.
foo1:id,09001edc80000cc3,pdf
This example references a document in repository ’foo1’ with the object ID ’09001edc80000cc3’. The
Acrobat PDF rendition is retrieved.
foo1:cid,09001edc80000ab2,CURRENT,pdf
This example references the current version of a document in repository ’foo1’ with the chronicle
ID ’09001edc80000ab2’. The Acrobat PDF rendition is retrieved.
foo1:dql,sop_document
where sop_number='4711'
This example references a document of type ’sop_document’ in repository ’foo1’ with an attribute
’sop_number’ that is ’4711’.
Foo1:dql,dm_cabinet
This example retrieves all cabinets of the repository foo1 and thereby enabling the user to browse
the entire repository.
test3:/DCTM373507BB80000101
This is used by all links created by Content Services for SAP components. The old DRL schema is
still supported.
19
Working with the View component
1. Start the View component. The default location is in the Start menu under Programs >
Documentum Content Services for SAP > View.
The application is started and the View component window appears.
2. Select Preferences from the Edit menu.
If you are not already connected to a repository, the Connect to Documentum window appears.
3. Select the repository from the list box.
4. Either select Use Windows Login or type your username and password.
5. If required, type the Domain.
6. Click Connect.
The Documentum Content Services View Format Preferences dialog box appears.
7. Select a format for which you want to set preferences from the Content Format list box.
The radio buttons available in the View Content With dialog box will depend on the format
chosen.
Note:
• Most file types will launch the associated Windows application. Otherwise, you can select
another application.
• Any file may also be viewed or edited by starting the Webtop application through Internet
Explorer.
• Any file may also be viewed or edited by starting the WebView application through Internet
Explorer.
• The DmView option is only available for the special formats of Folder and Cabinets.
8. Click the radio button that suits your requirements.
If you click on another application:
a. Navigate to the folder with the appropriate application program.
b. Highlight the program and click OK.
9. Click Apply.
10. Configure another content format or click Close.
The next time the View component opens a document of a configured content format it will use
the appropriate application to display the document’s content.
20
Working with the View component
21
Working with the View component
Note: If a view contains objects with a specific list of attributes, only those attributes will be
shown. In this case, the Column Preferences button will not appear.
22
Working with the View component
Acrobat, the Documentum Annotation plug-in must be installed. The Content Services installation
program installs this.
Your ability to annotate documents depends upon the permissions that you have on the underlying
document (RELATE permission is required to annotate documents).
To annotate a document:
1. In Acrobat Exchange, select Tools > Note.
2. Click where you want the annotation to appear.
3. Type the annotation in the Note window. Details for creating and using annotations is in the
Adobe Acrobat online help.
4. Select File > Save.
5. Select a permission to apply to your annotation.
When you create an annotation, you can assign it default or private permissions:
• Default:
Enables other users with at least Read permission for your annotations, to view your
annotations. The collection of annotations you attach to a document have assigned permission
levels.
• Private:
Blocks other users from viewing your annotations.
6. If you want the annotations to be associated with future versions of the document, check Keep
Annotations With Future Versions. By default, your annotations are associated only with the
current version.
7. Click Save.
The annotations are now stored in the Documentum Content Server.
23
Working with the View component
24
Appendix A
Configuration and Usability Notes
25
Configuration and Usability Notes
26
Configuration and Usability Notes
27
Configuration and Usability Notes
28
Index
A folder, 18
Administrative Console, 13 format, 20
Adobe Acrobat, 23 ALF, 14
ALF class, 14 PDF, 14
ALF format, 14 REO, 14
annotations, 23 Tiff, 14
archived data, 14 format preferences, 18 to 19
C H
cabinet, 18 High Volume Processing System, 13
class
ALF, 14 I
FAX, 14
intended audience, 7
OTF, 14
REO, 14
Content Services, 7 M
Content Services for SAP maintaining links, 7
defined, 11 multiple documents, 18
Content Services for SAP administrator, 7 multiple selection, 18
CS for SAP. See Content Services
N
D notes, 23
defining preferences, 17
document
incoming, 14
O
outgoing, 14 OTF class, 14
scanned, 14
supported formats in SAP, 14 P
document controller, 7
PDF format, 14
document format, 18
PDF renditions, 23
document formats, 17
preferred application, 18
document formats, supported in SAP, 14
prerequisites
documents, 23
system administrator, 7
DQL statement, 17
Print Lists, 14
DRL, 17 to 18
ALF class, 14
ALF format, 14
F purpose of the guide, 7
FAX class, 14
29
Index
Q REO class, 14
query, 18 REO format, 14
query DRL, 17 Tiff format, 14
system administrator, 7
prerequisites, 7
R
releasing documents to SAP, 7
renditions, 23
T
REO class, 14 Tiff format, 14
REO format, 14
Reports. See Print Lists U
URL, 18
S user roles, 7
SAP
supported document formats in, 14 V
SAP transaction, 7 viewer, 7
standard user, 7 viewing documents, 17
supported document formats in SAP, 14 virtual document, 18
ALF class, 14 virtual documents, 18
ALF format, 14
FAX class, 14
OTF class, 14 W
PDF format, 14 WebAdmin, 13
30
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).