40
EMC® Documentum® Process Services for SAP Release 6.5 Configuration Guide P/N 300-006-310 REV A01 EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-?103 1-508-435-1000 www.EMC.com

EMC® Documentum® Process Services for SAP · Understanding PS SAP architecture ... EMC Documentum Process Services for SAP Configuration Guide 5. 6 EMC Documentum Process Services

  • Upload
    lydang

  • View
    252

  • Download
    0

Embed Size (px)

Citation preview

EMC® Documentum® Process Services for SAPRelease 6.5

Configuration GuideP/N 300-006-310

REV A01

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-?1031-508-435-1000www.EMC.com

Copyright © 2008 EMC Corporation. All rights reserved.

Published July 2008 .

EMC believes the information in this publication is accurate as of its publication date. The information is subjectto change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED "AS IS." EMC CORPORATIONMAKES NOREPRESENTATIONS ORWARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THISPUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIEDWARRANTIES OF MERCHANTABILITY ORFITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable softwarelicense.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

All other trademarks used herein are the property of their respective owners

Contents

Preface..................................................................................................................7

Chapter 1: Introducing Process Services for SAP............................................9

Understanding PS SAP architecture ........................................................................10

Chapter 2: Introducing WebAdmin....................................................................11

Logging in to WebAdmin...........................................................................................12

Introducing the Enterprise Integrations node of the WebAdmin GUI........................13

Chapter 3: Configuring Process Services for SAP.........................................15

Configuring queries and workflows...........................................................................16

Specifying SAP connection parameters.........................................................16

Configuring PS SAP workflow activity templates............................................16

Creating a DIR link using a Link Documentum activity template....................17

Getting SAP object attributes..........................................................................17

Updating DIR status in a Documentum workflow...........................................18

Replicating attributes from SAP to Documentum...........................................18

Retrieve list of DIR numbers related to a document.......................................19

Executing an SAP query.................................................................................20

SAP queries..............................................................................................................20

Create, view, or edit an SAP query ................................................................20

Documentum queries................................................................................................22

Create, view, or edit a Documentum query.....................................................23

Testing queries with $ARG# statements.........................................................24

EMC Documentum Process Services for SAP Configuration Guide 3

Linking objects..........................................................................................................24

Create, view, or edit SAP to Documentum links.............................................25

Create, view, or edit Documentum to SAP links.............................................27

Replication of information between Documentum and SAP.....................................30

Replicate SAP objects....................................................................................31

Replicate Documentum objects......................................................................33

Working with the FILTER attribute..................................................................35

Appendix A: Understanding SAP and PS SAP Terms.....................................37

Index.........................................................................................................................39

4 EMC Documentum Process Services for SAP Configuration Guide

Contents

Table List

Table 1: Document history...............................................................................................8

Table 2: Process Services for SAP Documentation suite.............................................8

Table 3: Tabs and procedures in WebAdmin................................................................14

Table 4: Query types.......................................................................................................21

Table 5: SAP to Documentum links map rules.............................................................26

Table 6: Documentum to SAP links map rules.............................................................28

Table 7: Documentum to SAP links folder formats......................................................28

Table 8: Replicate SAP object key rules.......................................................................31

Table 9: Replicate SAP object map rules......................................................................31

Table 10: Replicate SAP objects action maps..............................................................32

Table 11: Replicate Documentum objects key rules....................................................34

Table 12: Replicate Documentum objects update condition rules.............................34

Table 13: Replicate Documentum objects map rules..................................................34

Table 14: Filter attribute parameters.............................................................................35

EMC Documentum Process Services for SAP Configuration Guide 5

6 EMC Documentum Process Services for SAP Configuration Guide

Tables

Preface

Purpose of this guide

This guide explains how to configure Process Services for SAP 6.5 (PS SAP 6.5). It containsinformation about configuration requirements, and provides task-based instructions forconfiguring the software.

Intended audience

In order to address the manuals to the correct audience, the roles of the users of thedocumentation have been defined as follows:

• Consumer

This role covers users who access related EMC Documentum content in the context ofthe task that they perform in SAP.

• Content Manager

This role covers users who administer content making the right content is available tothe right users in the right business context.

• System Administrator

This role covers users who install and configure PS SAP.

PS SAP facilitates creating activity templates. Activity templates formalize the stepsrequired to complete a business process, enabling users to repeatedly perform the process.Installing PS SAP requires detailed knowledge of Content Services for SAP Agentoperation and SAP JCO installation. Therefore, system administrators must haveexperience with the software products listed in the EMCDocumentum Process Services forSAP Release Notes.

This guide is intended for system administrators.

Revision history

EMC Documentum Process Services for SAP Configuration Guide 7

Table 1: Document history

DescriptionRevision date

Initial publication of documentfor PS SAP 6.5.

July 2008

Related documentation

This guide forms part of a documentation suite designed to support those who install,configure, and use PS SAP. The product and documentation suite can be found on EMCPowerlink at http://Powerlink.EMC.com.

From Powerlink, you can download the latest version of PS SAP and the relateddocumentation suite. To access the contents in Powerlink, you must provide the logincredentials assigned to youwhen you first applied for access. If you are accessing Powerlinkfor the first time, you will need to apply for access and obtain a username and password.

Table 2: Process Services for SAP Documentation suite

Target roleDescriptionTitle

Consumer, Content Manager,System Administrator

Provides an overview of new andamended features, known bugs,limitations, miscellaneous techni-cal notes, and documentationcorrectness and clarifications.

EMC Documentum ProcessServices for SAP Release Notes

System AdministratorProvides the procedures for in-stalling PS SAP.

EMC Documentum ProcessServices for SAP InstallationGuide

Content Manager, System Ad-ministrator

Describes how to configure PSSAP.

EMC Documentum ProcessServices for SAP ConfigurationGuide

Accessing documentation online

EMC product documentation can be found at http://Powerlink.EMC.com.

