Package | Description |
---|---|
com.filenet.rm.bds | This package contains the majority of interfaces and classes that makeup the public API of the RM Bulk Declaration Service. |
com.filenet.rm.bds.exception | This package contains the classes that implement the exception construct that is generated by the Bulk Declaration Service API. |
com.filenet.rm.bds.impl | This package contains the implementation classes for the public interfaces of the Bulk Desclaration Service API. |
The IBM® FileNet® P8 Records Manager Bulk Declaration Service provides the following capabilities:
Bulk declaration of new physical records
Bulk declaration of new electronic records for existing Content Engine documents
Bulk creation of new Content Engine documents and bulk declaration of new records for these documents
Bulk creation of new Content Engine documents
The Bulk Declaration Service uses a batch operation to enable bulk declaration and creation. Perform the following steps to use this operation:
Create a Map
object to define the connection context under which the Bulk Declaration
Service is to operate. For more information about this Map
object, see Creating the connection
context map.
Instantiate a new BulkDeclarationService
object by passing this context map as a parameter to the
getBulkDeclarationService(java.util.Map)
method of the BulkDeclarationFactory
class.
Reconfigure this BulkDeclarationService object as needed. Call the getConfigurationInfo method to obtain the configuration collection for this object. Refer to the ConfigItemType class for descriptions of the members of this collection.
Call the startBatch method on the BulkDeclarationService object to start the batch operation.
Add one or more record declarations and document creation requests to the batch operation by calling the following methods on the BulkDeclarationService object:
To connect to a Content Engine server, the Bulk Declaration Service can use the transport architecture of either the Content Engine Web Service or the Content Engine Java API. The transport used is determined by the setting of the BDSConstants.CONTEXT_TRANSPORT_TYPE key in the connection context map as follows:
Set the CONTEXT_TRANSPORT_TYPE key to BDSConstants.TRANSPORT_TYPE_BDP40_WSI to use the Content Engine Web Service transport.
Set the CONTEXT_TRANSPORT_TYPE key to BDSConstants.TRANSPORT_TYPE_BDP40_JACE to use the Content Engine Java API transport.
To use a Content Engine Java API transport architecture, jace.jar must be included in the classpath and must be configured according to the target application server. For more information about the JACE transport, see “Getting Started” in the Content Engine Java and .NET Developer’s Guide.
The context map differs based on the transport your application uses.
The following table identifies the map keys that must be included in the context map to use the Content Web Service transport.
Map Key | Description | Example Value |
---|---|---|
BDSConstants.CONTEXT_PROTOCOL |
Wire protocol | "http" |
BDSConstants.CONTEXT_SERVER |
Name of the CE server | "CEserver" |
BDSConstants.CONTEXT_PORT |
IP port number | "9080" |
BDSConstants.CONTEXT_SERVICE | WSI Service name | "FNCEWS40Service" |
BDSConstants.CONTEXT_ENDPOINT |
WSI Endpoint name | "FNCEWS40MTOM" |
BDSConstants.CONTEXT_BINDING | WSI Binding name | "FNCEWS40MtomPort" |
BDSConstants.CONTEXT_USERNAME | Clear text username | |
BDSConstants.CONTEXT_PASSWORD | Clear text password |
The following table identifies the map keys that must be included in the context map to use the Content Engine Java API transport.
Map Key | Description | Example Value |
---|---|---|
BDSConstants.CONTEXT_URI | Content Engine jace.jar URI | "iiop://CEserver:2809/FileNet/Engine" |
BDSConstants.CONTEXT_USERNAME | Clear text username | |
BDSConstants.CONTEXT_PASSWORD | Clear text password |
The following sample context map defines a connection that uses the Content Engine Java API transport:
Map contextMap = new HashMap();
contextMap.put(BDSConstants.CONTEXT_TRANSPORT_TYPE, BDSConstants.TRANSPORT_TYPE_BDP40_JACE);
contextMap.put(BDSConstants.CONTEXT_URI, "iiop://CEserver:2809/FileNet/Engine");
contextMap.put(BDSConstants.CONTEXT_USERNAME, "username");
contextMap.put(BDSConstants.CONTEXT_PASSWORD, "password");
BulkDeclarationService bds = BulkDeclarationFactory.getBulkDeclarationService(contextMap);
NOTE The CONTEXT_USERNAME and CONTEXT_PASSWORD are not needed if a JAAS session already exists on the thread.