sap installation guide...in our case caf j2ee and ep j2ee must have installed certificates of each...

47
SAP ® Installation Guide © 2006 SAP AG SAP Title: How to adjust CAF – KM Integration Version: 1.4 Page 1 of 47 Release: 1.4 Author: SAP How to Set Up CAF - KM Integration for CAF 7.00 History Version Status Date 1.4 Released 12-03-2006

Upload: others

Post on 10-Oct-2020

0 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP®

Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 1 of 47

Release: 1.4

Author: SAP

How to Set UpCAF - KM Integration for CAF 7.00

History Version Status Date

1.4 Released 12-03-2006

Page 2: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 2 of 47

Content

1 Introduction ....................................... ................................................... 3

2 When CAF and EP are installed on the same J2EE inst ance........... 4

3 Certificate installation........................... ............................................... 4

3.1 Export EP J2EE signing certificate.................................................................. 4

3.2 Export CAF J2EE signing certificate ............................................................... 5

3.3 Import EP J2EE certificate into CAF J2EE...................................................... 5

3.4 Import CAF J2EE certificate into EP J2EE...................................................... 6

4 J2EE Maintenance ................................... ............................................ 6

4.1 Configuring CAF J2EE Engine........................................................................ 6

4.2 Configuring EP J2EE Engine .......................................................................... 9

5 CAF components Maintenance......................... ................................ 10

5.1 CAF Runtime properties maintenance ...........................................................10

5.2 Enterprise Portal maintenance.......................................................................11

5.3 CAF Notification and Subscription API maintenance......................................23

5.4 CAF Collaboration Service Maintenance........................................................26

6 Index Maintenance.................................. ........................................... 35

6.1 Create index_service user .............................................................................35

6.2 CAF Users to support indexing: caf_svc_user................................................37

6.3 Adjust CAF KMIndexSvc................................................................................40

6.4 TREX configuration........................................................................................42

6.5 Create CAF BO Index....................................................................................43

6.6 Monitoring of Indexes.....................................................................................45

7 Known Issues....................................... .............................................. 45

8 Additional Information............................. .......................................... 47

Page 3: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 3 of 47

1 Introduction

This document describes steps which have to be done to adjust integration between CAF J2EE engine and Enterprise Portal (EP)

The basic issue of the KM integration is to bring together Content Management and Collaboration Services of an Enterprise Portal (EP) 6.0 into a Composite Application Framework (CAF). To make services executed in KM available for Business Entities.

In order to adjust integration between CAF J2EE and Enterprise Portal several steps must be per-formed.

Page 4: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 4 of 47

2 When CAF and EP are installed on the same J2EE in -stance

If you have installed SAP EP and СAF on the same J2EE instance you have to skip certificates instal-lation and J2EE maintains paragraphs and start from CAF components Maintenance.

3 Certificate installation

In order to make CAF Services available for EP services and visa versa Single-Sign-On (SSO2) au-thentication is used. The purpose of SSO authentication is providing user credential to external sys-tems. After user has logged on, J2EE system encodes user info using private signing key and set up SSO2 logon ticket (cookie with encoded user credential). Other systems must have imported signing certificate from specific system to decrypt such info. Therefore signing certificate must be imported for each system that should be trusted.

In our case CAF J2EE and EP J2EE must have installed certificates of each other.

3.1 Export EP J2EE signing certificate

Login to the EP J2EE Visual Admin Tool and go to the Services -> Key Store -> Runtime

Select view "TicketKeystore " -> select SAPLogonTicketKeypair-cert entry than press "Export " but-ton and save certificate to disk as <EP_J2EE_MACHINE_NAME>_<SYSTEM_ID>.crt file.

Page 5: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 5 of 47

3.2 Export CAF J2EE signing certificate

Export of CAF J2EE signing certificate should be performed as well as export of EP J2EE certificate

Login to the CAF J2EE Visual Admin Tool and go to the Services -> Key Store -> Runtime

Select view "TicketKeystore " than select SAPLogonTicketKeypair-cert entry than press "Export " button and save certificate to disk as <CAF_J2EE_MACHINE_NAME>_<SYSTEM_ID>.crt file. (See picture from 3.1)

3.3 Import EP J2EE certificate into CAF J2EE

Login to the CAF J2EE VisualAdmin Tool and go to the Services -> Key Store -> Runtime

Select view "TicketKeystore " and press "Load " button and select <EP_J2EE_MACHINE_NAME>_<SYSTEM_ID>.crt (that had been received in 3.1)

Page 6: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 6 of 47

3.4 Import CAF J2EE certificate into EP J2EE

Import of CAF J2EE certificate should be performed as well as import of EP J2EE certificate

Login to the EP J2EE Visual Admin Tool and go to the Services -> Key Store -> Runtime

Select view "TicketKeystore " and press "Load " button and select <EP_J2EE_MACHINE_NAME>_<SYSTEM_ID>.crt (that have been received in 3.2) See picture from 3.3 for more details

4 J2EE Maintenance

4.1 Configuring CAF J2EE Engine

4.1.1 Configuring UME Policy

Login to the CAF J2EE Visual Admin Tool and go to the Services -> Security Provider

Select the tab “Policy Configurations ”

For each of the following policy configurations, click tab “Security Roles”

Page 7: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 7 of 47

1. Add your guest group “Guests” to security role “view-creator” of policy configuration “key-store-view.TicketKeystore”.

2. Add the group “Everyone” to security role “view-creator” of policy configuration “keystore-view.securestorage”

3. Add your guest group “Guests” to the security role “KeystoreViewsCreator” of policy configura-tion “SAP-J2EE-Engine”

4.1.2 Configuring UME Authentication template

• In CAF J2EE Visual Admin Tool go to the Services ->Security Provider -> Policy Configuratio ns -> Components and make sure that next login modules are included into “ticket” authorization template:

EvalulateTicketLoginModule (SUFFICIENT)

BasicPasswordLoginModule (REQUISITE)

CreateTicketLoginModule (OPTIONAL)

Page 8: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 8 of 47

• Modify the options of EvaluateTicketLoginModule and CreateTicketLoginModule - add the following properties:

trustedsys =<the issuer distinguished name>,000 (for example EP6,000)

trustediss =<the issuer distinguished name> (for example CN=EP6, OU=EPTeam, O=SAP Trust Community, C=DE)

trusteddn =<the subject distinguished name> (for examle CN=EP6, OU=EPTeam, O=SAP Trust Community, C=DE)

You can find value for trusteddn, trustediss properties in portal certificate ("DN of Owner", "DN of Issuer") fields

If you have to setup SSO Authentication with more than one portal you should to add this proper-ties for each portal using index at the end of property (i.e. trustedsys1=..., trustedsys2… and etc.

Page 9: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 9 of 47

• In CAF J2EE Visual Admin Tool go to the Services -> Security Provider -> Policy Configu-ration

• Select sap.com/caf~runtime~ear*CAFDataService_config component and set up Authentication -> Authentication template as "Ticket "

• Select sap.com/caf~runtime~ear*sap.com~caf~km~cafdataservi ce.jar component and set up Authentication -> Authentication template as "Ticket "

Be aware that it is necessary to set up authentication template for sap.com/caf~runtime~ear*CAFDataService_config component every time after caf~runtime~ear rede-ploy

4.2 Configuring EP J2EE Engine

Configuring of EP J2EE Engine should be performed as well as CAF J2EE Engine configuration

4.2.1 Configuring UME Policy

Login to the EP J2EE Visual Admin Tool and go to the Services -> Security Provider

Select the tab “Policy Configurations ”

For each of the following policy configurations, click tab “Security Roles”

1. Add your guest group “Guests” to security role “view-creator” of policy configuration “key-store-view.TicketKeystore”.

2. Add the group “Everyone” to security role “view-creator” of policy configuration “keystore-view.securestorage”

3. Add your guest group “Guests” to the security role “KeystoreViewsCreator” of policy configura-tion “SAP-J2EE-Engine”

Page 10: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 10 of 47

4.2.2 Configuring UME Authentication template

• In EP J2EE Visual Admin Tool go to the Services ->Security Provider -> Policy Configuratio ns -> Components and make sure that next login modules are included into “ticket” authorization template:

EvalulateTicketLoginModule (SUFFICIENT)

BasicPasswordLoginModule (REQUISITE)

CreateTicketLoginModule (OPTIONAL)

• Modify the options of EvaluateTicketLoginModule and CreateTicketLoginModule - add the following properties:

trustedsys =”<the issuer distinguished name>,000” (for example C03,000)

trustediss =”CN=<the issuer distinguished name>” (for example CN=C03)

trusteddn =”CN=<the subject distinguished name>” (for example CN=C03)

You can find value for trusteddn, trustediss properties in CAF J2EE certificate ("DN of Owner", "DN of Issuer") fields

If you have to setup SSO Authentication with more than one CAF J2EE you should to add this properties for each portal using index at the end of property (i.e. trustedsys1=..., trustedsys2… and etc.

• Set up authentication template for portal component: In EP J2EE VisualAdmin Tool go to the Services -> Security Provider -> Policy Configurati on. Select sap.com/irj*irj component and set up Authentication -> Authentication template as "Ticket "

5 CAF components Maintenance

5.1 CAF Runtime properties maintenance

• In CAF J2EE Visual Admin Tool go to Server XY -> Services -> Configuration Adapter select tab Runtime -> Display Configuration and go to the Configurations -> apps -> sap.com -> caf~runtime~ea r -> appcfg

• Switch to edit mode and open "Propertysheet application.global.properties "

• Set correct value for properties KM_MACHINE_ADDRESS, KM_MACHINE_PORT

• Change value KM_REPOSITORY to "/caf-<J2EE_MACHINE_NAME>-<SYSTEM_ID>" (for example /caf-epmwXXX-N74)

• Change value IDX_PREFIX to "caf-<J2EE_MACHINE_NAME>-<SYSTEM_ID>" (for example caf-EPMWXXX-N74) and press OK

Page 11: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 11 of 47

• Change value KM_TMP_REPOSITORY_FOLDER to "/documents_xapps_<J2EE_MACHINE_NAME>_<SYSTEM_ID>" (for example /documents_xapps_EPMWXXX_N74) and press OK

• Restart J2EE Engine

5.2 Enterprise Portal maintenance

In order to provide access to BE from KM services CAF Repository Manager is used. It gives the pos-sibility to make accessible Business Entity instances (that are not persisted in KM) by KM framework.

5.2.1 Adjust CAF Security Manager

CAF Security Manager allows restricting the access to CAF Repository on the permissions configured in the CAF Authorization View. In order to adjust CAF Security Manager follows the next steps

• Login to EP (http://<EP_HOST>:<PORT>/irj)

• Go to the System Administration -> System Configuration -> Kn owledge Management (-> Con-figuration) -> Content Management -> Repository Man agers -> (Switch to Advanced

Page 12: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 12 of 47

Mode) Security Manager -> CAF Security Manager

• Press "New" button and enter values for next properties: Name = CAFSecurityManager_<J2EE_MACHINE_NAME>_<SYSTEM_ID> for example CAFSecurityManager_EPMWXXX_N74 List of invisible business objects = sap.com/caf.core/Document (It means that these objects won’t be available on KM, in the document and CAF repoitory) URL of CAF Web Service = http://<J2EE_MACHINE_NAME>:<PORT>/CAFDataService/Config?style=rpc_enc

• Save changes

Page 13: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 13 of 47

5.2.2 Add/Adjust CAF Repository manager

• Login to EP (http://<EP_HOST>:<PORT>/irj) and go to the System Administration -> System Configuration -> Kn owledge Management (-> Configura-tion) -> Content Management -> Repository Managers -> CAF Repository

• Press "New" button to create the new CAF repository or “Edit” for existent

• Enter values for next properties

Repository name = caf-<J2EE_MACHINE >-<SYSTEM_ID> (Value of property KM_REPOSITORY from CAF Runtime properties without forward slash)

Prefix = /caf-<J2EE_MACHINE >-<SYSTEM_ID> (Value of property KM_REPOSITORY from CAF Runtime properties)

Active = <checked>

Security Manager = Name of security manager from 5.2.1 (for example CAFSecurityManager_EPMWXXX_C03)

List of objects that are editable via the CAF objec t editor = sap.com/caf.core/Document

Page 14: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 14 of 47

URL of CAF webservice = http://<J2EE_MACHINE >:<PORT>/CAFDataService/Config?style=rpc_enc

List of templates that are used in display name gen eration = List of templates that are used in display name generation. Allows to define a display name of a KM resource. Entries in the list are separated by ';'. Each entry consists of a name-value-pair which contains the full qualified object name and the template that is used for display name generation (for example: sap.com/caf.tests/Course=Description: "<description>" (created by: "<creat-edBy>");sap.com/caf.tests/Student=Title: "<title>")

Page 15: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 15 of 47

For the property value “sap.com/caf.tests/Course=Description: "<description>" (created by "<creat-edBy>");” a resource name will be displayed as shown below:

After changes are made, restart service “sap.com~caf~km.ep.repmanager” as shown below:

Page 16: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 16 of 47

Page 17: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 17 of 47

5.2.3 Adjust CAF Document Repository

• Login to EP (http://<EP_HOST>:<PORT>/irj) and go to the System Administration -> System Configuration -> Kn owledge Management (-> Configura-tion) -> Content Management -> Repository Managers -> CM Repository-> docu-ments_xapps

• Press "Duplicate" button!

• Enter the following values:

Name = /document_xapps_<J2EE_MACHINE >_<SAP System ID> Prefix = /document_xapps_<J2EE_MACHINE >_<SAP System ID> (Value of property KM_TMP_REPOSITORY_FOLDER from CAF Runtime properties)

Repository ID in Database = document_xapps_<J2EE_MACHINE >_<SAP System ID>

Security Manager = Name of security manager from 5.2.1 (for example CAFSecurityMan-ager_EPMWXXX_XXX)

• Restart EP

Page 18: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 18 of 47

5.2.4 Adjust URL Generator Service

You may need to adjust URL Generator Service. To do this login to EP (http://<EP_HOST>:<PORT>/irj) and go to the System Administration -> System Configuration -> Kn owledge Management (-> Configura-tion) -> Content Management -> mode -> Advanced -> Global Services -> URL Generator Service .

Page 19: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 19 of 47

Configure host property.

(“http://<host>:<port>”)

Page 20: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 20 of 47

Type the correct host and port values to marked line. Form is http://<EP_HOST>:<PORT> (use real host and port values here. It is preferable to use full-qualified host name, example http://epgsd003.grodno.epam.com:50000)

5.2.5 Adjust CAF Repository manager and CAF Documen ts Repository man-ager for development or troubleshooting process

Usually CAF stores documents in CAF Documents Repository. By default CAF Repository man-ager and CAF Documents Repository manager use CAF security manager so that repository managers are not browseable for users. You may need it to become browseable for development or troubleshooting purposes.

For CAF Repository manager follow next:

• Login to EP (http://<EP_HOST>:<PORT>/irj) and go to the

System Administration -> System Configuration -> Kn owledge Management (-> Configura-tion) -> Content Management -> Repository Managers -> CAF Repository

• Select(or create see 5.2.2) CAF repository manager (possibly you may need to press "Edit" but-

ton) and select security manager from dropdown list:

Security Manager = “AclSecurityManager”

Page 21: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 21 of 47

• Click on "Show Advanced Options " link and uncheck “Hide in Root Folder” checkbox

For CAF Documents Repository manager you may do the same, except you have not to select CAF Repository but CM Repository after the first step. Then you have to select the “docu-ments_xapps” repository manager.

5.2.6 Adjust Mime Handler Service properties

CAF attachments MIME type is calculated with a help of global portal service MimeTypeHandler, which should be configured BEFORE using NONE-standard file extension.

Portal path to configuration screen is:

System Administration>System Configuration> Knowledge management > Content Manage-ment>Utilities>MIME Types

Page 22: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 22 of 47

Here you can modify existing group or define new one. Fro example is you want to *.log files to be recognized as plain text files, you should created new group, and set its name as logFiles , exten-sion as log and mime type as plain/text .

Page 23: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 23 of 47

5.2.7 Configuring CAF Security Zone

Configure “com.sap.caf/DefaultSecurity” security zone as described in 5.4.6

5.3 CAF Notification and Subscription API maintena nce

In order to use CAF Notification and Subscription API in your applications do the following:

5.3.1 Adjust email channel and channel originator o n EP J2EE engine

In order to use notifications you have to adjust e-mail channel and e-mail originator on EP. Follow next:

• Login to EP (http://<EP_HOST>:<PORT>/irj) as administrator. • Go to the System Administration -> System Configuration -> Knowledge

Management -> Content Management->Utilities->Channels->E-mail Channel

• Create an e-mail channel “EMAIL" or you may use an existing one. Input proper type, server name, user and password

• Go back to Content_Management -> Utilities -> Channel Originators • Create an e-mail originator or change the existing one. Select EMAIL from

“Channel” dropdown list. Input originator address

Page 24: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 24 of 47

5.3.2 Adjust CAF KMNotificationSvc

New versions of EP can not work with logon ticket. You may need to do the following:

• Login to the J2EE Visual Admin Tool • Go to

Services->Destinations->WebService • Select

sap.com/caf~km.proxies/KMNotificationSvc/com.sap.portal.prt.soap.KMNotificationSvc

• Select Authentication as “BASIC” • Input user name and password • Press “Save” button

Page 25: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 25 of 47

5.3.3 Adjust CAF runtime

• Login to J2EE Visual Admin Tool • Go to the Services->Configuration Adapter->apps->sap.com-

>caf~runtime~ear->appcfg • Switch between view and edit mode • Open "Propertysheet application.global.properties" by double clicking on

left mouse button • Ensure “PUBLISH_ENABLED” property is “true” (default is “false”)

5.3.4 Adjust Subscriptions

You have to maintain you subscriptions by using CAF subscriptions UI resided on your CAF J2EE engine

• Go to http://<host>:<port>/webdynpro/dispatcher/sap.com/caf~UI~subscriptions/Subscriptions

• You must register subscriptions you want to use

Page 26: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 26 of 47

5.4 CAF Collaboration Service Maintenance

5.4.1 Configuring Portal Collaboration service

Follow the next steps: • Go to the System Administration -> System Configuration -> Service Con-

figuration -> Applications -> "sap.com~caf~km.ep.kmcollaborationsvc" -> Services -> KMCollaborationSvc -> Configure

• Check the properties as described below:

Page 27: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 27 of 47

5.4.2 Configuring Room Categories

Follow the next steps: • Go to the System Administration -> System Configuration -> Knowledge

Management -> Collaboration -> Room Categories • Please, make sure the "default_category" exist as shown below. If it is not so,

create the new Category with the same parameters.

Page 28: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 28 of 47

5.4.3 Configuring Room Templates

Follow the next steps: • Go to the Content Administration -> Collaboration Content -> Room

Template Administration • Please, make sure that the "SAP_Standard_Template" exist in the list of

available templates:

Page 29: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 29 of 47

If this template doesn’t exist, create the new one as described below and press “Next”!

Add the new “MemberAdmin” role and assign permissions as shown below:

Go through the all other steps with parameters by default and save the new template.

Page 30: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 30 of 47

5.4.4 Configuring Room Search Properties

Follow the next steps: • Go to the System Administration -> System Configuration -> Knowledge

Management -> Collaboration -> Room Search Properties • If you are not going to use TRex search or you don’t have installed and config-

ured TRex search engine you have to disable the option “Use TRex” as shown below:

Page 31: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 31 of 47

5.4.5 Configuring CAF Repository Manager

Follow the next steps: • Go to the System Administration -> System Configuration -> Knowledge

Management -> Content Management -> Repository Managers -> CAF Repository

• Please, make sure that the Discussion service is added in the Repository Ser-vices list:

Page 32: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 32 of 47

5.4.6 Configuring Portal Permissions

Follow the next steps: • Go to the System Administration -> Permissions -> Portal Permissions ->

Security Zones -> com.sap.caf -> DefaultSecurity -> Open Permissions (Context Menu)

• Please, make sure that the group “Everyone” is added in the list of Assigned Permissions as shown below:

• If not, please add the group! • Select Adminstrator: None • Check the “End User” flag . • Save your settings

Page 33: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 33 of 47

Page 34: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 34 of 47

• Go to the System Administration -> System Configuration -> Permissions -> Portal Permissions -> Security Zones -> sap.com -> NetWeaver.KMC -> low_safety -> com.sap.km.cm -> components -> uidiscussion -> Open Permissions

• Please, make sure that the group “Everyone” is added in the list of Assigned Permissions as shown below:

Page 35: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 35 of 47

6 Index Maintenance

6.1 Create index_service user

• In Visual Admin go to the Services ->Security Provider select tab User Management and press Search button.

• Ensure that index_service user present. If not than add index_service user.

• Note: After user creation you have to change his password

Page 36: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 36 of 47

• Open http:// <J2EE_MACHINE>:<PORT>/webdynpro/dispatcher/sap.com/caf~UI~ptn~authorization/Authorization and ensure that index_service user has read Permission for sap.com/caf.core/Document

Page 37: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 37 of 47

6.2 CAF Users to support indexing: caf_svc_user The ‘index_service’ user is used on CAF side to check permissions of KM documents for in-

dexing. The ‘caf_svc_user’ user has been introduced to index CAF objects. Repeat step 6.1 to create ‘caf_svc_user’. The new user should have 'read' access to all entities which can be in-dexed. The ‘caf_svc_user’ has to be mapped to the ‘caf_svc_role’ after the CAF runtime ear has been deployed:

Please note that group “Everyone” has to be removed from the mappings! Cluster should be restarted after mapping!

• Please enter the user management engine of your java application server (“http://<host>:port/useradmin/index.jsp”) and create a new user here. The name has to be “caf_svc_user”

• In the field “password information” choose “Disable Password”.

• Please enter the Visual Administrator and choose: Server XX -> Services -> Security Provider -> Runtime ->Policy Configurations -> sap.com/caf~runtime~ear*sap.com~caf~runtime~impl.jar -> Security Roles -> RoleType: Se-curity Role

• Confirm the Pop Up

Page 38: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 38 of 47

• Add the new caf_svc_user!

Page 39: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 39 of 47

Page 40: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 40 of 47

6.3 Adjust CAF KMIndexSvc New versions of EP Web Services can not work without authorization. You may need to do the

following: • Login to the J2EE Visual Admin Tool • Go to Services->Destinations->WebService • Select sap.com/caf~km.proxies/KMIndexSvcJNDI/KMIndexSvc • Select Authentication as “BASIC” • Input user name and password • Press “Save” button

Page 41: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 41 of 47

Page 42: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 42 of 47

6.4 TREX configuration

Open Visual Admin tool and connect to EP instance. Go to the Services -> TREX Service.

• Set nameserver.address parameter (nameserver.address=tcpip://epgsd003:30101), up-date

If you don’t know the port where the nameserver is running you can retrieve it in the following way.

o Start the SAP Management Console on the machine where the T-Rex is installed and running

o Navigate the tree below the SAP system id and the instance name to “Current Status”. This branch holds another sub branch called “Name-Server”

o The property “..listenport” holds the port number where the nameserver is listening to

• Set queries.usecache parameter to false, update

Page 43: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 43 of 47

Save changes and restart the service.

6.5 Create CAF BO Index

• Open http://<J2EE_MACHINE>:<PORT>/webdynpro/dispatcher/sap.com/caf~UI~km~admin/IndexAdmin

• Select “Searchable Entity Services”, select entities that you would like to be searchable by T-Rex and press “Set as Searchable” button

• Check the entity and also related sub-entities if they shall be indexed also and press ok!

Page 44: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 44 of 47

• Switch to the “Index Details” tab!

• Choose a single entity service and press “Reindex Selected” or push “Reindex all”

• You can now check the status of the index for each entity on this tab. Please check if the status is green and the number of instances in DB equals the number of instances in the in-dex! This might take some time. Therefore please push the “Refresh” button.

• If the status is red or the number of instances in DB is permanently greater than the number of instances in the Index, please check the “Errors” tab and also the preceding steps of this in-

Page 45: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 45 of 47

structions! You can also use the T-Rex Administration Tool that is installed on the machine, where the T-Rex is running. You find it at: “\usr\sap\<SAP_SID>\<instance>\exe\python_support\TREXAdmin.py”. You should first check in the “services” tab if the http server is running. Next please check the queue content! Are there any queues stuck? Please check also the next chapter!

6.6 Monitoring of Indexes

• You can monitor indexes by opening http://<EP_MACHINE>:<PORT>/irj/portal. Follow Sys-tem Administration -> Monitoring ->Knowledge Manage ment -> Trex monitor -> Display Queue Entries. Select Index ID . Set Retry Count = 0 and press Display button. Queue Entries have to appear.

7 Known Issues

1. In order to use upload functionality please check value of “MultipartBodyParameterName” Web Container property (Services -> Web Container -> Properties). It must be equal to “com.sap.servlet.multipart.body”

Page 46: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 46 of 47

Page 47: SAP Installation Guide...In our case CAF J2EE and EP J2EE must have installed certificates of each other. 3.1 Export EP J2EE signing certificate Login to the EP J2EE Visual Admin Tool

SAP® Installation Guide

© 2006 SAP AG

SAP

Title: How to adjust CAF – KM Integration

Version: 1.4

Page 47 of 47

2. If you have installed previous version of CAF please check “Authentication” parameter value of KMBaseSvc service destination. Login to Visual Admin tool and go to the Services -> Des-tinations -> Properties -> WebServices -> sap.com/caf~km~proxies/KMBaseScxJNDI/KMBaseSvc -> A uthentiction. It must be set to “Logon Ticket” value.

3. CAF versions before 7.00 SP7 uses WebDynPro class to define MIME type of uploaded document. In this case, MS Word documents get "application/vnd.ms-word" type. Starting from 7.00 SP7 CAF uses EP routines, and the documents get “application/msword”. Both types are valid, but the only 2nd one is accepted by TREX by default. As result, MS Word documents can NOT be found. To fix it, add string “application/vnd.ms-word” to the configuration file: “\usr\sap\<a trex instance name 1>\<a trex instance name 2> \<hostname>\TREXValidMimeTypes.ini”

8 Additional Information

1. “EP6 Web Service SSO2 Integration”

2. SAP NOTE 721815