Powerlink contains the downloadable packages for specific product versions alongwith therelease notes, installation guide, and other relevant documentation associated with theproduct version. Product documentation that is available online from the application, forexample, onine help, does not appear as a separate item; it is automatically downloadedand installed with the software. In order to access and view the documentation, you musthave valid login credentials for Powerlink, and at least Adobe Acrobat Reader installed onyour system.

8 EMC Documentum Process Services for SAP Configuration Guide

Preface

Chapter 1

Introducing ProcessServices for SAP

PS SAP is a tool for automating business processes by creating aworkflowtemplate that captures the definition of the business process.

Individual processes generated from an activity template are calledworkflows.

PS SAP extends the functionality of Documentum Business ProcessManager. While you can use either tool to create templates, PS SAP offersenhanced options, including the ability to create activity templates thatinclude custom activity types. All templates are delivered in the SAPIntegration activity palette.

Major topics include:

• “Understanding PS SAP architecture ” on page 10

EMC Documentum Process Services for SAP Configuration Guide 9

Understanding PS SAP architecture

PS SAP comprises the following components:

• Link Documentum—Creates various types of links that establish relationships betweenSAP objects and EMC® Documentum® objects.

• Link SAP — Creates various types of links that establish relationships between EMCDocumentum objects and SAP objects.

• Execute SAP Query — Executes a pre-configured SAP query specified by name.

• QueryRelated Objects — Returns a list of DIR keys related to a specified document.

• Replicate SAP — Executes a specific SAP replication action for all SAP objects returnedby a CS SAP Agent query, or for a specific object selected from a workflow.

• Replicate Documentum— Executes a specific Documentum replication action for allDocumentumobjects returned by a CS SAPAgent query, or for a specific document only.

10 EMC Documentum Process Services for SAP Configuration Guide

Introducing Process Services for SAP

1

Chapter 2

Introducing WebAdmin

WebAdmin is a browser-based tool hosted within the DocumentumAdministrator that you can use to configure and administer PS SAP.

Note: The CS SAPWebAdmin module and Documentum Administratormust beinstalled before CS SAP WebAdmin will be accessible through the DocumentumAdministrator. Complete CS SAP installation information is in theEMC Documentum Content Services for SAP Version 6.5 Installation Guide. CompleteDocumentum Administrator installation information is in theEMC Documentum Documentum Administrator Version 6.5 Installation Guide.

Major topics include:

• “Logging in to WebAdmin” on page 12

• “Introducing the Enterprise Integrations node of the WebAdminGUI” on page 13

EMC Documentum Process Services for SAP Configuration Guide 11

Logging in to WebAdmin

Log in to Documentum Administrator before using WebAdmin to configure PS SAP:

Note: The EMC Documentum Documentum Administrator User Guide has complete information aboutusing Documentum Administrator.

1. Start a web browser on a client machine.

2. Connect to the followingURL,wherehost is the hostwhereDocumentumAdministratoris installed and port_number is a port number provided during application serverinstallation: http://host:port_number/da/

3. Type your login name and password on the Documentum Administrator Login page.

4. Select a repository from the list box.

If you change the repository, retype your password.

5. In the Location list (if available), select the location on your organization's network fromwhich you are accessing Documentum Administrator.

This allows you to access content from the nearest storage area in the network. Dependingon your organization's setup, this location might be a fixed value.

6. To view additional options, click More Options:

a) To connect to the repository using a particular server, select that server from the Serverlist box.

The default is Any Running Server.

b) If the repository is running in domain required mode, type the domain name.

c) To set the session locale to another language, select the language from the list box.

Do not click the Additional Accessibility Options link on the login page. DocumentumAdministrator does not support the accessibility options.

d) To change your password in a repository, click Change Password, select a repositoryand type your old and new passwords, and then click Change Password.

If LDAP user authentication is used, you cannot change your password from thispage. A system administrator must change your password on the LDAP server.

12 EMC Documentum Process Services for SAP Configuration Guide

Introducing WebAdmin

2

7. Click Log in.

The EMC Documentum Documentum Administrator User Guide has complete informationabout using Documentum Administrator and logging in to repositories available inDocumentum Administrator.

The System Information page appears with information about the system.

After you finish

On completion of your activity, you should disconnect from the WebAdmin tool using thedisconnect button.

Note: By default, WebAdmin will disconnect automatically after 20 minutes of inactivity. However,this parameter can be customized: edit the value for the max_session_count parameter in the dmcl.inifile.

Introducing the Enterprise Integrations node of the WebAdmin GUI

After you have logged in to Documentum Administrator and the System Information pageappears, you can select and expand the Content Services for SAPWeb Administration nodelocated under the Administration node on the left-hand tree.

TheEMCDocumentumDocumentumAdministratorUser Guidehas complete information aboutusing DocumentumAdministrator and logging in to repositories available in DocumentumAdministrator.

The Content Services for SAP Web Administration node contains the following subnodeswhen CS SAP is installed:

• Actions

• ArchiveLink

• Auto Manage

• Clients

• Documentum

• SAP

The following sub-nodes provide access to tabbed pages where you can carry out all of theadministrative tasks for PS SAP. The number of tabs will vary according to the functionserved by the page:

• The Documentum page has one sub-node to let you define Documentum Queries.

• The SAP page has three tabs to let you define SAP Queries and configure SAP Serversand Users to be used by PS SAP.

Introducing the Enterprise Integrations node of the WebAdmin GUI 13

Introducing WebAdmin

2

• The Actions page lets create PS SAP Actions which perform document linking, datareplication, and integrity checking functions.

The tabs and procedures can be found as shown in the following table.

Table 3:Tabs and procedures in WebAdmin

ProceduresTabPart

“Documentum queries” on page 22QueryDocumentum

“SAP queries” on page 20QuerySAP

“Specifying SAP connection parameters” on page16

Server

“Specifying SAP connection parameters” on page16

User

