Integrating KM Documents in CAF

Use

This procedure describes how to integrate and use the available KM services and complex types in your composite application. You can use these predefined services in associations with custom-defined business objects or in the implementation of the application services you created in your composite application.

Prerequisites

To use Knowledge Management (KM) in CAF you need to configure SAP NetWeaver 7.0 to serve as a provider system for your SAP NetWeaver Composition Environment. We refer to SAP NetWeaver 7.0 as a provider system and to SAP NetWeaver Composition Environment as a consumer system. You must have configured access rights and created default users for the provider and the consumer systems.

More information: Configuring CAF for Knowledge Management Integration .

Procedure

Optional: Create a business object and an association to the KM business object Document:
1. Create a business object.
  More information: Creating Business Objects .
2. Open the Associations tab page of the business object you have created.
3. In the predefined caf.core services tree, navigate to Document and choose with the quick info text Add Dependency.
Create an application service and set dependencies to the KM business object Document or to the KM application service DocContent:
1. Create an application service.
  More information: Creating Application Services .
2. Open the Dependency tab page of the application service you have created.
3. In the predefined caf.core services tree, navigate to the business object Document or to the application service DocContent and choose with the quick info text Add Dependency.
Create an operation for your application service:
1. Open the Operations tab page of your application service and choose Add.
2. Enter name and description for the operation and enable the Implemented indicator.
3. Define input, output parameters and fault messages.
Implement the business logic for working with the KM services:
1. Open the Implementation tab page and open the java file.
2. To create an instance of the Document business object import the following code in the implementation of the operation you have created:
```
DocumentServiceLocal docSvc = getDocumentService();

Document docCr = docSvc.create(getFileName(DocFilePath),null) ;
```
3. To get a reference to the DocContent application service import the following code in the implementation of the operation you have created:
```
DocumentServiceLocal docContentLocal =  getDocContentService();
```
4. To execute an operation with the document use one of the DocContent operations.
5. Optional: Implement specific business logic depending on your scenario. For example, you can read or upload file content.
  More information: Predefined Services and Data Types .
Configure permissions for accessing the KM document on the consumer and the provider systems:
1. Create identical default users on the provider and the consumer systems.
  More information: Creating a Technical User .
2. On the provider system, switch to Advanced mode and navigate to System Administration System Configuration Knowledge Management Content Management Repository Managers Security Manager CAF Security Manager , choose Edit and add the user you have created to the List of users with full access.
  More information: Configuring CAF Security and Repository Managers.
3. On the consumer system open CAF runtime and create new rules for the Document business object. Give the Administrator and the default user you have created full control.
Schedule the cleaning of temporary KM Documents.
More information: Cleaning Temporary Documents in KM .

Result

You can test your application in the Service Browser.

Example

After you have integrated a KM Document in your composite application you can create versions and lock and unlock the document.

More information: