IBM Enterprise Records, Version 5.1.2    

Working with the RM Java API

The RM Java™ API provides networked and Java-based access to commonly-used objects and includes methods for performing record-related operations such as declaration, navigation, and disposal. In addition, the RM Java API provides an interface between custom applications and document repositories.

Using the RM Java API, you can perform operations such as relocating, copying, moving, superseding, and deleting records. To perform these operations, the RM Java API uses existing Content Java Compatibility Layer API classes, such as ObjectStore, Document, Folder, and CustomObject, to exhibit the default behavior of the Content Java Compatibility Layer API objects. For example, in the RM Java API, the RMFolder interface extends the Folder interface of the Content Java Compatibility Layer API and inherits the default behavior of this interface. Using the RMFolder interface, you can derive various container objects, such as classification schemes, record categories, and record folders.
Important: As part of the IBM® Enterprise Records 5.1.2 release, the Java API for Records Management (JARM) is being released. Use the JARM API in place of the existing RMAPI for new custom IBM Enterprise Records application development. Locate the JARM Javadocs at the following location: Java API for records management (JARM).

Required Java version

The RM Java™ API requires the Java 2 Standard Edition (J2SE) 1.5 or higher development environment. In addition, it uses various Java packages such as com.filenet.rm.api, com.filenet.rm.api.exception, and com.filenet.rm.api.util. The following table provides a description of these Java packages:

Java Package Description
com.filenet.rm.api Contains interfaces and classes used for record management operations such as copying, moving, filing, and declaring records.
com.filenet.rm.api.exception Contains exception classes used by the RM Java API.
com.filenet.rm.api.util Contains utility functions for the RM application, such as filtering the File Plan Object Store (FPOS) or Record Object Store (ROS) from an object store.

Required .jar files

The RM Java™ API requires various .jar (Java Archive) files during runtime. These .jar files contain the class implementation files. The supplied versions of these .jar files are required for the RM Java API and you should not substitute other .jar files with the same names. If you are writing a standalone Java application that uses the RM Java API, the required .jar files must be on your class path. A missing .jar file can lead to errors and Class Not Found exceptions. The following table lists the required .jar files.

.jar File Contains
rmapi.jar The class implementation files for the RM Java API.
javaapi.jar The class implementation files for the Content Java Compatibility Layer API.
xml-apis.jar
Note: This .jar file contains all standard APIs implemented by the parser (DOM, SAX, and Java API for XML Processing (JAXP)).
Note: To troubleshoot performance or functional problems, position this and the xercesImpl.jar file ahead of all other XML parsers in the classpath.
xercesImpl.jar

This .jar file contains all parser class files that implement one of the standard APIs supported by the parser. Both this .jar file and xml-apis.jar must be present in the classpath.

Note: To troubleshoot performance or functional problems, position this .jar file and the xml-apis.jar file ahead of all other XML parsers in the classpath. Otherwise, they can appear anywhere in the classpath.
jakarta-regexp-1.3.jar The class implementation files for displaying regular expressions used for pattern matching.
activation.jar The class implementation files for the JavaBeans Activation Framework standard extension.
log4j-1.2.13.jar The LOG4J framework for Content Java Compatibility Layer API logging.
mailapi.jar The JavaMail™ API. This .jar file does not include protocol providers.
rmsweep.jar The class implementation files for disposition schedules.
rmworkflow.jar The class implementation files for RM workflows.
rmapiresources.jar The class implementation files displaying error messages.
pe.jar,pe3pt.jar,peResources.jar

The class implementation files for the Process Java API.

Note: The peResources.jar file is required only for localized environment.
p8cjares.jar The localizable resource strings for Content Java Compatibility Layer API classes.
These JAR files are laid down by the installation program in the following directory: IER_install_path/EnterpriseRecords/API/RMAPI.

Topics covered in the RM Java API documentation

The RM Java™ API documentation provides information about commonly-used objects and methods, and includes code examples. You can also refer to the Javadoc files for more information about each interface and class. For this, you need to open the interfacename.html file. For example, you can open the ClassificationScheme.html file for more information about the ClassificationScheme class.

The RM Java API documentation includes information about the following topics:

Using RM Java API base objects

The RM Java™ API defines various interfaces, such as RMObject, RMObjectStore, RMFolder, and RMRecord, to leverage the existing functionality of the Content Java Compatibility Layer API.

For more information about RM Java API base objects, refer to Getting started.

Creating a file plan hierarchy

Using the RM Java™ API, you can create a file plan hierarchy according to the business processes of your organization. To create a file plan, the RM Java API provides various classes and interfaces such as RMObjectStore, RMObject, ClassificationScheme, RecordCategory, RecordFolder, Volume, RMProperty, RMType, and RMUtil. You can also use the RM Java API to browse a file plan and view its constituents.

For more information about a file plan, refer to Creating a file plan.

Managing records according to business processes

The RM Java™ API provides a framework for declaring one or more documents or multiple versions of a document as a single record. You can declare a record using classes and interfaces such as RMObjectStore, RMObject, RecordInfo, RMRecordContainer, RMAutoName, RMDriverManager, DocumentStore, RMProperty, and RMType.

For more information about records, refer to Managing records according to business processes.

Initiating a disposition schedule

The RM Java™ API provides the ability to define, allocate, and execute a disposition schedule. You can define disposal actions such as export, transfer, destroy, and interim transfer. To perform these actions, the RM Java API provides classes and interfaces such as RMObjectStore, RMObject, DisposableObject, RecordCategory, RecordFolder, Volume, RecordInfo, and RMUtil.

For more information about disposition schedules, refer to Initiating a disposition schedule.

Performing the search operation

Using the RM Java™ API, you can search objects across one or more object stores. For example, you can search and retrieve record categories, record folders, and records. To do so, you use RM Java API classes and interfaces such as RMObjectStore, RMSearch, RMStoredSearch, RMStoredSearches, RMUtil, and RMXSLUtil.

For more information about search, refer to Performing the search operation.

Performing bulk operations

Using the RM Java™ API, you can perform various bulk operations (such as close/open, inactivate/activate, and relocate) to update multiple objects in the same way and at the same time.

For more information, refer to Performing bulk operations.



Feedback

Last updated: November 2013
ierdg069.htm

© Copyright IBM Corporation 2013