“Create, view, or edit SAP to Documentum links”on page 25

Link SAPActions

“Create, view, or edit SAP to Documentum links”on page 25

Link Documentum

“Replicate SAP objects” on page 31Replicate SAP

“Replicate Documentum objects” on page 33Replicate Documentum

14 EMC Documentum Process Services for SAP Configuration Guide

Introducing WebAdmin

2

Chapter 3

Configuring ProcessServices for SAP

PS SAP provides the following actions:

1. Linking SAP objects to Documentum objects.

2. Linking Documentum objects to SAP objects.

3. Replicating SAP objects into a Documentum repository.

4. Replicating Documentum objects into SAP.

Major topics include:

• “Configuring queries and workflows” on page 16

• “SAP queries” on page 20

• “Documentum queries” on page 22

• “Linking objects” on page 24

• “Replication of information between Documentum and SAP” onpage 30

EMC Documentum Process Services for SAP Configuration Guide 15

Configuring queries and workflows

Actions depend on queries to identify objects that need to be linked or replicated. Thequeries can be made on SAP or Documentum systems.

'Link Documentum' and 'Replicate Documentum' action configurations contain a referenceto the Documentum query object. By default, the query is executed when action starts,followed by a 'Replicate' or 'Link' operation performed for each document returned by thequery. PS SAP activity configuration allows overwriting this behavior when 'Choosedocument from execution context' is selected. Then the Documentum query is not executedby the action, and 'Link' or 'Replicate' is performed for the document whose i_chronicle_idis mapped in the corresponding 'input mappings' section.

'Link SAP' and 'Replicate SAP' action configurations also contain a reference to the SAPquery object. By default, the query is executed when action starts, followed by a 'Replicate'or 'Link' operation performed for each SAP object returned by the query. PS SAP activityconfiguration allows overwriting this behavior when 'Choose SAP object from executioncontext' is selected. Then the input parameters for SAP query are defined by the 'inputmappings' section instead of the query configuration object.

Specifying SAP connection parameters

For specifying SAP server connection parameters and user credentials, the PS SAP activityconfiguration screen has following controls:

• SAP Server Config list box – Select a name of the SAP server configuration object createdusing WebAdmin.

• SAP User Config list box – Select a name of the SAP user configuration object createdusing WebAdmin.

• Usermapping checkbox – Can be used to dynamically choose SAP user at the workflowexecution time. If selected, the selection of the SAP User Config list box will be ignored.Instead, workflow runtime will attempt to find an SAP User Config object with a nameof current Documentum user (activity performer).

Configuring PS SAP workflow activity templates

During workflow design, create instances of activity templates and configure the activityby specifying parameter values, attribute mappings, and forward/reject outcomes.

16 EMC Documentum Process Services for SAP Configuration Guide

Configuring Process Services for SAP

3

Creating a DIR link using a Link Documentum activity template

Follow this procedure to create an automated activity template which creates a DIR linkbetween a document and an SAP object.

1. Drag and drop the Link Documentum activity template from the SAP Integration paletteto the workflow design panel.

2. Right-click on the activity and select Activity Inspector.

The Activity Inspector window appears.

3. With the Link Documentum tab selected, ensure the following are filled or selected andclick Next:

• SAP Server Config – sap_user_name

• SAP User Config – sap_user_name

• Usermapping – optional

• Action Configuration – Desired action. For example, Link material PLM2.

• Choose document from execution context – optional

4. If Choose document from execution context was selected, specify mapping fori_chronicle_id in the Input Message Mapping area of the Activity Inspector window andclick Next.

5. In the Output Message Mapping area of the Activity Inspector window, specify mappingfor the action result code and click OK.

The activity on a workflow template is created and configured for DIR linking betweena document and SAP objects.

Getting SAP object attributes

Follow this procedure to validate document attributes in SAP.

1. Drag and drop the SAP Query activity template from the SAP Integration palette to theworkflow design panel.

2. Right-click on the activity and select Activity Inspector.

The Activity Inspector window appears.

Creating a DIR link using a Link Documentum activity template 17

Configuring Process Services for SAP

3

3. With theQuery SAP tab selected, ensure the following are filled or selected and clickNext:

• SAP Server Config – sap_server_name

• SAP User Config – sap_user_name

• Usermapping – optional

• Query Type – Desired SAP query type.

• Max. Resultset Size – Desired maximum results. For example, 10.

4. In the Input Message Mapping area of the Activity Inspector window, map values fromthe workflow context to input parameters of the query and click Next.

5. In theOutput Message Mapping area of theActivity Inspectorwindow,map query resultsetcolumns to attributes of objects in a workflow context and click OK.

The activity on aworkflow template is created and configured to get SAP object attributes.

Updating DIR status in a Documentum workflow

Follow this procedure to update the DIR with document attributes.

1. If Choose document from execution context was selected, specify mapping fori_chronicle_id in the Input Message Mapping area of the Activity Inspector window, andclick Next.For example, map the identities of the document and object which are linked throughthe DIR.

Replicating attributes from SAP to Documentum

Follow this procedure to replicate SAP object attributes to the document attributes inDocumentum.

1. Drag and drop the Replicate SAP activity template from the SAP Integration palette tothe workflow design panel.

2. Right-click on the activity and select Activity Inspector.

The Activity Inspector window appears.

3. With the Replicate Documentum tab selected, ensure the following are filled or selectedand click Next:

• SAP Server Config – sap_server_name

18 EMC Documentum Process Services for SAP Configuration Guide

Configuring Process Services for SAP

3

• SAP User Config – sap_server_name

• Usermapping – optional

• Action Configuration - desired action configuration.

• Choose document from execution context – optional

4. In the Input Message Mapping area of the Activity Inspector window, map values fromthe workflow context to the identity of the document and SAP object, and click Next.For example, map the identities of the document and object.

5. In the Output Message Mapping area of the Activity Inspectorwindow, map actionresult code to attributes of workflow context objects and click OK.

The workflow activity template is created to replicate document attributes to the DIRproperties.

Retrieve list of DIR numbers related to a document

1. Drag and drop the Query Related Objects activity template from the SAP Integrationpalette to the workflow design panel.

2. Right-click on the activity and select Activity Inspector.

The Activity Inspector window appears.

3. With the Query Related Objects tab selected, ensure the following are filled or selectedand click Next:

• SAP Server Config –sap_server_name

• SAP User Config – sap_user_name

• Usermapping – optional

• Action Configuration – Desired action. For example, Update DIR status.

• Choose document from execution context – optional

4. In the Input Message Mapping area of the Activity Inspector window, specify mapping fori_chronicle_id and click Next.

5. In theOutput Message Mapping area of theActivity Inspectorwindow,map query resultsetcolumns to attributes of objects in a workflow context, and click OK.

The workflow activity template is created to return a list of DIRs related to the specificdocument.

Retrieve list of DIR numbers related to a document 19

Configuring Process Services for SAP

3

Executing an SAP query

1. Drag and drop the SAP Query activity template from the SAP Integration palette to theworkflow design panel.

2. Right-click on the activity and select Activity Inspector.

The Activity Inspector window appears.

3. With theQuery SAP tab selected, ensure the following are filled or selected and clickNext:

• SAP Server Config – sap_server_name

• SAP User Config – sap_user_name

• Usermapping – optional

• Query Type – Desired SAP query type.

• Max. Resultset Size – Desired maximum results. For example, 10.

4. In the Input Message Mapping area of the Activity Inspector window, map values fromthe workflow context to input parameters of the query and click Next.

5. In theOutput Message Mapping area of theActivity Inspectorwindow,map query resultsetcolumns to attributes of objects in a workflow context and click OK.

The activity on a workflow template is created to execute an SAP query.

SAP queries

In order to test SAP queries, at least one SAP user and one SAP server have to be configured.

This specifies a query that identifies all SAP objects that must be linked to a dynamicDocumentum query or to a repository folder. The query is either a query through SAP CADInterface, PLM Interface, or a BAPI or SAP table query.

Create, view, or edit an SAP query

1. Connect to WebAdmin, as described in “Logging in to WebAdmin” on page 12.

2. Click to expand the SAP subnode and select the Query subnode.

The Query screen appears.

20 EMC Documentum Process Services for SAP Configuration Guide

Configuring Process Services for SAP

3

3. Select File > New > SAP Query from the menu at the top of the Query screen.

The New SAP Query screen appears.

4. Type the query name in the Query Name: field.

5. Select a query type from the SAP Query Type: list box. Your choices are described in thetable below.

Table 4: Query types

New interface Query Types(for SAP R/3 version 4.7 and4.6c)

Old interface Query Types(for SAP R/3 version 4.6c)

No Object PLM (Formerly Doc-ument info record)

Document info record

Equipment by short text PLMEquipment by short text

Functional location by text PLMFunctional location by text

Material by description PLM

Note: TheMaterial by descrip-tion PLM query type has threequery conditions:

• MATERIALSHORTDESC-SEL_low

• MATERIALSHORTDESC-SEL_Sign

• MATERIALSHORTDESC-SEL_Option

All three query conditions arerequired if the query is to re-turn a result.

Material by description

Archive dataArchive data

Cost centerCost center

Financial documentFinancial document

Personnel linksPersonnel links

Personnel masterPersonnel master

Purchasing documentPurchasing document

Customer Table PLMCustomer

Print listPrint list

SAP queries 21

Configuring Process Services for SAP

3

Table 4: Query types (continued)

New interface Query Types(for SAP R/3 version 4.7 and4.6c)

Old interface Query Types(for SAP R/3 version 4.6c)

Vendor Table PLMVendor

WBS Element PLMWBS Element

Asset Master GetList PLMAsset Master

6. Build the query condition. For each query condition you want to define:

a) Choose the parameter from the Query Condition Composer list box and type a valuefor the parameter in the text box.

b) Click the down arrow to add the parameter and value to the Query Condition: field.

Highlight an entry in the Query Condition field and click x to delete an entry.

c) Continue to choose parameters and type the values to build the query condition.

The conditions are AND linked.

7. Click OK to save the SAP Query configuration.

The Query screen reappears with the newly created SAP query.

8. Highlight the newly created SAP query and select File > Test from the menu at the topof the Query screen.

9. Select a Server and a User on which to test the query, and click the test button.

Note: You must save any amendments before you implement any changes made. If the queryexecution on the SAP System takes too long, WebAdmin can receive a timeout.

The window shows the test results and is blank until the query results are returned.

Documentum queries

This specifies a query that selects the complete set of objects to be linked. The query can beany valid DQL query that selects at least the object ID, r_object_id AND the object_name aswell as one or several attributes that contain the SAP object information.

22 EMC Documentum Process Services for SAP Configuration Guide

Configuring Process Services for SAP

3

Create, view, or edit a Documentum query

1. Connect to WebAdmin, as described in “Logging in to WebAdmin” on page 12.

2. Click to expand the Documentum subnode and select the Query subnode.

The Query screen appears

3. Select File >New >Documentum Query from themenu at the top of theDocumentum Queryscreen.

The New Documentum Query screen appears.

4. Type a name for the query in the Query Name: field.

5. Type the DQL statement for the query.You can use the $ARG expression when defining the DQL statement. For example:

select r_object_id,object_name from dm_document where object_name='$ARG1'...

More details of the $ARG expression is in “Create, view, or edit SAP to Documentumlinks” on page 25.

6. Click Execute at the far right of the Query: field.

The query executes.

7. Click OK to save Documentum Query configuration.

The Documetum Query screen reappears with the newly created Documentum query.

8. Highlight the newly created Documentum query, right-click, and select Properties fromthe submenu.

The Documentum Query Properties screen appears.

