White Paper
INSTALLING AND TROUBLESHOOTING
EMC DOCUMENTUM WEB PUBLISHER BOF JARS
Abstract
This white paper provides information about the installation and
updating of EMC® Documentum® Web Publisher BOF jars.
Information about troubleshooting issues is also provided in
this paper, along with details on the types of BOFs.
March 2011
Copyright © 2011 EMC Corporation. All Rights Reserved.
EMC believes the information in this publication is accurate of
its publication date. The information is subject to change
without notice.
The information in this publication is provided “as is”. EMC
Corporation makes no representations or warranties of any kind
with respect to the information in this publication, and
specifically disclaims implied warranties of merchantability or
fitness for a particular purpose.
Use, copying, and distribution of any EMC software described in
this publication requires an applicable software license.
For the most up-to-date listing of EMC product names, see EMC
Corporation Trademarks on EMC.com.
All other trademarks used herein are the property of their
respective owners.
Part Number h8204
Installing and Troubleshooting
EMC Documentum Web Publisher BOF Jars
2
Table of Contents
Executive summary.................................................................................................. 4
Audience ............................................................................................................................ 4
Introduction ............................................................................................................ 4
Types of BOF ........................................................................................................... 4
Type Based Objects (TBO) .................................................................................................. 4
Service Based Objects (SBO) .............................................................................................. 4
Aspect Type TBOs (Web Publisher-specific) ........................................................................ 5
Jar file packaging for Web Publisher ......................................................................... 5
Supporting Web Publisher BOF ................................................................................ 5
Installing BOF jars .............................................................................................................. 5
Retrieving BOF jars ............................................................................................................. 7
Troubleshooting ................................................................................................................. 7
DBor.properties .................................................................................................................. 7
Conclusion .............................................................................................................. 7
Installing and Troubleshooting
EMC Documentum Web Publisher BOF Jars
3
Executive summary
This white paper provides information about the EMC® Documentum® Business
Object Framework (BOF), specifically about Web Publisher BOF jars. This paper is a
best practices guide for technical support in BOF jar installation and update issues. It
can also serve as a preliminary guide for developers who want to learn more about
Web Publisher BOF jars.
Audience
This white paper is intended for support engineers of Web Publisher. It also serves as
a preliminary guide for WCM administrators and developers who want to install or
update Web Publisher BOF jars.
Introduction
The Documentum BOF provides an environment for efficient development of business
applications by abstracting content management functionality into the business
layer. It provides an object-oriented framework, which supports extensibility and
reusability of server-side business logic components. The interfaces are defined at a
high level for easy application development, with reusable and extensible business
objects providing the abstraction layer between applications and the Documentum
repository. Analysis of applications shows that most customers can reuse application
components when writing content-rich applications. Web Publisher functionalities
that are implemented as BOF classes are referred to as Web Publisher BOF jars.
This white paper includes the following sections:
Types of BOF
Jar file packaging for Web Publisher
Supporting Web Publisher BOF
Types of BOF
Type Based Objects (TBO)
TBOs are implemented as classes that extend basic persistent DFC types such as
DfDocument, DfSysObject, and so on, or WCM types like WcmConfig, WCMLocale, and
so on. They allow you to encapsulate business logic that is specific to a particular
Docbase object type or WCM object type.
Service Based Objects (SBO)
SBOs are not tied to a specific Documentum object type or Web Publisher object type.
They are generalized objects that provide a specific service that may operate on
different Documentum object types or other business objects, for example,
WCMLifeCycleService or WCMLocaleService.
Installing and Troubleshooting
EMC Documentum Web Publisher BOF Jars
4
Aspect Type TBOs (Web Publisher-specific)
Some Web Publisher 5.x TBOs in BOF1 do not have a WCM type associated to them,
for example, Content (type: dm_document). They cannot be used as a TBO in BOF2.
As a result, these TBOs are converted to Aspect in Documentum 6. The interfaces of
these Aspects (5.x TBOs) are the same as before. The Aspect Attribute is not used by
WCM modules in Documentum 6.5, but they are supported. Customers can customize
WCM Aspect modules to use Aspect Attributes.
Jar file packaging for Web Publisher
The list of Web Publisher jars and their usage is as follows:
wcm-api.jar–Contains all service interfaces
wcm-impl.jar–Contains all service implementations
wcm-utils.jar–Contains all utilities and supporting files for WCM services and Web
Publisher
wcm-wf-impl.jar–Contains workflow supporting files for
com.documentum.wcm.services.inbox.IWcmInbox and
com.documentum.wcm.services.IWcmStartWorkflow
Supporting Web Publisher BOF
Installing BOF jars
To install BOF jars, proceed as follows:
1. Stop the application server, IDS/IDSx source, and Java method server.
2. Back up the BOF cache. To locate the BOF cache, refer to the value “dfc.data.dir”
in the dfc.properties file. If nothing is specified, then the BOF cache will usually be
located in <appserver>\bin\documentum\cache. This location may vary slightly
depending on the application. Back up the entire cache folder and clear the
contents of the cache.
Installing and Troubleshooting
EMC Documentum Web Publisher BOF Jars
5
Table 1. Application servers and corresponding BOF folder location
Application server name
BOF folder location
Web Logic
<<BEA domains>>\<<domain Name>>\documentum\cache
Tomcat
<<Tomcat root>>bin\documentum\cache
WebSphere
<<WAS root>>/profiles/<<Profile Name>>/documentum/cache
3. Ensure that java.exe is located on your path.
4. Navigate to the location of the BOF folder and note the contents of that folder (only
jar files) and of the codes in the following table.
Table 2. Jar files and codes
JAR files
wcm-impl.jar
wcm-api.jar
wcm-utils.jar
wcm-wf-impl.jar
wcm-svr.jar
Codes
impl
api
utils
wf-impl
svr
5. Open the command prompt and navigate to the BOF folder location. Execute the
following command:
java –cp .;” <appserver>\wp\web-inf\classes; <appserver>\wp\web-inf\lib\dfc.jar;”
com.documentum.wp.util.UpdateBOFObj <Super user name> <super user password>
<docbase name> <code of the jar present>
In the UNIX version, execute the following command:
java –cp .:” <appserver>\wp\web-inf\classes: <appserver>\wp\web-inf\lib\dfc.jar:”
com.documentum.wp.util.UpdateBOFObj <Super user name> <super user password>
<docbase name> <code of the jar present>
For example:
java –cp .;C:\Apps\apache-tomcat-6.0.18\webapps\wp\webinf\classes;C:\Apps\apache-tomcat-6.0.18\webapps\wp\web-inf\lib\dfc.jar
com.documentum.wp.util.UpdateBOFObj dmadmin secret-pwd MyDocbase impl
6. If three jars are present in the BOF directory, then run the above command three
times, each time with a different code.
7. Delete the BOF cache directory from the application server machine and Content
Server machine.
Installing and Troubleshooting
EMC Documentum Web Publisher BOF Jars
6
8. Restart the application server, IDS/IDSx source, and Java method server to complete
the deployment.
Note: If there are multiple repositories, then you must run the command against all
the repositories, especially the global repository.
Retrieving BOF jars
To retrieve BOF jars from the repository, proceed as follows:
1. Exceute the following DQL query:
select r_object_id,object_name,r_modify_date from dmc_jar where
object_name=’<< Name of the Jar>> order by r_modify_date DESC.
2. Use the first row’s r_object_id and retrieve the jar file using the IAPI command
Getfile,c,<<r_object_id>>,<<absolute path of jar file name>> . An example is getfile,c,
090278cd80151a84,C:\temp\wcm-utils.jar.
Troubleshooting
If the Java BOF update program fails, enable DFC traces and execute the following
program. The –verbose flag is enabled using the following command:
java –verbose –cp .;” <appserver>\wp\web-inf\classes; <appserver>\wp\webinf\lib\dfc.jar;” com.documentum.wp.util.UpdateBOFObj <Super user name> <super
user password> <docbase name> <code of the jar present>
Collect the DFC traces and console logs from the command prompt where this
command is executed.
DBor.properties
DBor.properties is used to load BOF classes in Documentum 5.3. DBor.properties is
found in the <<wp installation>>\WEB-INF\classes folder. The format for specifying BOF
entries is as follows: “[object_type]=type,[TBO class name],[version]”. In Web
Publisher 6.5, if the global registry configuration is not present in the dfc.properties
file, BOF classes are loaded from the local classpath, that is, WEB-inf/classes and
WEB-INF\lib.
Conclusion
The basics of Web Publisher BOF jars and their installation are described in this
paper. Technical support personnel and customers can better understand Web
Publisher BOF jars and their installation and update procedures.
Installing and Troubleshooting
EMC Documentum Web Publisher BOF Jars
7