Overview

The Collaboration API is a collection of Java-based interfaces and classes that support the implementation of a collaborative work environment based on the FileNet P8 platform and technology.

This document provides conceptual information about some of the most commonly-used objects, as well as code samples. For reference information on each interface and class, refer to the installed Javadoc files (open the <interface_name>.html file or open the package-summary.html file and navigate from there).

Required Java Version

The Collaboration API requires the Java 2 Standard Edition (J2SE) 1.4.x or higher development environment. Refer also to the FileNet P8 Platform 3.0.0x Hardware and Software Requirements document. You can find the document on FileNet's Customer Service & Support web site under Product Tech Info -> Products -> Business Process Manager (BPM) -> Product Documentation -> 3.0.0x Documentation -> FileNet P8 Platform 3.0.0x Hardware and Software Requirements. You will need a FileNet-issued login name and password to access the web site.

Required .jar Files

In addition to the Java archive (.jar) file for its own class implementation files, the Collaboration API requires several third-party .jar files during runtime. The required .jar files are installed by the Team Collaboration Manager installer. The supplied versions of these .jar files are required for the Collaboration API and you should not substitute other copies of .jar files with the same names. (For specific installation instructions for your environment, refer to the Installation Guide.) If you are writing a standalone Java application that uses the Collaboration API, the required .jar files must be in your classpath. A missing .jar file can lead to errors and "class not found" exceptions. The following table lists the required .jar files.

.jar File
Contains ...
bsoclb.jar The class implementation files for the Collaboration API.
bsoclbeng.jar The class implementation files for the Collaboration engine.
bsoclbmailet.jar Collaboration email processing, archiving, and address-handling implementation.
bsoutil.jar Implementation files for collaboration utility classes, interfaces, and exception classes.
CollaborationOperations.jar Contains the class implementation file for collaboration operations that may be performed by workflows.
javaapi.jar Class implementation files for the Content Java API.
eProcess.jar The Process Java API.
mail.jar The JavaMail API. (Note: This .jar file does not include protocol providers.)
xalan.jar

Xalan-Java 2.5.1 implements XSL Transformations (XSLT) and the XML Path Language (XPath). This .jar file must be present in the classpath with xml-apis.jar and xercesImpl.har.

xml-apis.jar

Xerces 2.5.0 XML parser. This .jar file contains all of the standard APIs implemented by the parser (DOM, SAX, and JAXP). This .jar file, along with xalan.jar and xercesImpl.jar, must be present in the classpath. Note: To troubleshoot performance or functional problems, position this file and the xercesImpl.jar file ahead of all other XML parsers in the classpath.

xercesImpl.jar

Xerces 2.5.0 XML parser. This .jar file contains all of the parser class files that implement one of the standard APIs supported by the parser. This .jar file, along with xalan.jar and xml-apis.jar, must be present in the classpath. Note: To troubleshoot performance or functional problems, position this and the xml-apis.jar file ahead of all other XML parsers in the classpath. Otherwise, they can appear anywhere in the classpath.

soap.jar SOAP protocol.
jce1_2_2.jar Java Cryptography Extension (JCE) 1.2.2 framework.
sunjce_provider.jar Sun provider package of the Java Cryptography Extension (JCE).
log4j-1.2.8.jar

LOG4J framework for Content Java API logging.

connector.jar Java connection functionality.
activation.jar JavaBeans Activation Framework standard extension.
mailapi.jar JavaMail API. (Note: This .jar file does not include protocol providers.)