9. Click Execute at the far right of the Query: field.

The query executes.

Create, view, or edit a Documentum query 23

Configuring Process Services for SAP

3

Testing queries with $ARG# statements

By configuring a Documentum Query with Arguments ($ARG#) in the DQL statement, thequery can be used later for Link Actions, as described in “Linking objects” on page 24.

The $ARG# variable has to be numbered, such as $ARG1 and $ARG2. The variable can beused as a placeholder that will be resolved during runtime. For example:

select r_object_id, object_name from dm_document where object_name='ARG1'

This query will select all documents of type dm_document, where the object name equalsa given substitute for the argument with the number 1. An explanation for how this querycan be used for a link action is in “Create, view, or edit SAP to Documentum links” on page25.

When testing, the query will be parsed for occurrences of $ARG# and the user will beprompted to type a substitution for every argument found.

When all arguments are replaced according to the string, the final query that is about to betested will be shown.

Note: The whole query will be displayed within quotes.

The result of thequery, will be shown in the lower frame of the Documentum Query tab. Inthe example, the object of type dm_document with the object_name Electrical Pump hasbeen returned.

Result shown in lower frame.

Linking objects

Agent services make use of the SAP DMS interface to perform linking of objects fromDocumentum into SAP. TheDMS interfacewas originally built to integrateCADApplicationsinto an SAP system. Subsequently, SAP expanded the DMS interface to include integrationswith Product LifecycleManagement (PLM ) systems. The PLM Interface is the next generationof the DMS interface and greatly enhances its functionality.

The PLM Interface is comprised of a set of API functions and allows you to access the SAPserver from external applications like theAgent services or PLMSystems, likeDocumentum.With the PLM Interface you can access SAP server version 4.7 and 4.6c. In addition toaccessing the content on your SAP 4.7 server, the PLM Interface enables you to get editablecopies of it, and check it into and out of your Documentum repository.

In order to link from objects in SAP to objects held in Documentum, the SAP DMS createsobjects in SAP called Document Info Records (DIRs).

A DIR is created in SAP for every document released fromDocumentum. The DIR containsseveral attributes like description, document ID, document version, and a reference to aspecific Documentum object in the Documentum repository.

24 EMC Documentum Process Services for SAP Configuration Guide

Configuring Process Services for SAP

3

The SAP client application (SAPGUI) can launch an external application for specific contentor carrier types (in SAP terminology). These external applications include Content ServicesView installed on workstations running SAPGUI.

When a document previously released from Documentum into SAP is viewed, ContentServices View is launched and the information stored in theDIR is passed to this application.With this information, the Documentum Server is queried and the requested document isretrieved and displayed with a viewer application on the SAP workstation.

Document linking actions allow you to specify attributes for the DIR using the RuleComposer. The rule composer allows you to specify the following attributes for a DIR:

• DocumentNumber: SAPDIR number. A document number specified by theAgent couldbe for example "DocumentNumber="%s",i_chronicle_id". If not specified, the chronicleID is used to define the document number. This must be a unique number.

• DocumentDescription: Description attribute of DIR. A value must be defined. Example:"DocumentDescription="%s",object_name". If not specified the object name is used bydefault.

• DocumentType: SAPdocument type (for example, "DocumentType="DOC""). The defaultis "DRW".

Note: Since the PLM type objects are usually drawings, a default value of DRW is used. You canalways override this setting in theQueryConditions field of the SAPQueryComposer, as describedin “Create, view, or edit an SAP query ” on page 20.

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 parameterhas been set to blank.

• DocumentStatus: An SAP Document Status can be specified =PI. This is mandatory forPLM-based SAP object types.

Create, view, or edit SAP to Documentum links

In the following example you want to link all materials within SAP that have a descriptionstarting with pump* to a document in the repository with the same object_name as thematerial's descripition.

You will need to create/configure:

• An SAPQuery Select all pumps selectsmaterialswith the following condition:Description= pump*

Create, view, or edit SAP to Documentum links 25

Configuring Process Services for SAP

3

This query (Querytype: Material by Description) returns the following attributes:Description, Type, Industry, Material

• DocumentumQuery FindObjectNamewhich selects objects of type dm_documentwherethe object_name equals $ARG1:

Select r_object_id, object_name from dm_document where object_name= '$ARG1'

• Link SAP Action Link query to pumps uses both queries (Select all pumps andFindObjectName) and has the following map rules:

Table 5: SAP to Documentum links map rules

= Material$ARG1

= "DRW"DocumentType

= "Documents for %s", MaterialDocumentDescrip-tion

The result is:

The Link SAP action runs Select all pumps (SAPQuery), returning a number of SAPmaterialobjects with their description matching pump*.

For each object returned, the content of attribute Material is passed as a substitution for$ARG1 to FindObjectName (DCTM Query). Assuming the attribute Material of the firstobject is Pump One, the action continues as follows.

Use the following procedure to create, view, or edit SAP to Documentum links:

• FindObjectName selects a number of documents [1..n] with an object_name that equalsPump One.

• TheDIR is created for the current SAP objectwith links to the documents in the repositorynamed Pump One.

• The additionalDIR attributes are assigned according to themap rules. TheDocumentTypeis DRW and the DocumentDescription is Documents for Pump One.

• This loop will be repeated for each object returned by Select all pumps (SAP Query),thereby establishing the goal.

Use the following procedure to create, view, or edit the links:

1. Connect to WebAdmin, as described in “Logging in to WebAdmin” on page 12.

2. Click to expand the Actions subnode and select the Link SAP subnode.

The Link SAP screen appears.

26 EMC Documentum Process Services for SAP Configuration Guide

Configuring Process Services for SAP

3

3. Select File > New > Link SAP from the menu at the top of the Link SAP screen.

The New Link SAP Action screen appears.

4. Type an action name in the Action: field.

5. Select the SAP system from the SAP System Type: list box.

6. Select the Documentum query from the Documentum Query: list box.

7. Select the SAP query from the SAP Query: list box.

8. Link Workflow is set to No Workflow.

9. Select Verify object links:, if required.

10. Use the Map Rule Composer for each rule you want to define:

a) Select the variable from the Variables list box.

