Introduction

The Content Engine Web Service (CEWS) is an industry standards-conformant SOAP interface to the IBM® FileNet® P8 Content Engine. It allows applications to access most of the functionality available through the Content Engine Java and .NET APIs. Use the CEWS interface if:

Otherwise, you should use either the Content Engine Java API or the Content Engine .NET API for your application. These APIs offer much better ease of use and supportability than using the CEWS interface directly. Even if your application component is part of a framework in which the use of Web services is the model for communicating with external systems, it is not necessary (and not advisable) to write your application using the CEWS interface directly; you will achieve your goal of using Web services much more easily by using the .NET or Java API with the CEWS transport.

WSDL Versions

Beginning in the Content Engine 4.5 release, two versions (4.0 and 3.5) of the CEWS WSDL interface are supported. To take advantage of MTOM-based attachments and simplified content retrieval, new CEWS applications should be written using the 4.0 WSDL and existing CEWS 3.5 WSDL-based applications should be upgraded to use the 4.0 WSDL.

The 3.5 WSDL will still be supported in the near term to allow you to continue to use existing CEWS 3.5.x and 4.0.x applications that you do not want to upgrade (note that some CEWS 3.5.x applications using the 3.5 WSDL might still need to be ported in order to run in a 4.5 environment).

This documentation describes the version 4.0 CEWS WSDL interface. Documentation for the version 3.5 CEWS WSDL interface is only available as a zip file on the IBM Information Management support page on www.ibm.com. To download this zip file from the IBM support page, see Accessing IBM FileNet Documentation.

CEWS Overview

CEWS provides general-purpose SOAP operations (methods) and elements that expose all of the Content Engine objects and most of their properties and methods. Its methods have been designed with performance and scalability in mind, by virtue of:

CEWS complies with the following Web services specifications:

For an introduction to Web services, see the following web site: Understanding Web Services.

WSDL and Namespace Support

CEWS uses the following Web Services Description Language (WSDL) format XML files:

Port/binding pairs are defined in CEWS according to the supported mechanisms for content transfer and are bound to the following endpoint URLs through which the associated WSDL can be accessed at runtime. The Content Engine server determines the content transfer method based on the endpoint used:

The elements and types defined in the CEWS schema are assigned to the following namespaces:

Object Identifiers

The WithObjectIdentityType element provides the basis for identifying Content Engine objects, in which information describing an object (its class ID, object ID, and object store) are returned.

The Content Engine has two primary object types: independent and dependent:

Duplicate Object Suppression

During object retrieval of objects that have object-valued properties, it is possible to reach the same object more than once if a property filter forces a recursion. (For example, retrieving a folder and forcing deep recursion through the Parent and SubFolders properties.) This can lead to runaway recursion and excessive memory usage on the server. To prevent this, the server uses a mechanism to suppress recursion into duplicate objects. This duplicate object suppression mechanism overrides the true recursion level and operates as if the maximum recursion level has already been reached for the duplicate object, therefore terminating recursion at a duplicate object. When a duplicate object is detected, an object reference (represented by an ObjectReference element) is placed into the response instead of an object value (represented by an ObjectValue element) and the serializationDuplicate attribute of the object reference is set to true. Duplicate object suppression has the following effects on returned objects:

The scope of duplicate object detection encompasses each individual top-level component of a response (for example, an individual ObjectResponseType within a GetObjects response). Therefore, if an object appears beneath one top-level response element, and also appears beneath a different top-level response element, the second occurrence of the object is not treated as a duplicate.

Occasionally, an object value is returned for an object that occurs at a high recursion level while other copies of the same object occurring at a lower recursion level are suppressed. Because fewer properties will typically be returned for objects at higher recursion levels, the client might have a copy of the object that has a much smaller subset of properties than was desired. This can result in either additional network round trips to retrieve the missing properties, or errors if the client application does not realize that it is missing properties. When an object reference is returned instead of an object value, it might not be clear to the client application whether this is because of a normal property filter evaluation or duplicate object suppression.

Accessing Multiple Object Stores

A Content Engine object store server can provide access to multiple object stores, and multiple object store servers can provide access to each object store. Each object store server can host a single CEWS server, which can access any object store server in the P8 domain. CEWS clients can access any of the object stores through either of the object store servers. The following diagram shows a configuration with two object store servers and three object stores:

A diagram for configuration with two object store servers and three object stores