b) Type the format of the variable in the Format field.

c) Choose the parameter required from the list box and click the up arrow to add theparameter to the Parameters field.

The up arrow also alters the format string by adding %s at the end.

The attribute map allows you to specify the following:

DIR attributes: When a document is released to SAP, an SAP DIR is created for it.Values can be set for DocumentType, DocumentDescription, DocumentNumber, andDocumentStatus. For example, the rule Document Description = Document for %s,Material will build a DIR description containing the Material attribute from the SAPobject returned by the SAP query chosen.

$ARG#s: In order for the SAP object to be linked to a Documentum object, PS SAPmust be able to find the related object in the repository. Here you specify thesubstitution for an $ARG# in the DQL statement of the Documentum query. In thisway a lookup into Documentum is defined which identifies the objects which theSAP object should be linked to.

d) Click the down arrow to add the rule to the Defined Map Rules field.

11. Click OK to save the SAP to Documentum link configuration.

Create, view, or edit Documentum to SAP links

This action links specific documentumobjects to SAP objects.When configured and executedusing the Auto Manage function, this action works as follows:

• Reads the Agent configuration object to retrieve the SAP connection parameters.

Create, view, or edit Documentum to SAP links 27

Configuring Process Services for SAP

3

• Connects to SAP.

• Executes the Documentum Query.

• Each returned object is then processed as follows:

• The Attribute Map is used to find the specific related SAP object.

• If the SAP object is found, then PS SAP checks to see if this object is already linked.If it is not linked, then a DIR is created in SAP. The attribute map is used to set theDIR attributes.

In the following example you want to link all sub-folders of the folder /SAP/ Material to aMaterial in SAP where the material attribute matches the folder name.

You will need to create/configure:

• A Documentum Query SelectMaterialFolders selects objects of type dm_folder wherethe folder's location has to be /SAP/Material .

select r_object_id,object_name from dm_folder wherefolder('/SAP/Material')

• Material Master is the SAP Object Type that you want to link to your material folders.This SAP Object Type has the following attributes:

MaterialType, Material, Industry, BaseUnit, Description, Pant

These attributes are shownwith the prefix key in the map rules, indicating that they canbe used as search conditions in the generated SAP Query.

• Link Documentum Action Link material folders have the following map rules:

Table 6: Documentum to SAP links map rules

= "%s",object_namekey.Material

= "DRW"DocumentType

= "Document folder for %s",object_name

DocumentDescription

The action will link the following version and format of the folders:

Table 7: Documentum to SAP links folder formats

Best FormatFormat:

Current VersionVersion:

28 EMC Documentum Process Services for SAP Configuration Guide

Configuring Process Services for SAP

3

The result is:

The Link Documentum action runs SelectMaterialFolders (DocumentumQuery), returninga number of folders in the folder /SAP/Material .

For each folder returned, the content of attribute object_name is passed to a SAP query forSAP object type Material Master as condition for the attribute Material. Assuming that theattribute object_name of the first folder is 100-200, the action continues as follows:

• The created SAP Query for Material Master selects one object [1] with the attributeMaterial matching 100-200.

• Then the DIR is created for the current folder and the selected SAP objects, using thedefined version and format.

• The additionalDIR attributes are assigned according to themap rules. TheDocumentTypeis DRW and the DocumentDescription is Document folder for 100-200.

• This loopwill be repeated for each folder returned by SelectMaterialFolders (DocumentumQuery), thereby establishing the objective.

To configure a Link Documentum to SAP action, you will need a previously configuredDocumentum Query. In order to specify a workflow, it has also to be previously defined:

1. Connect to WebAdmin, as described in “Logging in to WebAdmin” on page 12.

2. Click to expand the Actions subnode and select the Link Documentum subnode.

The Link Documentum screen appears.

3. Select File > New > Link Documentum from the menu at the top of the Link Documentumscreen.

The New Link Documentum Action screen appears.

4. Type an Action name in the Action: field.

5. Select the SAP system from the SAP System Type: list box.

6. Select the SAP object type from the SAP Object Type: list box.

7. Select the Documentum Query from the Documentum Query: list box.

8. Link Workflow is set to No Workflow.

9. Select Verify Object Links:, if required.

10. Define the binding rules:

a) Select the format from the Format list box.

Linking objects 29

Configuring Process Services for SAP

3

Type which document format/rendition should be released to SAP. Best Format andPrimary Content Format are configured using CS SAP WebAdmin as described inthe EMC Documentum Content Services for SAP Administration Guide.

b) Select the version of the document that should be released and the version requiredfrom the list box to the right of the Version: field, and then click the arrow to add thatversion to the Version: field.

Select a specific version label, such as “DRAFT”, or use a keyword likedms_selected_version or dms_all_versions. If all versions are released to SAP, thenthe CS SAP Viewer will display a list of all possible document versions.

11. Use the Rule Composer to define each Attribute Map:

a) Select the variable from the Variable list box.

b) Type the format of the variable in the Format list box.

c) Select the parameter required from the list box below the Parameters field and clickthe up arrow to add the parameter to the Parameters field.

The up arrow also alters the format string by adding %s at the end.

d) Click the down arrow to add the rule to the Defined Map Rules field.

The attribute map allows you to specify the following:

• DIR attributes: When a document is released to SAP, an SAP DIR is created for it.Values can be set for DocumentType, DocumentDescription, DocumentNumber,and DocumentStatus. For example, the rule Document Description =Related SOP for %s, object_namewill build a DIR description containing theobject_name attribute from the Documentum document.

• Lookup Key Values: In order for the Documentum object to be linked to an SAPobject, PS SAP must be able to find the related object in SAP. Here you specify alookup into SAP which identifies the single object which the document should belinked to. For example, key.Material="%s", object_name will instruct PS SAP tolink the Documentum object to a SAPmaterial which has the material name equalto the Documentum object_name.

12. Click OK to save the Documentum to SAP link configuration.

Replication of information between Documentum and SAP

PS SAP provides a facility formaintaining the integrity of documents held in SAPwith thosestored in Documentum.

30 EMC Documentum Process Services for SAP Configuration Guide

Configuring Process Services for SAP

3

Replication is the duplication of data held in one system into another system.

The replication process, once started, updates all objects not matching the set conditionsand not yet updated.

Replicate SAP objects

In the following example you want to replicate all pumps within SAP as folders in the/SAP/Material folder (in theDocumentum repository) in order to store additional documentsto each pump in that folder. Replicating here means that the folder should have the sameattributes, as the actual SAP object has, in order to be able to search for a specific pump inthe repository as well. When the folders are generated you would be able to link them backto the SAP pump objects.

You will need to create/configure:

• An SAP Query Select all pumps selects materials with the following condition:

Description = pump*

This query (Querytype: Material by Description) returns the following attributes:

Description, Type, Industry, Material

• Documentum Object Type dm_folder is the Documentum Object Type that you want torepresent the SAP pumps in the repository.

• Replicate SAP Action Replicate material folder has the following rules:

The Object Key rules are used to check whether there is a dm_folder object with the path/SAP/Material and the object_namematching the material attribute of the current pumpobject in SAP.

Table 8: Replicate SAP object key rules

= "%s", Materialobject_name

= "/SAP/Material"FOLDER

The Update Condition rules are used to check whether the attributes of the folder haveto be updated (only validated if update object is checked). Here you only update thefolder if the title of the folder is empty.

TheMap Rules are used to define themapping of the SAP attributes to the Documentumattributes.

Table 9: Replicate SAP object map rules

= "%s", Materialobject_name

Replicate SAP objects 31

Configuring Process Services for SAP

3

= "%s", Descriptiontitle

= "/SAP/Material"FOLDER

The result is:

The Replicate SAP action runs Select all pumps (SAP Query), returning a number of SAPmaterial objects with their description matching pump*.

For each object returned, the Replication action checkswhether the dm_folder object alreadyexists. Assuming the attribute Material of the first pump is Pump One, the query looks likethis:

Select r_object_id from dm_folder where object_name ='Pump One' andfolder('/SAP/Material')

If the folder does not exist (no record returned), the action checks whether it should createone (create object is checked). Otherwise it checks the update condition (update object ischecked). In this case the action checks whether the title of the returned dm_folder is empty.

If the folder has to be created or updated, the actionmaps the SAP attributes to the specifiedDocumentum attributes.

Table 10: Replicate SAP objects action maps

= "Pump One"Object_name

= "Electr. Pump"Title

FOLDER

Note: FOLDER is a special attribute since it does not really exist. The action creates the dm_folderobject in the specified repository folder if a creation is necessary.

This loopwill be repeated for each object returned by Select all pumps (SAPQuery), therebyestablishing the goal:

1. Connect to WebAdmin as described in “Logging in to WebAdmin” on page 12.

2. Click to expand the Actions subnode and select the Replicate SAP subnode.

The Replicate SAP screen appears.

3. Select File > New > Replicate SAP from the menu at the top of the Replicate SAP screen.

The New Replicate SAP action screen appears.

32 EMC Documentum Process Services for SAP Configuration Guide

Configuring Process Services for SAP

3

4. Type an action name in the Action: in the field.

5. Select the SAP System from the SAP System Type list box.

6. Select the Object type from the Object Type: list box.

7. Select the SAP query from the SAP Query: list box.

8. Link Workflow is set to No Workflow.

9. Select Update object, if required.

10. Select Create object, if required.

11. For the Object Key, Update Condition, and each Define Map Rule you want to define:

a) Select the variable from the Variable list box.

b) Type the format of the variable in the Format field.

The entry is altered with %s automatically added at the end.

c) Select the parameter required from the list box below the Parameters field, and clickthe up arrow to add the parameter to the Parameters field.

d) Click Add to add the rule to the Object Key, Update Condition, and Defined Map Rulesfield.

12. Click OK to save the action.

Replicate Documentum objects

In the following example, you want to update the status of Document Info Record (DIR)attribute in SAP to reflect a change in the status of the Documentum object. Replication inthis examplemeans updating SAP objects, not creating new ones. This example can be foundas a configuration object in WebAdmin, called Update DIR status . We will execute aDocumentum query and update the related DIRs to reflect a change in document status.

You will need to create/configure:

• A Documentum Query SelectMaterialFolders selects objects of type dm_folderwhere the folder's location has to be /SAP/Material .

select r_object_id,object_name from dm_folder where

folder('/SAP/Material')

• An SAP Object Type: Document info record is the SAP Object Type that you wantto update in SAP.

• Replicate Documentum Action Update DIR status, which has the following rules:

Replicate Documentum objects 33

Configuring Process Services for SAP

3

The Object Key rules are used to check whether there is an SAP object for the currentdm_folder with the document number attribute matching the folder's object_ID.

Table 11: Replicate Documentum objects key rules

= %s, r_object_idDocumentNumber

= DRWDocumentType

= 000DocumentPart

= 00DocumentVersion

• TheUpdate Condition rules are used to checkwhether the attributes of the SAP objecthave to be updated (only validated if an update object is checked.) This meanswe update the DIR only if its status is AA.

Table 12: Replicate Documentum objects update condition rules

= AADocumentStatus

• The Map Rules are used to define the mapping of the Documentum attributes to theSAP attributes.

Table 13: Replicate Documentum objects map rules

= IADocumentStatus

TheReplicateDocumentumaction runsSelectMaterialFolders (DocumentumQuery),returning the sub folders of /SAP/Material.

For each folder returned, the Replication action checks whether the correspondingMaterialMaster object exists in SAP. If it does, the DocumentStatus attribute for the DIR will bechecked to see if it is AA. If it is, the status will be updated to IA.

Use the following procedure to replicate Documentum objects in SAP:

1. Connect to WebAdmin as described in “Logging in to WebAdmin” on page 12.

2. Click to expand the Actions subnode and select the Replicate Documentum subnode.

The Replicate Documentum screen appears.

3. Select File > New > Replicate Documentum subnode.

34 EMC Documentum Process Services for SAP Configuration Guide

Configuring Process Services for SAP

3

The New Replicate Documentum action screen appears.

4. Type an action name in the Action: field.

5. Select the SAP system from the SAP System Type: list box.

6. Select the SAP object from the SAP Object: list box.

7. Select the Documentum query from the Documentum Query: list box.

8. Link Workflow is set to No Workflow.

9. Select Update object, if required.

10. Select Create object, if required.

11. For the Object Key, Update Condition, and each Map Rule you want to define:

a) Select the variable from the Variables list box.

b) Type the format of the variable in the Format field.

The entry is altered with %s automatically added at the end.

c) Select the parameter required from the list box below the Parameters field, and clickthe up arrow to add the parameter to the Parameters field.

d) Click Add to add the rule to the Object Key, Update Condition, and\or Map Rules field.

e) Click OK to save the action.

Working with the FILTER attribute

The FILTER attribute is a symbolic target that specifies an external command line to runwhen creating links.

The FILTER attribute conforms to the following syntax:

Path Arg1 Arg2 ArgN r_object_ID Repository

User Name PasswordThe parameters used in the syntax are described below.

Table 14: Filter attribute parameters

DescriptionParameter

Fully qualified path to an executablePath

Working with the FILTER attribute 35

Configuring Process Services for SAP

3

Table 14: Filter attribute parameters (continued)

DescriptionParameter

Arbitrary parameters as defined by your fil-ter program

Arg1, Arg2,...ArgN

r_object_id of the current objectr_object_id

Name of the repository where you wouldlike to run the executable

Repository

Username used to connect to the repositoryUser Name

Password that corresponds to the user-name described in this table

Password

You can use these parameters to pass additional values to the external filter; use theprintf()–format string for this purpose.

If the execution is successful, the external filter returns 0 as the exit code; if unsuccessful, itreturns a non–zero value as the exit code.

36 EMC Documentum Process Services for SAP Configuration Guide

Configuring Process Services for SAP

3

Appendix A

Understanding SAP and PSSAP Terms

DFCDocumentum Foundation Classes. A key part of the EMCDocumentum software platform.From the EMC Documentum functionality point of view, DFC lies between EMCDocumentum Content Server and EMC Documentum clients. DFC is Java-based.

DMCLDocumentum Client Library. Manages communication between clients and EMCDocumentum Content Server. Contains a library of API calls that are used by clients forexecution on the EMC Documentum Content server. All client requests to the EMCDocumentum Content Server go through the DMCL.

EMC Documentum Content ServerContent Server is the foundation of Documentum's content management system. ContentServer is the core component that allows users to create, capture, manage, deliver, andarchive enterprise content. The functionality and features of Content Server provide contentand process management services, security for the content and metadata in the repository,and distributed services.

Execute SAP QueryComponent enabling the execution of pre-configured SAP queries specified by name.

LDAPLightweightDirectoryAccess Protocol. Industry-standard networking protocol that queriesand modifies directory services.

Link DocumentumComponent enabling the creation of SAP Document Info Record (DIR) Links, establishingrelationships between SAP objects and EMC Documentum objects.

Link SAPComponent enabling the creation of DIR Links between SAP objects and Documentumqueries, establishing relationships between EMC Documentum objects and SAP objects.

EMC Documentum Process Services for SAP Configuration Guide 37

Process Services for SAPA tool for automating business processes by creating a workflow template that captures thedefinition of the business process. Individual processes generated from an activity templateare called workflows.

QueryRelated ObjectsActivity template that returns a list of DIR keys related to a specified document.

Replicate DocumentumComponent that executes a specific Documentum replication action for all Documentumobjects returned by a CS SAP Agent query, or for a specific document only.

Replicate SAPComponent that executes a specific SAP replication action for all SAP objects returned bya CS SAP Agent query, or for a specific object selected from a workflow.

RepositoryAny information source such as a file system, content management system, and so on.

SAP Web ASAn evolution of the component SAP_BASIS. Using the Web as a technology platform forSAP applications, you can develop business applications in ABAP or Java.

User MappingA feature that establishes a relationship between user credentials in the local and remotesystems.

38 EMC Documentum Process Services for SAP Configuration Guide

Understanding SAP and PS SAP Terms

Index

$ARG#s 27

AActions page 14attribute map 28attributes 24, 31Auto Manage 27

BBAPI 20

CCAD Applications 24carrier types 25configuring queries 16configuring workflows 16

DDIR 24DIR attributes 27, 30disconnect due to inactivity, WebAdmin 13DMS 24DocumentDescription 25DocumentNumber 25DocumentStatus 25DocumentType 25Documentum page 13Documentum query 20, 22, 28DQL query 22DQL statement 23

Fformat string 30

Iinstallation

requirements 7integrity of documents 30

Llinking objects 24lookup key values 30

PPLM Interface 24prerequisites

system administrator 7PS SAP 7

Qquery condition composer 22query result 24

Rreplicating systems 30rule composer 25

SSAP CAD interface 20SAP connection parameters 27

EMC Documentum Process Services for SAP Configuration Guide 39

SAP object 28SAP page 13SAP queries 20SAP server 20SAP table query 20SAP user 20system administrator 7

prerequisites 7

System Information 13

WWebAdmin

disconnect due to inactivity 13disconnecting 13logging in 12

40 EMC Documentum Process Services for SAP Configuration Guide

Index