EMC Documentum System · 2020-06-22 · EMC® Documentum® System Version6.5SP3 UpgradeandMigrationGuide EMCCorporation CorporateHeadquarters: Hopkinton,MA01748-9103 1-508-435-1000

EMC® Documentum®

SystemVersion 6.5 SP3

Upgrade and Migration Guide

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-91031-508-435-1000www.EMC.com

EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kindwith respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitnessfor a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires anapplicable software license.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarksused herein are the property of their respective owners.© Copyright 2010 EMC Corporation. All rights reserved.

Table of Contents

Preface ................................................................................................................................. 9

Chapter 1 Upgrade and Migration Overview ................................................................ 11Upgrade and migration..................................................................................... 11Understanding migration.................................................................................. 12Order of new product installation...................................................................... 12Order of system updates ................................................................................... 13System upgrade strategies................................................................................. 14Changing the database OS and version .............................................................. 17Changing the content store location ................................................................... 17Migrating XML content to the XML store ........................................................... 17

Chapter 2 Planning System Size and Enhancing Performance .................................... 19Planning the system size ................................................................................... 19Planning for performance.................................................................................. 20Common problems in Server performance ......................................................... 21Common problems in web application performance ........................................... 22

Chapter 3 Planning the System Migration ................................................................... 23Changes in supported environments.................................................................. 23Version 6.5 and later changes that impact Content Server upgrade ormigration ......................................................................................................... 24Enabling database partitioning while configuring Content Server .................... 24Upgrading multiple repositories to the same version ...................................... 25Migrating objects to lightweight sysobjects (LWSOs)....................................... 25Changed behavior for attribute length ........................................................... 25Maximum accepted string lengths in Documentum query language(DQL) statements ......................................................................................... 26Required configuration for machine-only application access controltokens.......................................................................................................... 26Audit trail entries for dm_startedworkitem enhanced ..................................... 26DFC does not support linked store storage areas ........................................... 26External storage............................................................................................ 27DFC does not support optical storage devices................................................. 27DFC Full format specifications no longer accepted .......................................... 27SYNC_REPLICA_RECORDS administration method ...................................... 27LDIF file changes.......................................................................................... 27Obsolete dmcl.ini keys .................................................................................. 27New dfc.properties key to turn off trusted login ............................................. 27DQL changes................................................................................................ 28POSITION keyword no longer supported .................................................. 28CHANGE...OBJECT statement .................................................................. 28DQL date literals enhancement.................................................................. 28

EMC Documentum System Version 6.5 SP3 Upgrade and Migration Guide 3

Table of Contents

Behavior change after failed save or checkin................................................... 28Trace method migration ................................................................................ 29New server.ini key ....................................................................................... 29enable_workitem_mgmt obsolete .................................................................. 29

Mapping your current configuration.................................................................. 29Designing your version 6.5 configuration ........................................................... 32Addressing hardware concerns ..................................................................... 32Upgrading third-party software..................................................................... 33Planning for global registries ......................................................................... 33Mapping your version 6.5 configuration......................................................... 34

Planning upgrade and migration to version 6.5................................................... 34Setting up a test environment ........................................................................ 34Client-first migration .................................................................................... 34

Planning an upgrade when multiple repositories work as a Federation ................ 35Guidelines to upgrade a distributed configuration .......................................... 36

Chapter 4 Interoperability and Compatibility ............................................................... 39Mixed version compatibility .............................................................................. 39Guidelines for determining mixed version compatibilities ................................... 40Forward and Backward Compatibility Notes .................................................. 41

Upgrade and Compatibility matrices ................................................................. 42Cross-product dependencies ......................................................................... 86Webtop, Digital Asset Manager ..................................................................... 86

Chapter 5 Migrating Content Server ............................................................................ 87Rebuilding or upgrading fulltext indexes ........................................................... 88Configuring login tickets for backward compatibility.......................................... 88Using DQL to migrate content to an XML Store .................................................. 89Migrating custom Content Server methods......................................................... 89Migrating DocApps and BOF2 modules ............................................................. 89

Chapter 6 Migrating DFC Customizations .................................................................... 91Java class changes............................................................................................. 91Configuring DFC for native IPv4 operations....................................................... 91Migrating customizations to Business Objects..................................................... 92Migrating DMCL API calls to DFC API calls....................................................... 92Search service................................................................................................... 92Full format specications no longer accepted ...................................................... 93Character string handling improved .................................................................. 93Aspects, a new BOF module type for developers ................................................ 93JMX management of DfPreferences and dfc.properties........................................ 93DFC deployment .............................................................................................. 94Conguration for application access control tokens ............................................. 94Setting the maximum number of results per source............................................. 94

Chapter 7 Migrating WDK and Webtop Applications ................................................... 95Overview ......................................................................................................... 95Updating and migrating email messages............................................................ 96Java class changes............................................................................................. 97

4 EMC Documentum System Version 6.5 SP3 Upgrade and Migration Guide

Table of Contents

Application framework changes ........................................................................ 97Configuring new accessibility features and timeout warnings.......................... 97Migrating scoped configurations to presets .................................................... 99Deployment model changed........................................................................ 100Migrating configuration extensions to modifications ..................................... 100Migrating JSP menus to XML menus............................................................ 101

Application-wide changes............................................................................... 104Placing a custom component in a modal pop-up dialog................................. 104Defining the available pop-up windows ................................................... 104Invoking a modal component in a pop-up window................................... 105Refreshing the parent window ................................................................ 106Creating an action postprocessor for actions that sometimesrequire modal windows .......................................................................... 107Using window.location.replace within a modal component....................... 108

Enabling and configuring IRM support ........................................................ 108Enabling and configuring DCS support........................................................ 108Email conversion to EMCMF format ............................................................ 109Configuring inline refresh ........................................................................... 110Lightweight sysobject support ..................................................................... 111Using strong encryption.............................................................................. 112Enabling read notifications.......................................................................... 113Setting roles precedence.............................................................................. 113Right-click context menus ........................................................................... 114Migrating datagrid customizations .............................................................. 114Supporting row selection ........................................................................ 115Migrating to resizeable columns .............................................................. 117Adding fixed column headers ................................................................. 117Adding right-click context menus ............................................................ 118

Toolbar hidden by default ........................................................................... 119Keyboard shortcuts (hotkeys) ...................................................................... 119Adding a shortcut or modifying existing shortcuts.................................... 120Specifying a shortcuts mapping properties file ......................................... 120Adding a shortcut definition in an XML file.............................................. 121Creating or modifying a shortcuts map .................................................... 122Adding your custom shortcut to the component ....................................... 124Modifying a custom control to support shortcuts ...................................... 124

Tab order configuration............................................................................... 125Supporting auto completion ........................................................................ 126Configuring a custom control that can support autocompletion ................. 127

Adding a "Starts with” filter ........................................................................ 128Displaying invalid actions ........................................................................... 129Drag and drop improvements ..................................................................... 129Preferences changes.................................................................................... 129

Content transfer changes................................................................................. 130UCF performance improvements in Webtop................................................. 130Enabling deep export .................................................................................. 131Turning off UCF preload ............................................................................. 131Enabling PDF byte-serving.......................................................................... 131Specifying the content transfer mechanism for a group or role ....................... 132Enabling scanning of Microsoft formats for linked objects ............................. 132Allowing user selection of viewing application for renditions........................ 134Configuring ACS and BOCS settings............................................................ 134Content transfer applet removed ................................................................. 135

Style changes.................................................................................................. 135Streamline deprecated ................................................................................ 135Specific themes deprecated.......................................................................... 135

Feature changes.............................................................................................. 136


Table of Contents

Deprecated components.............................................................................. 136Supporting conditional value assistance in advanced search .......................... 137Assigning relationships............................................................................... 138Lifecycle enhancements .............................................................................. 138

Chapter 8 DFC, BOF and WDK Application Migration to DFS .................................... 139

Appendix A Migrating DMCL APIs to DFC .................................................................... 141Overview ....................................................................................................... 141Methods with no corresponding DFC method .................................................. 141Methods with corresponding DFC methods ..................................................... 142

Appendix B Object Type and Property Changes for version 6.5 SPx ............................ 151New object types ............................................................................................ 151Changed object types ...................................................................................... 153Deprecated or obsolete properties.................................................................... 160Properties added conditionally ........................................................................ 160Deprecated or obsolete object types ................................................................. 162Changed properties ........................................................................................ 162

Appendix C Deployment Settings in WDK-based Application Deployment .................. 163

Appendix D Changes to Webtop Cascading Stylesheets .............................................. 167

Appendix E dfc.properties ............................................................................................ 169Overview ....................................................................................................... 169Changes to existing key names ........................................................................ 169dmcl.ini key migration to dfc.properties........................................................... 172Obsolete dmcl.ini and session configuration options ......................................... 173Obsolete dfc.properties keys............................................................................ 175


Table of Contents

List of Figures

Figure 1. System installation order, new Documentum system .............................................. 13Figure 2. System update order, existing Documentum system ............................................... 14Figure 3. System upgrade scenarios ..................................................................................... 16Figure 4. Conditional value assistance in search.................................................................. 137


Table of Contents

List of Tables

Table 1. Upgrade and migration of product components ..................................................... 11Table 2. Third-party product versions not supported in this release...................................... 23Table 3. Content Server and database server host worksheet ................................................ 30Table 4. Application server host worksheet ......................................................................... 31Table 5. Index server host worksheet .................................................................................. 31Table 6. Client machine worksheet ..................................................................................... 31Table 7. Customized components worksheet....................................................................... 32Table 8. Federation Configurations..................................................................................... 35Table 9. Mixed Version Configuration ................................................................................ 41Table 10. Upgrade matrix for Content Server and related components ................................... 43Table 11. Compatibility matrix for client components against Content Server and

dependent products.......................................................................................... 48Table 12. IRM Services for Documentum Compatibility against Content Server ...................... 85Table 13. Documentum Compliance Manager Compatibility against Content Server............... 86Table 14. Steps to migrate the Content Server from version 6 to version 6.5............................. 87Table 15. Menu configuration elements .............................................................................. 102Table 16. Interaction between global versus local row selection settings ............................... 116Table 17. Hotkeys configuration elements .......................................................................... 121Table 18. Keys that can be used in a shortcut combination ................................................... 122Table 19. Deprecated components...................................................................................... 136Table 20. Developing custom applications .......................................................................... 139Table 21. DMCL API methods and corresponding DFC methods ......................................... 142Table 22. New Object Types............................................................................................... 151Table 23. Changed Object Types ........................................................................................ 153Table 24. Deprecated and obsolete properties ..................................................................... 160Table 25. Deprecated and obsolete computed properties ..................................................... 160Table 26. Properties added conditionally ............................................................................ 161Table 27. Deprecated or Obsolete Object Types ................................................................... 162Table 28. Mandatory configuration before deployment ....................................................... 163Table 29. Optional configuration before deployment ........................................................... 163Table 30. Optional configuration after deployment ............................................................. 164Table 31. Name changes for existing dfc.properties for version 6.5 SPx and dfc.new

properties ...................................................................................................... 169Table 32. dfc.properties keys migrated from dmcl.ini file..................................................... 172Table 33. Obsolete session configuration options................................................................. 174Table 34. Obsolete dfc.properties keys................................................................................ 175


Preface

This guide focuses on the steps necessary to upgrade or move an existing EMC Documentum 5.3 or 6implementation to the new EMC Documentum 6.5 or later platform. This guide does not focus onnew features, except when a new feature changes or replaces existing behavior in custom applications.

Intended AudienceThis guide is for EMC Documentum administrators who are tasked with upgrading or moving anexisting EMC Documentum 5.3 or 6 implementation into the EMC Documentum 6.5 platform anddevelopers who have created custom applications that need to move from EMC Documentum 5.3 or 6to the EMC Documentum 6.5 platform.

Document scopeThis guide shows you how to upgrade a Documentum system and migrate your customizations tothe upgraded Content Server. To assist you in the upgrade process, refer to Content Server InstallationGuide for more detailed planning information.

For migration of your customizations, this guide takes a version 5.3 or 6 implementation andprovides appropriate instructions to transition to 6.5. You can take advantage of some but not allof the new features of version 6.5. This guide also shows you how to disable new behaviors whereyou do not want them and activate some features that have been deprecated or "turned off” bydefault for version 6.5. For information on how to implement new features in your custom clientapplication, refer to the developer documentation for the product, for example, theWeb DevelopmentKit Development Guide for WDK.

The safe harbor releases for migration to version 6.5 are versions 6 and 5.3 SP6. If you are upgradingfrom a version earlier than 5.3, you must upgrade first to version 5.3, then to version 6.5.

Additional documentationThis guide provides overview and planning information. For details on specific procedures seethese guides:• Content Server Installation Guide

• Content Server Administration Guide


Preface

• XML Store Migration Guide

• Documentum Foundation Classes Development Guide

• Web Development Kit and Webtop Deployment Guide

• Web Development Kit Development Guide

• Webtop Email Migration Guide

• Documentum Foundation Services Development Guide

• Documentum Foundation Services 6.5 SP3 Deployment Guide

Revision HistoryThe following changes have been made to this document.

Revision History

Revision Date Description

March 2010 Initial publication

May 2010 Updated Compatibility data for IRM Services for DCTM , DA, andDRS products.

August 2010 Updated the "System upgrade strategies” chapter.


Chapter 1Upgrade and Migration Overview

This chapter covers in broad terms what is meant by upgrade and migration, what this guide covers,and where you might look for additional information.

These topics are included:• Upgrade and migration, page 11

• Understanding migration, page 12

• Order of new product installation, page 12

• System upgrade strategies, page 14

• Order of system updates, page 13

• Changing the database OS and version, page 17

• Changing the content store location, page 17

• Migrating XML content to the XML store, page 17

Upgrade and migrationUpgrade is available for certain Documentum applications such as Content Server. Upgrade changesan existing installation to a new version. For information on upgrading Content Server, refer to EMCDocumentum Content Server Installation Guide.You can install a new version 6.5 Content Server andmigrate your existing repository to the new Server. For information on migrating your repository,refer to Chapter 5, Migrating Content Server

In migration, you move your customizations to a new instance. If you install a new Content Server,you need to migrate existing Server customizations such as DocApps or DAR files, and businessobjects. Some applications such as Webtop or the WDK framework require migration rather thanupgrade. Table 1, page 11 shows the components that need migration or upgrade.

Table 1. Upgrade and migration of product components

Component Migrate Upgrade

Content Server (5.3 or later) X X

Custom DocApp (5.3 or later) X

SBOs X


Upgrade and Migration Overview

Component Migrate Upgrade

TBOs X

Java methods X X

Custom WDK/Webtop apps X

Note: DocApps, SBOs and TBOs (BOF2 version), and Java methods bundled as SBOs will continue towork in an upgraded Content Server. To edit them, you must create a project. Refer to the "ManagingModules” chapter of Documentum Composer User Guide.

Check the installation or deployment guide for each application that you are upgrading to findinstructions for upgrading or migrating applications to the new version. For information onmigrating WDK-based customization, refer to Chapter 7, Migrating WDK and Webtop Applications.

Before upgrade and migration, check the interoperability of all products and platforms in the system.Refer to Chapter 4, Interoperability and Compatibility.

Understanding migrationMigrating from version 5.3 or 6 to version 6.5 is a straightforward process. Your task is to clearlydocument your current configuration, plan your version 6.5 configuration, then upgrade theindividual system components in a sequence that will minimize impact on your users.

Migration can be separated into two basic tasks:• Install and configure version 6.5 software.

• Move configurations and customizations to the new servers.— Make necessary changes to enable any features you want to keep.

— Make necessary changes to disable any new features you do not want.

— Make necessary changes to enable any new features for existing custom components.

Most of the new features of version 6.5 are enabled by default. For those feature that are not enabledby default, this guide explains the steps for enabling the new feature.

Order of new product installationFigure 1, page 13 shows the order in which new Documentum system installations should be installedand deployed. The "server" in this diagram is the host for the RDBMS, Content Server, or Index Server.



Figure 1. System installation order, new Documentum system

Order of system updatesUpgrades to existing Documentum system installations may require uninstallation of some productsthat you are upgrading. Check the installation guide for recommendations. WDK-based clientsversion 6 such as Webtop or Web Publisher do not have an installer and thus cannot be upgraded.For those clients, you must migrate your existing customizations to a new WDK or Webtop runtimedeployment.

For upgrades that require uninstallation, perform the uninstall procedure in the reverse of the ordershown for new installations. For example, if you need to upgrade the LDAP server OS, upgrade theWebtop application server and its OS, and then migrate your customizations to the new Webtop 6.5,proceeding in the following order:1. Uninstall WDK 5.x. (Skip this step if you are migrating from 6.0 to 6.5).

2. Uninstall the WDK application server.

3. Update the LDAP OS.

4. Update the application server OS.

5. Update the application server software.

6. Deploy Webtop 6.5 on the new application server instance.

7. Migrate your WDK-based customizations to the Webtop 6.5 instance.

Figure 2, page 14 shows the order in which system components should be updated. The "server" inthis diagram is the host for the RDBMS, Content Server, or Index Server.



Figure 2. System update order, existing Documentum system

Caution: For Content Server, host OS, or RDBMS upgrades, make sure the product version issupported by the Content Server version you are installing. For application server OS or serverupgrades, make sure the product version is supported by the WDK-based application you areinstalling. This information is in the product release notes.

Chapter 4, Interoperability and Compatibility provides information on version compatibilitiesbetween interoperating Documentum products. When there are version compatibility restrictionsbetween interoperating products, upgrading one product requires upgrading the interoperatingproduct(s) to the same exact version or major version family. In most cases, version compatibilityrestrictions result from artifacts that a client product installs into the repository that leverage newfunctionality in Content Server. In these cases, upgrading the Content Server before the clientapplication is especially important.

System upgrade strategiesA typical Documentum system upgrade involves development, test, and production phases. Thedevelopment phase emphasizes migration of customizations from old product versions to newproduct versions, and functional testing of those customizations. The development phase onlyrequires deployment of the set of products required for functional testing of the customizations.

The test phase emphasizes setting up and testing of the full set of products that emulates theproduction system. The suite of EMC Documentum products and versions comprising the test systemshould match the suite of EMC Documentum products and versions targeted for the productionsystem upgrade. However, the test system can be deployed in a different environment (third-partyproducts, physical or virtual hosts) from the production system.

To move from the test to the production environment follow the in-place upgrade process.

For the in-place upgrade, you shutdown the production system and perform an upgrade using thesame set of physical or virtual hosts comprising the production system. For the in-place upgrade,you should use the test environment as a practice environment for performing the productionsystem upgrade.

Note: The Content Server/database component (the repository) is the only part of the system forwhich there is an upgrade script. All other system product component require a fresh installation.



The upgrade strategy provided in this section addresses upgrading all products in the system to thesame version number, resulting in a homogenous system. You can also upgrade only the ContentServer/database component (the repository) or the client component, resulting in a heterogeneoussystem. Chapter 4, Interoperability and Compatibility provides additional details on mixed versioncompatibilities.

Figure 3, page 16 shows the high-level decision points involved moving from a test system to aproduction system. Functional testing of new customizations and manual migration of existingcustomizations into new client version is part of the develop phase.

If upgrading the repository, you need to create a copy of the production repository (see ContentServer Installation Guide) in your test system upon which you can run the upgrade. If you want tochange the database operating system, you can using the utilities available through the third-partydatabase to export the database and import it into a new database instance on the different operatingsystem. After running the Content Server configuration program to re-establish the connectionbetween the existing Content Server instance and new database instance, run the Content Server toupgrade the entire repository.

If you are performing a fresh install, instead of an upgrade, you need to migrate your data files to newContent Server and database instances. There are several known third-party utilities for performingthis data migration (Crown Partners, Bluefish, FME).

An EMC Documentum system requires a global registry repository that matches the version family ofthe system clients. After installing or upgrading the test system repository, install a global registryrepository matching the version of the client applications and install the client software. If your clientsoftware versions are to remain at the same version as your production system, you can copy thecustomized files from your production system directly over to the same version client instanceon the test system. If the client version software is different, you need to manually migrate yourcustomizations over to the new client files.

Upon completing the migration of customizations to the test system, ensure your system is runningproperly by conducting your system tests. You are ready to repeat your upgrade process on theproduction once all your system tests pass. Generally, you will need to take your production systemoff-line for a weekend while performing the in–place upgrade.

Note: You can use virtual machine hosts for the entire system or system components. Using virtualmachines, you can swap out pre-upgraded system images on the same physical host to minimizethe downtime of an in-place upgrade.

The production system contains new content and full-text indexes generated since the repository wascopied or you migrated your data to the new repository.



Figure 3. System upgrade scenarios



Changing the database OS and versionWhen migrating your database to a new OS (host) and database version, complete the migration first,before upgrading Content Server. Upon completion of the database migration, run the Content Serverconfiguration program to re-establish the repository with the new database instance. Then upgradethe Content Server to upgrade the entire repository.

Refer to the database vendor documentation for information on migrating repository database filesto a new database instance. The Content Server configuration program connects Content Server tothe new database host unless the database connection string, database owner name, or passwordhas changed.

Changing the content store locationYou can move a content store to a new location. Refer to Content Server Administration Guide forinformation on moving file storage areas to a new location. The database location cannot be changed.

Migrating XML content to the XML storeFor information on migrating XML content to the XML store in Content Server, refer to XML StoreMigration Guide, which is available with other Content Server documentation.

Note: Prior to migrating XML content to an XML store, Content Server must be upgraded andmigrated to version 6.5.




Chapter 2Planning System Size and EnhancingPerformance

Upgrading a system presents an opportunity to change to new host environments. The followingtopics will help you plan your system size and improve performance:• Planning the system size, page 19

• Planning for performance, page 20

• Common problems in Server performance, page 21

• Common problems in Server performance, page 21

Planning the system sizeUse the system sizing spreadsheet available on Powerlink to assist you in planning your system. Onthe Powerlink.emc.com Supportmenu, click Technical Documentation and Advisories > Software DDocumentation > Documentum System > System Sizing.

The system sizing spreadsheet takes into account your estimated first-year and subsequent yearsinput of common types of documents (Word, PPT, PDF, HTML, XML, images, MPEG), number oflight and heavy users, and number of custom types. These figures are modified by WDK and BPMconfigurations. The output is the estimated number of CPUs and memory required for ContentServer, Index agent and server, WDK application server, and RDBMS server. Additional calculationsare performed for a document transformation server and BPS server if selected.

Hardware and network planning are essential for system scalability. For example, a load rate of125,000 images per hour during an 8-hour day could lead to a billion objects in less than 5 years. Ina regulated environment, those object may need to be online. The following considerations arerecommended from a billion-object benchmark study with 1000 concurrent users:• Set query resource limits in production. If a query uses large table scans, then its response timewill be in terms of hours rather than minutes given the size of the tables.

• Pre-test every application query on a reasonably-sized database prior to production.

• Eliminate poorly formed queries. Poorly formed queries in a small application might significantlydegrade when mixed with a larger repository.

• The full-text index server should allocate three times more storage to the full-text index than tothe content filestores.


http://powerlink.emc.com

Planning System Size and Enhancing Performance

To determine the system load expectations

1. Determine number and locations of functional users, including end users, administrators, anddevelopers.

2. Determine average and peak level data traffic (frequency and size of content transfers) for users.

3. Determine rate of ingestion of new content and magnitude of content to be migrated.

4. Determine indexing requirements for new and migrated content.

Planning for performanceThere are many factors that affect performance of a Documentum system. These factors include:• Number of users

• Frequency and duration of user sessions

• Size of files transferred by users

• Network capacity

• Storage and RAM capacity on hosts for RDBMS, Content Server, Index, application server or other

These factors are used by the System Sizing spreadsheet to help you calculate your size needs. Onthe Powerlink site Support menu, click Technical Documentation and Advisories > Software DDocumentation > Documentum System > System Sizing.

In Documentum 5 systems, DMCL tracing was used to analyze performance. In Documentum 6, youcreate a DFC trace. There are 34 tracing parameters in dfc.properties. Logging and tracing is fullydescribed in the Content Server Administration Guide. Some sample scripts to convert a trace file toMicrosoft Excel and to analyze repetitive calls are available on the EMC Developer Network.

You can monitor application server memory usage using graphical display tools for Java garbagecollection statistics such as Samurai or the IBM Diagnostic Tool for Garbage Collector. Monitor thefrequency of full garbage collection to determine whether the JVM heap size needs to be adjusted.You can generate a Java heap dump for out of memory exceptions and analyze them with the SunHeap Analyzer Tool (HAT), the IBM Heap Dump Analyzer, or the Your Kit Java Profiler. Classes thatconsume memory to check in a heap dump are com.documentum.web.failover.AttributeWrapper,FormHistory, and NavigationObservable.


http://powerlink.emc.com

http://developer.emc.com


Common problems in Server performanceThe most common problems in Content Server performance include the following:• Application design and customization— Chatty or redundant application code, the most common cause of failure (40% in 1995 IEEEstudy)

— Complex object models

— Poor memory and cache management

• Network— High latency due to physical or logical limitations

— Overburdened shared network

• Undersized Server resources (inadequate memory and CPU size)

• Unmanaged or underused RDBMS resources— RDBMS not regularly monitored and tuned

— Performance and caching features not used

• Unrealistic expectations (did not use realistic benchmarks)

A highly available infrastructure must be carefully designed to fit your business requirements.There is no single solution that fits all.

The following solutions are available to help with these problems.

High availability Documentum Server clusters — Server clusters (also called Server sets) can beactive-active or active-passive. In an active-active cluster, there are two active load-balanced webapplication servers, two active sets consisting of a Content Server and connection broker,, one activeRDBMS with clustered standby server, one primary database with one synchronized standby, andone primary content store with one synchronize standby. In an active-passive cluster, everythingis the same except that there is only one active Server plus connection broker set, with anotherset as standby.

These cluster configurations provide partial high availability coverage with increased scalability.The clusters can be managed with Documentum Administrator.

Redundant connection brokers — Connection brokers (formerly known as docbrokers) can beconfigured to automatically reroute users to Content Servers that are online. Connection brokers canload balance user connections across multiple Content Servers using identical proximity values forconnection brokers. Refer to Content Server Administration Guide .

Replication — Replication can be configured either as read/write or read-only.

Disaster recovery — Disaster recovery is not the same as high availability. It assumes a total loss ofthe production data center. Disaster recovery servers are separate and independent from the maincenter. They share no resources, and each has an independent network infrastructure for WANreplication. Both systems have the capacity to carry out full normal and emergency workloads. Theymust be maintained to be completely compatible.

Failover for disaster recovery is manual, not automatic. Clients will be affected.



Enhancing query performance — The Content Server Administration Guide describes how tomonitor query performance using the Update Statistics administration tool. It also describes how tolimit poorly-performing subqueries for users who belong to a large number of groups.

Common problems in web applicationperformancePerformance guidelines for WDK-based applications are published in theWeb Development KitDevelopment Guide. These include the following areas:• Configuration— Allocate sufficient Java memory

— Limit the number of allowable HTTP sessions

— Set a lower default page size

— Limit browser history

— Turn on value assistance caching

— Configure response compression and caching static elements

• Customization— Implementing actions

— Creating objects

— Limiting cookie lookup

• Search performance— Several search performance guidelines are available in this same guide.

• Content transfer performance—The following factors may increase content transfer performance:— Limit the number of imports per user transaction in the importcontainer configuration.

— Increase UCF session timeout, for example, from 250 to 500 seconds, inWEB-INF/classes/ucf.server.config.xml.

— On Windows clients, turn off virus scanning for archives.

— On Windows clients, turning off virus scanning for the Documentum/ucf subdirectory of theuser’s home directory, for example, Documents and Settings\my_name\Documentum\ucf.

— On Windows clients, turning off virus scanning for the Java executable directory andsubfolders.


Chapter 3Planning the System Migration

Migrating a system requires planning. You have to know your starting point, choose a destination,then pick the best route to get there. This chapter provides some practical advice for plotting yourcourse from version 6 to version 6.5 and later versions. Topics in this chapter include:

• Changes in supported environments, page 23

• Version 6.5 and later changes that impact Content Server upgrade or migration, page 24

• Mapping your current configuration, page 29

• Designing your version 6.5 configuration, page 32

• Planning upgrade and migration to version 6.5, page 34

Changes in supported environmentsTable 2, page 23 shows third-party product versions that were supported in version 5.3x, but are nolonger supported for version 6.x. Not every item in the table applies to every product. Refer to therelease notes for each product for detailed information on supported software environments.

Table 2. Third-party product versions not supported in this release

Product Category Third-party product Version

Windows 2000 SP2 Update Rollup 1

Mac OS X 10.2.8, 10.3.9

Solaris 8

AIX 5.2

HP-UX HP-UX 11

Operating System

Red Hat Enterprise Linux 3.x

Oracle 9i 9.2.0.8, 10.1.0.5

SQL Server 2000 SP4Database

DB2 UDB 8.1 FixPak 14, 8.2 FixPak 7


Planning the System Migration

Product Category Third-party product Version

BEA WebLogic Server 8.1 SP6

Tomcat 5.0.28

IBM WebSphere AS 5.1.1.13, 6.0.2.17Application Server

Oracle AS 10g 9.0.4.3, 10.1.2

Mozilla 1.7.13

Netscape 7.2Browser

Safari 1.3.2

Sun JRE 1.4.2_13

Microsoft JVM 5.0.0.3810JRE (Client)

Apple Java 1.3.1 Release 2

Java (Server) Java 1.4.x

BEA WebLogic Portal 8.1 SP6Portal Server

IBM WebSphere Portal 5.1.0.4

Version 6.5 and later changes that impactContent Server upgrade or migrationThis section describes miscellaneous changes that may impact the migration to 6.5 and later.

Enabling database partitioning while configuringContent Server

On a SQL or Oracle database, when you configure a repository, you can optionally enable databasepartitioning. By default, database partitioning is disabled. However, after the Content Serverand database upgrade, and the Content Server installation, when you run the Content Serverconfiguration program the program fails to display the Enable data partitioning checkbox. If youwant to use the database partitioning feature, execute the GENERATE_PARTITION_SCHEME_SQLquery with the appropriate GENERATE_PARTITION_SCHEME_SQL arguments to explicitly enabledatabase partitioning. For more information about instructions to partition the database, see the HighVolume Server Guide.



Upgrading multiple repositories to the same version

While upgrading Content Server from 5.3 SPx to 6.5 or later you must ensure that you perform thefollowing tasks:• Upgrade the software to 6.5 or later

• Upgrade the repository to 6.5 or later

If Content Server comprises multiple repositories, ensure that you upgrade all repositories to 6.5 orlater. You cannot have multiple repositories of different versions on the same Windows host sincedifferent method server binaries are used for different versions. If you retain a repository at a 5.3 SPxversion, the 5.3 SPx repository will use the latest 6.5 or later method server executable to launch JMSbased on the registry entries on the Windows host. This version incompatibility of the repository andmethod server executable causes an access violation and prevents the repository from starting up.

You are recommended to upgrade all repositories in Content Server to the same version.

Migrating objects to lightweight sysobjects (LWSOs)

Lightweight sysobjects (LWSOs) are useful if you have a large number of attribute values that areidentical for a group of objects. This redundant information can be shared among the LWSOs from asingle copy of the shared parent object. For example, Enterprise A-Plus Financial Services receivesmany payment checks each day. They record the images of the checks and store the paymentinformation in sysobjects. They will retain this information for several years and then get rid of it.For their purposes, all objects created on the same day can use a single ACL, retention information,creation date, version, and other attributes. That information is held by the shared parent object. TheLWSO has information about the specific transaction.

The administrative method, MIGRATE_TO_LITE, migrates objects to LWSOs. You specify the type toturn into a lightweight type and the shareable parent type. One use case is to split a standard typeup so that some attributes are in the parent type and the rest are in the lightweight type. Anothercase is to make the entire standard type into the lightweight type and create a brand-new type asthe shareable parent type. After the method executes, each LWSO has its own private parent, so theparents are not shared. At this point, you can reparent the LWSOs to shared parents and delete thenow "orphaned" parents. For full information on migrating objects to LWSOs, refer to DocumentumHigh Volume Server Developers Guide.

Changed behavior for attribute length

In DMCL/DFC 6 and before, if a value that is too large is set into a string attribute, the excessive datais silently discarded with no error. For example, if you try setting a 37-byte value into a 32-byteattribute, the last 5 bytes are silently discarded.

This past behavior can be considered data corruption and is often dangerous because the usertypically doesn’t know that it happened. DFC 6.5 or later now throws an exception if you try tooverrun the size of an attribute. To support backward compatibility DFC has a tunable preference toenable or disable the new behavior.



You can set the preference dfc.compatibility.truncate_long_values to true to silently throw away dataas in the past. The default for this preference is false. This default is chosen to avoid data loss, eventhough it is incompatible with previous versions.

If you prefer to use the pre-6.5 behavior, set the following dfc preference in dfc.properties to T:dfc.compatibility.truncate_long_values

When you get this new exception, the preferred solution is to carefully examine the application andresolve the real source of the problem. Chances are that silently discarding the data is not yourdesired result. If fixing the application is not an option, you can set the preference in dfc.properties toallow truncation.

Maximum accepted string lengths in Documentumquery language (DQL) statements

The maximum length of a character string literal in a DQL statement is now governed by themaximum allowed by the underlying relational database. In previous releases the DQL parser forsome databases enforced a smaller maximum.

Required configuration for machine-only applicationaccess control tokens

If you are using application access control (AAC) tokens configured to be valid only when sent fromapplications on particular host machines, you need to set the dfc.machine.id key in the dfc.propertiesfile used by those client applications. The key needs to be sent to the machine ID of the host fromwhich the AAC token is sent.

Audit trail entries for dm_startedworkitem enhanced

For dm_startedworkitem events, the string_4 property of the audit trail object now records theperformer of the work item.

DFC does not support linked store storage areas

In version 6.5, DFC will not support linked store storage areas. As a consequence, the followingitems are deprecated:• The dm_linkedstore object type, which represents linked store storage areas

• The dmi_linkrecord object type, which records the links between a linked storage area and filestores

• The CLEAN_LINKS administration method, which removes orphaned link records if needed



External storage

If you are using an external storage area and the plugin is configured to execute on the client host,you need to reconfigure the plugin to execute on the server. In 6.5 and later versions, DFC does notsupport executing the plugin on the client. To configure the plugin to execute on the server, set thea_exec_mode property of the storage object to F (FALSE). The storage object is one of dm_extern_file,dm_extern_free, or dm_extern_url, depending on the type of external storage you are using.

DFC does not support optical storage devices

DFC does not support optical storage devices with 6.5 and later versions.

DFC Full format specifications no longer accepted

The DFC methods, such as setFile, that previously accepted a full format specification no longer do so.From 6.5, those methods accept only a format name, such as txt or word, for the format argument.

SYNC_REPLICA_RECORDS administration method

The SYNC_REPLICA_RECORDS administration method is obsolete. It was used to complete themigration from DocPage Server 3.x to eContent Server 4.x. Neither of these server versions iscurrently supported. References to this method have been removed from the documentation.

LDIF file changes

Use of "true”, "false”, "1” or "0” as values for Boolean properties in the LDIF file is deprecated. Also,the list of accepted properties in the file has been updated.

Obsolete dmcl.ini keys

Two keys added in 5.3 SP4, max_file_size and max_backup_index, are obsolete in the 6.5 release.

New dfc.properties key to turn off trusted login

By default, applications running on the Content Server host are allowed to make repositoryconnections as the installation owner without presenting a password. This is called a trusted login. Ifan application, such as Documentum Administrator, that has an explicit login dialog box is installed



on a Content Server host, a user is able to login as the installation owner without a password usinga trusted login.

This release introduces a new dfc.properties key to turn off trusted logins if you do not want to allowtrusted logins through such applications. The key is:dfc.session.allow_trusted_login

Setting this key to false requires users to always provide a password, even when logging in as theinstallation owner.

DQL changes

The following are changes to the DQL.

POSITION keyword no longer supported

The POSITION keyword, previously supported in SELECT queries against the fulltext index, isno longer supported.

CHANGE...OBJECT statement

Previously, using the CHANGE...OBJECT statement was restricted to custom object types. With thisrelease, the statement may be used to change any type so long as the remaining restrictions as listedin the DQL Reference manual description of CHANGE...OBJECT are not violated.

DQL date literals enhancement

You can now specify ’utc’ in a date literal in a DQL statement. The new syntax for date literals is:DATE(’date_value[utc]’ [,’pattern’])

You can define date_value using any of the valid character string formats representing a date, or it canbe one of the keywords that represent dates.

If utc is included, Content Server assumes that the specified date_value is UTC time. The specificationof utc is not case sensitive.

Behavior change after failed save or checkin

In version 6.5, if a save or checkin of an object fails, DFC will revert the object automatically beforereturning the object to the application issuing the save or checkin. Reverting the object removes anychanges made to the object before the attempted save or checkin. The application must then reapplyany changes made prior to the save or checkin before reattempting the save or checkin operation. This



behavior is different from how failed saves or checkins were handled by the prior DMCL. The DMCLin prior releases simply marked the object as in an error state and returned it to the application.

Trace method migration

In version 6.5, the tracing implementation for client-side tracing is changed and enhanced. The tracemethod is replaced with the IDfSession.setServerTraceLevel method. For complete details, refer to theContent Server Administration Guide.

The Trace API method in existing scripts will continue to work, but its implementation is changed.In version 6.5, the level 0 turns tracing off and any nonzero value turns tracing on. If a file name isspecified on the Trace method command line, the trace information is recorded in that file. If no file isspecified, the trace information is placed in the file specified in the dfc.properties file, in accordancewith the new tracing implementation.

New server.ini key

Version 6.5 introduces a new server.ini key for Windows platforms. The key allows you to configurethe maximum size of the listener queue for Content Server connection requests.

Content Server creates a socket listener for incoming connection requests with a maximum backlogset to 200 by default. On Windows platforms, you can reset that maximum if needed. To do so, set thelistener_queue_length key in the server.ini file. Set the key to a positive integer value. Content Serverpasses the specified value to the Windows Sockets call listen().

enable_workitem_mgmt obsolete

The enable_workitem_mgmt key controls whether permissions to perform certain workflow actionsare enforced. The affected actions are:• Acquiring a work item

• Delegating a work item

• Halting and resuming a running activity

• Changing a work item’s priority

If the key is set to T (TRUE), any user can perform those actions. The key is F (FALSE) by default.

Mapping your current configurationThe following system configuration diagrams and sample worksheets provide a starting point fordocumenting the infrastructure of your current system. You might already have similar diagramsfrom which you can get much of this information. If you do not, be sure to keep a copy of your



version 6 plan to help with future migrations. Take the time to verify that any existing diagramsreflect the current configuration.

Complete one copy of the table below for each server host and client configuration used in yourcurrent system, for example, Content Server, fulltext indexing server, Federated Search Server,application server.

Table 3. Content Server and database server host worksheet

Item Value

Hardware andProcessors

Memory

Operating system andversion

Content Server version

RDBMS and version

Repository size Number of objects:

Storage space required:

Global Registry? [ ] Yes [ ] No

Java/JRE version

DFC version

Other product version





Table 4. Application server host worksheet

Item Value

Hardware andprocessors

Memory


HTTP Server version

Java version

DFC version

Other product andversion



Table 5. Index server host worksheet

Item Value

Hardware andprocessors

Memory


HTTP server version

Java version

DFC version




Table 6. Client machine worksheet

Item Value


Browser and version



Java version




Table 7. Customized components worksheet

Product CustomizedComponents

Customizationtype

CustomizationDescription

Disposition

• 6.5 Compatible

• Needs changes

• Obsolete

• 6.5 Compatible

• Needs changes

• Obsolete

• 6.5 Compatible

• Needs changes

• Obsolete

Designing your version 6.5 configurationThis section discusses some of the design decisions you need to make before implementing yourversion 6.5 configuration. Departmental systems are configurations where the Content Server, RDBMS,and global registry all reside on the same host machine. Enterprise systems are configurationscontaining multiple Content Servers, data repositories, and distributed services to improveperformance in high traffic or geographically disbursed environments.

Addressing hardware concerns

Verify that the hardware you are currently using will continue to meet your needs for the foreseeablefuture. In particular, if you have been hosting more than one server on a single machine, for example,Content Server and an application server, this is a good time to divide the functions between two ormore server hosts to boost performance.



Upgrading third-party software

Prior to migrating to version 6.5 or later, verify that the third-party software you are currently usingwith version 6 is still supported, and upgrade to supported versions as necessary. See theWhat’sNew document for a list of supported software.

Planning for global registries

You need to designate one of the repositories in your version 6.5 system as the global registry. Theglobal registry is a central location used to store common objects used by all repositories, such as SBO(Service-based Business Object) network locations, BOCS (Branch Office Caching Service) settings,and user settings. You need to decide which of your repositories will be enabled as the global registry.

If you already have a version 5.3 or 6 global registry, you can use it with a repository that youupgrade to 6.5. Refer to Table 9, page 41 for compatible versions of Content Server, global registry,and client applications.

During repository configuration, you are prompted to choose one of the following options:

• Use the current repository as a global registry

You need to provide a user login name and password for the global registry user in the repositoryyou are currently configuring. Record the login name and password; you will use this login nameand password to configure other repositories in your system to allow them to access the globalregistry. The local DFC instance is also configured to access this global registry.

• Specify a different repository as the global registry

You need to provide the repository name and the login credentials (user login name andpassword) of the global registry user in that repository. The DFC instance on the current hostis configured to access the remote global registry repository.

• Do later

If you choose this option, you can delete the dfc.bof.registry.repository, dfc.bof,.registry.username,and dfc.bof.registry.password from the dfc.properties file and rerun the DFC installer on this hostin order to designate the global registry repository at a later time. Version 6.5 requires a globalregistry, so clients should not connect to the system until the global registry is configured.

Regardless of whether you designate the repository as a global registry, the global registry user iscreated all repositories. The global registry user, who has the user name of dm_bof_registry, isthe repository user whose account is used by DFC clients to connect to the repository to accessrequired service-based objects and user information. The user has read access to objects in the/System/Modules only.

• If you configure the repository as a global registry, you provide the user login name and passwordfor the user and the user state is set to Active.

This can be any arbitrary user login name and password. Do not use the repository owner’scredentials or the installation owner’s credentials.

• If you do not configure the repository as a global registry, the user is created with a default valuefor the login name and the user state is set to Inactive.



If you later enable the repository as a global registry, use Documentum Administrator to changethe user state to Active and provide the user with a user login name and password that youchoose. Refer to the Content Server Installation Guide for instructions on enabling the repositoryas a global registry.

Mapping your version 6.5 configuration

For each server host and client configuration, complete a planning document. You can use the sameforms used for mapping your current configuration (see Mapping your current configuration, page29).

Planning upgrade and migration to version 6.5Now that you know your starting point and your destination, you can choose the best upgradeand migration path. The recommended configuration is a homogeneous version 6.5 system. Themigration paths described below allow your applications to continue working and minimize impacton your users, but your users will not get the full benefits of version 6.5 features until the migration iscomplete.

Setting up a test environment

Before migrating your production system, EMC Documentum recommends that you set up a testenvironment that includes the same hardware, RDBMS, and software configurations as yourproduction system, including a copy of your production repository. This allows you to practicemigrating your systems, as well as troubleshoot any migration problems before committing changesto your production system.

Client-first migration

If your system uses only Webtop, DFS, custom DFC, or custom WDK clients, you have the option ofmigrating the client applications first. Refer to the installation or deployment guide for the clientapplication for detailed instructions.

ACS and BOCS version compatibility and migration — Parallel streaming from ACS will be usedonly if both ACS and UCF (WDK or DFS applications) are version 6.5. Parallel streaming from BOCSwill be used only if ACS, BOCS, and UCF are version 6.5.

Note: When you upgrade the BOCS to version 6.5, you must update the BOCS version specification inthe global registry using Documentum Administrator. For BOCS 6.0, specify the version as 2.0. ForBOCS 6.5, specify the version as 2.1.

WDK clients compatibility and migration — WDK-based clients are compatible with version 5.3and version 6 Content Server. Some WDK version 6.5 features will be available, such as those that run



in JavaScript on the client. Other features will not be available until you complete the migration toversion 6.5, such as lightweight sysobjects, data partitioning, batch processing and scoping..

These are the steps to migrate from version 5.3 or 6 to version 6.5, migrating the clients first.

1. Upgrade the application server and client browsers.

2. Enable the global registry in a version 6 repository in order to support version 6 client featuresthat require a global registry. Refer to Documentum Content Server Installation Guide forinstructions. Version 6.5 clients with a version 5.3 global registry is not supported.

3. Upgrade the Content Servers in place.

4. Configure one Content Server as the version 6.5 global registry. If you had a global registry inversion 6, you can upgrade that server in place using the same settings.

Planning an upgrade when multiplerepositories work as a FederationA Federation is two or more repositories that are bound together to facilitate management of globalusers, groups, and ACLs in a multi-repository distributed configuration. One repository in the set isthe governing repository. The remaining repositories are member repositories.

Keeping objects synchronized in multiple repositories can be time consuming and error-prone if thework is done manually in each repository. A repository federation automates much of the process.

Only certain combinations of different repository versions can work together as a Federation. It isrecommended to plan an upgrade so that all participating repositories are supported.

When you upgrade repositories (that work together as a Federation), ensure that the upgradedrepository versions (in case of a non-homogeneous Federation) can work together as a Federation.

Refer to the following table for information about the various versions of governing and memberrepositories that can work together as a combination in a Federation.

Table 8. Federation Configurations

Governing RepositoryVersion

Member Repository Version(s) Supported Y/N

5.3 Y

5.3 and 6 N

5.3, 6.5 and later Y

5.3, 6, 6.5 and later N

5.3 6, 6.5 and later N



Governing RepositoryVersion

Member Repository Version(s) Supported Y/N

5.3 N

6 Y

6.5 and later N

5.3 and 6 N

5.3, 6.5 and later N

5.3, 6, 6.5 and later N

6 6, 6.5 and later Y

5.3 N

6 Y

6.5 and later Y

5.3 and 6 N

5.3, 6.5 and later N

5.3, 6, 6.5 and later N

6.5 and later 6, 6.5 and later Y

Note: For more information about Configuration requirements in a Federation, see the DistributedConfiguration Guide.

Guidelines to upgrade a distributed configuration

Use these guidelines in deciding how to upgrade a distributed configuration.

Repository federations — EMC Documentum supports federations that contain repositories ofdifferent versions. In this release, any mix of version 5.3x and later repositories may be federationmembers. If you are upgrading the repositories in a federation, upgrade the governing repositoryfirst. If the governing repository is a version 5.3 or 5.3 SP1 repository, keep in mind the following:• Prior versions do not support dynamic groups. Consequently, any dynamic groups definedin the governing repository are propagated to any members prior to version 5.3 as standard,nondynamic groups.

• Similarly, prior versions do not support access restricting (AccessRestriction, ExtendedRestriction)entries in ACLs. If the federation’s federation mode is replicating ACLs with those kinds ofentries to member repositories prior to version 5.3, the entries are ignored by Content Serversprior to version 5.3.

• The restricted_folder_ids attribute for users (introduced in version 5.3) is a local attribute. Thismeans that any restricted users in the governing repository are propagated as unrestricted usersin the member repositories. If the member is a version 5.3 or 5.3 SP1 repository, you can setthat attribute locally.

Repositories with object replication — Upgrade the source repository, then the target repositories.If you have a group of repositories where each repository is both a source and a target, the upgrade



can begin with any of the repositories. This can apply, for example, if objects are replicated fromrepository A to repository B, repository B to repository C, and from repository C to repository A. Youcan replicate between repositories that use different Content Server versions, but you lose attributesthat are in the newer version, since they cannot be replicated to a version that does not contain them.Content Server version 6.5 supports replication among server versions 5.3x and later only.

Repositories with distributed or load-balanced content — Shut down the primary Content Serverand all content-file servers. Upgrade the primary Content Server first, then upgrade the content-fileservers.

Note: For more information about upgrading a distributed configuration, see the Content ServerInstallation Guide.




Chapter 4Interoperability and Compatibility

Unless otherwise noted, any 5.3 SP2 (or greater SP) or 6.x SPx product can coexist with any other 5.3SP2 (or greater SP) or 6.x SPx product on the same host. Mixed versions (5.3 SPx with 6.x SPx) cannotshare the same application instance.

In addition, unless otherwise noted, all 6.x SPx products can interoperate with all other 6.x products.Interoperability takes place when different client applications perform operations on the same objectinstance in a repository.

Mixed version compatibility, page 39, provides detailed information for determining compatibilitybetween different version client applications and Content Server. The Cross-product dependencies andinteroperability section of each product’s release notes provides a list of products depended on by aproduct and additional products with which a product generally interoperates.

Mixed version compatibilityUnder most conditions, 5.3 SP2 (or greater SP) or 6.x SPx clients can work with Content Serversthat are from a different major version family, 6.x SPx or 5.3 SP2 (or greater SP), respectively. Thiskind of system configuration is referred to as a mixed version configuration. You might want to setup a mixed version configuration when you want to migrate only the client or server side of yourproduction environment to 6.5. In a mixed version configuration, most customers migrate the serverside of their production environment first.

Note: You can also have a mixed version configuration between different products in the sameversion family (6.0, 6.0 SP1, and 6.5, for example).

In a mixed version configuration, functionality provided by the higher version product is generallynot available to the lower version product. The mixed version products work fine together, but thenew functionality provided by the higher version product is not exposed or it is disabled. In somecases (see Guidelines for determining mixed version compatibilities, page 40 and Upgrade andCompatibility matrices, page 42), new functionality provided by the higher version product maycause a lower version product not to work properly.


Interoperability and Compatibility

Guidelines for determining mixed versioncompatibilitiesThe client application, global registry, and Content Server must be 5.3 SP2 or later. The clientapplication major version must match the major version of the global registry. The client applicationcan then connect to any 5.3 SPx or 6.x SPx Content Server. For example, 5.3 SP2 client applicationsrequire a 5.3 SPx global registry to work with a 5.3 SPx or a 6.5 SPx Content Server. Similarly, 6.5SPx client applications require a 6.5 SPx global registry. They can then connect to a 5.3 SPx or 6.xSPx Content Server.

Client applications also contain a combination of artifacts (modules, aspects, Type-Based Objects(TBOs), or Service-Based Objects (SBOs)) that contribute to mixed version compatibility orincompatibility, depending on how these artifacts were developed.

In a typical deployment, the application server contains the modules, aspects, and TBOs for a clientapplication while the global registry contains the SBOs. The application server also contains a versionof Documentum Foundation Classes (DFC), typically installed by the client application. The versionof DFC is the same version as the client application.

For 5.3 SPx client applications, always compile the modules, aspects, and TBOs using the sameJDK version (1.4) used by the Documentum Foundation Classes (DFC) on the application server.Compiling these artifacts with a later version JDK (1.5, for example) is not supported, because objectbinaries compiled with JDK 1.5 are not guaranteed to run on JDK 1.4.

For 6.x SPx clients applications, compile 6.x SPx artifacts with JDK 1.5, because there might be JDK 1.5specific calls in the artifact code preventing the artifact from successfully compiling with JDK 1.4.However, if a module, aspect, or TBO can be successfully compiled using JDK 1.4, then it can runagainst DFC 6.x SPx on an application server running JDK 1.5. For SBOs, use JDK 1.4 for 5.3 SPx clientapplications and JDK 1.5 for 6.x SPx client applications.

Table 9, page 41 summarizes which combinations of client application, DFC and JDK versions on theclient application server, global registry version, and JDK versions of the modules, aspects, TBOs andSBOs enable access to Content Server 5.3 SPx or 6.x SPx.



Table 9. Mixed Version Configuration

ClientApplicationVersion

ApplicationServerEnvironment

JDKModules/Aspects/TBOsCompiledWith

GlobalRegistryVersion

JDK SBOsCompiledWith

ContentServerVersion

None

JDK 1.4

5.3 SPx None

JDK 1.4

5.3 SPx, 6.xSPx

5.3 SPx DFC 5.3 SP2(or greater SP)

JDK 1.4 JDK 1.5 5.3 SPx None

JDK 1.4

No validContentServerversions

6.x SPx DFC 6.x SPx

JDK 1.5

None

JDK 1.4, JDK1.5

6.x SPx None

JDK 1.5

5.3 SPx, 6.xSPx

Note: None indicates that the client application does not have any modules, aspects, TBOs, or SBOs.

Forward and Backward Compatibility Notes

• Only version 5.3.x of Webtop and Digital Asset Manager (DAM), and custom 5.3 version ofDocumentum Foundation Classes (DFC) and Web Development Kit (WDK) applications areforward compatible Content Server 6.x.

— In a mixed environment where 5.3.x and 6.x clients are used with version 6.x Content Server,the following conditions apply:

— Certain 5.3.x SBO and TBO restrictions are applicable

— Separate 5.3.x and 6.0 or 6.5 Global Registries are required

— Full functionality may not be accessible through 5.3.x clients

• Version 6.x Documentum Administrator (DA), Webtop, DAM, DCO, and custom WDK/DFCapplications are backward compatible with 5.3.x Content Servers

• In addition to the homogeneous stacks (5.3.x Content Server with 5.3.x Client and 6.x ContentServer with 6.x Client), the following mixed version deployment scenarios are supported in6.5 SPx:

— 5.3.x Content Server with 6.x Global Registry with 6.x Client

— 6.x Content Server with 5.3.x Global Registry with 5.3.x Client

— 6.x Content Server with 6.x Global Registry with 6.x Client



Upgrade and Compatibility matricesThis section provides the following information:• Upgrade matrix for Content Server and related components — Table 11

• Compatibility matrices for the various client components against Content Server and otherdependent products — Table 12, Table 13, and Table 14

Notations used in Tables 11, 12, 13, and 14:• Y - QA tested and/or Paper certified

• Y* - Read the notes at the end of the table

• N - No

• NA - Not Applicable

• NR - Not Released

The upgrade matrix in Table 11 specifically deals with the possible upgrade paths for Content Serverand related server components starting from version 5.3 SP6.



Table 10. Upgrade matrix for Content Server and related components

Content ServerContent Server 5.3 SP6 6 6 SP1 6.5 6.5 SP1 6.5 SP2 6.5 SP3

5.3 SP6 Y Y Y Y Y Y Y6 NA Y Y Y Y Y Y

6 SP1 NA NA Y Y Y Y Y6.5 NA NA NA Y Y Y Y

6.5 SP1 NA NA NA NA Y Y Y6.5 SP2 NA NA NA NA NA Y Y6.5 SP3 NA NA NA NA NA NA Y

Web Publisher Server Files

Web Publisher (WP) 5.3 SP6 6 6 SP1 6.5 6.5 SP1 6.5 SP2 6.5 SP35.3 SP6 Y Y Y Y Y Y Y

6 N Y Y Y Y Y Y6 SP1 N Y Y Y Y Y Y6.5 N Y Y Y Y Y Y

6.5 SP1 N Y Y Y Y Y Y6.5 SP2 N Y Y Y Y Y Y6.5 SP3 N Y Y Y Y Y Y

Content Intelligence Services Server ComponentContent IntelligenceServices (CIS) 5.3 SP6 6 6 SP1 6.5 6.5 SP1 6.5 SP2 6.5 SP3

5.3 SP6 NA Y* Y* Y* NR Y* Y*6 NA NA Y Y NR Y Y

6 SP1 NA NA NA Y NR Y Y6.5 NA NA NA NA NR Y Y



6.5 SP1 NA NA NA NA NR Y Y6.5 SP2 NA NA NA NA NR NA Y6.5 SP3 NA NA NA NA NR NA NA

Federated Search Services Server ComponentFederated Search Services(FSS) 5.3 SP6 6 6 SP1 6.5 6.5 SP1 6.5 SP2 6.5 SP35.3 SP6 NA Y Y Y Y Y Y6 NA NA Y Y Y Y Y

6 SP1 NA NA NA Y Y Y Y6.5 NA NA NA NA Y Y Y

6.5 SP1 NA NA NA NA NA Y Y6.5 SP2 NA NA NA NA NA NA Y6.5 SP3 NA NA NA NA NA NA NA

Documentum Compliance Manager DARsDocumentum ComplianceManager (DCM) 5.3 SP6 6 6 SP1 6.5 6.5 SP1 6.5 SP2 6.5 SP3

5.3 SP6 NR NR NR NR NR NR NR6 NR NR NR NR NR NR NR

6 SP1 NR NR NR NR NR NR NR6.5 NR NR NR NA Y Y Y

6.5 SP1 NR NR NR NA NA Y Y6.5 SP2 NR NR NR NA NA NA Y6.5 SP3 NR NR NR NA NA NA NA6.5 SP3 N N N N Y Y NA

Content Server (Repository)Documentum FoundationServices (DFS) 5.3 SP6 6 6 SP1 6.5 6.5 SP1 6.5 SP2 6.5 SP3

5.3 SP6 NA NA NA NA NA NA NA



6 NA NA NA NA NA NA NA6 SP1 NA NA NA NA NA NA NA6.5 Y NA Y Y NA NA NA

6.5 SP1 NA NA NA NA NA NA NA6.5 SP2 NA NA NA NA NA NA NA6.5 SP3 NA NA NA NA NA Y NA

Retention Policy Services DocApps/DARsRetention Policy Services(RPS) 5.3 SP6 6 6 SP1 6.5 6.5 SP1 6.5 SP2 6.5 SP35.3 SP6 NA Y N Y N N N6 NA NA Y Y Y Y Y



Records Manager DocApps/DARs

Records Manager (RM) 5.3 SP6 6 6 SP1 6.5 6.5 SP1 6.5 SP2 6.5 SP35.3 SP6 NA Y N Y N N N6 NA NA Y Y Y Y Y





Physical Records Manager DocApps/DARsPhysical Records Manager(PRM) 5.3 SP6 6 6 SP1 6.5 6.5 SP1 6.5 SP2 6.5 SP3

5.3 SP6 NR NR NR NR NR NR NR6 NR NA Y Y Y Y Y

6 SP1 NR NA NA Y Y Y Y6.5 NR NA NA NA Y Y Y

6.5 SP1 NR NA NA NA NA Y Y6.5 SP2 NR NA NA NA NA NA Y6.5 SP3 NR NA NA NA NA NA NA

Import Manager DocApps/DARs

Import Manager (IM) 5.3 SP6 6 6 SP1 6.5 6.5 SP1 6.5 SP2 6.5 SP35.3 SP6 NA Y Y Y NR NR NR6 NA NA Y Y NR NR NR

6 SP1 NA NA NA Y NR NR NR6.5 NA NA NA NA NR NR NR

6.5 SP1 NA NA NA NA NR NR NR6.5 SP2 NA NA NA NA NR NR NR6.5 SP3 NA NA NA NA NR NR NR



Note: The following notes are applicable to products listed in Table 11 with a Y*:

• Ensure that the version of the Web Publisher Server files is the same as the version of ContentServer. If the versions do not match, you must place the JARS at the location specified in theUpgrade Notes section of the Web Publisher Release Notes.

• When CIS 5.3 SP6 users upgrade to version 6x, 6.5, 6.5 SP2, or 6.5 SP3, some CIS features availablethrough legacy tools may no longer work.

Based on the guidelines in Guidelines for determining mixed version compatibilities, page 40,Table 12 summarizes whether a specific client version works with a 5.3 SP6 repository and a 6.xSPx repository. Unless otherwise noted, 6.x SPx indicates any of the following releases: 6.0, 6.0SP1, 6.5, and 6.5 SPx.

Note: Many products consist of multiple installed components (WAR file, DAR file or DocApp, forexample). Mixing versions of these components (6.0 WAR file and 6.5 DAR file, for example) for aparticular (6.5) product version is not supported.



Table 11. Compatibility matrix for client components against Content Server and dependent products

Product/Suite Dependent products Content Server

Webtop (WT)DA

VersionCTSVersion

GlobalRegistryVersion 5.3 SP6 6 6 SP1 6.5 6.5 SP1 6.5 SP2 6.5 SP3

NA NA 5.3 SP6 Y Y Y Y Y Y Y

NA NA 6.0 SPx NA NA NA NA NA NA NA

5.3 SP6 NA NA 6.5 SPx NA NA NA NA NA NA NA

NA NA 5.3 SP6 NA NA NA NA NA NA NA

NA NA 6.0 SPx Y Y Y Y Y Y Y

6 NA NA 6.5 SPx Y Y Y Y Y Y Y



6 SP1 NA NA 6.5 SPx Y Y Y Y Y Y Y



6.5 NA NA 6.5 SPx Y Y Y Y Y Y Y



6.5 SP1 NA NA 6.5 SPx Y Y Y Y Y Y Y


NA NA 6.0 SPx Y Y Y Y Y Y Y**

6.5 SP2 NA NA 6.5 SPx Y Y Y Y Y Y Y**






Content Intelligent ServicesDocumentum

Administrator (DA)DA

VersionCTSVersion


5.3 SP6 NA NA NA Y N N N NR N N

6 NA NA NA N Y Y* Y* NR N N

6 SP1 NA NA NA N Y Y Y NR Y* Y*

6.5 NA NA NA N Y Y Y NR Y* Y*

6.5 SP1 NA NA NA N Y Y Y NR Y* Y*

6.5 SP2 NA NA NA N Y Y Y NR Y Y




Federated Search Services

Webtop (WT)DA

VersionCTSVersion


5.3 SP6 NA NA NA Y Y Y Y Y Y Y

6 NA NA NA Y Y Y Y Y Y Y

6 SP1 NA NA NA Y Y Y Y Y Y Y

6.5 NA NA NA Y Y Y Y Y Y Y






Documentum Foundation Service ClientDocumentumFoundation Service

(DFS)DA

VersionCTSVersion


5.3 SP6 NA NA NA NA NA NA NA NA NA NA

6 NA NA NA NA NA NA NA NA NA NA

6 SP1 NA NA NA NA NA NA NA NA NA NA

6.5 NA NA NA NA NA Y Y NA NA NA

6.5 SP1 NA NA NA NA NA NA NA NA NA Y

6.5 SP2 NA NA NA NA NA NA NA NA NA Y

6.5 SP3 NA NA NA NA NA NA NA Y Y Y



Content Server (Repository)DocumentumComposer

DAVersion

CTSVersion




6 SP1 NA NA NA NA Y Y NA NA NA NA

6.5 NA NA NA NA Y Y Y NA NA NA

6.5 SP1 NA NA NA NA Y Y Y Y NA NA

6.5 SP2 NA NA NA NA Y Y Y Y Y NA

6.5 SP3 NA NA NA NA Y Y Y Y* Y* Y*

Content Server (Repository)Distributed Content(BOCS Version)

DAVersion

CTSVersion




5.3 SP6 Y Y Y Y Y Y Y

6.0 SPx Y Y Y Y Y Y Y

5.3 SP6 NA NA 6.5 SPx NA NA NA NA NA NA Y




5.3 SP6 Y Y Y Y NA NA NA


6 SP1 NA NA 6.5 SPx Y Y Y NA Y Y Y



6.5 NA NA 6.5 SPx Y Y Y NA Y Y Y



6.5 SP1 NA NA 6.5 SPx Y Y Y NA Y Y Y









Content Server (Repository)Documentum

Administrator (DA)DA

VersionCTSVersion


5.3 SP6 NA NA NA Y N N N NR N N

6 NA NA NA N Y Y* Y* NR N N

6 SP1 NA NA NA N Y Y Y NR Y* Y*

6.5 NA NA NA N Y Y Y NR Y* Y*

6.5 SP1 NA NA NA N Y Y Y NR Y* Y*



Content Server (Repository)DocumentumReporting Services

(DRS)DA

VersionCTSVersion




5.3 SP6 NA NA NA Y N N N N N N

6 NA NA NA Y Y N N N N N

6 SP1 NA NA NA Y Y Y N N N N

6.5 NA NA NA Y Y Y Y N N N

6.5 SP1 NA NA NA Y Y Y Y Y N N

6.5 SP2 NA NA NA Y Y Y Y Y Y N


Content ServerDocumentumFoundation Classes

(DFC)DA

VersionCTSVersion


5.3 SP6 NA NA NA Y N N Y N Y Y



6 NA NA NA N Y N Y N N N

6 SP1 NA NA NA N N Y Y N N Y

6.5 NA NA NA Y Y Y Y N Y N

6.5 SP1 NA NA NA N N N N Y Y N

6.5 SP2 NA NA NA Y N Y N Y Y N

6.5 SP3 NA NA NA N N Y N N N Y

Content ServerInteractive DeliveryServices (IDS)

DAVersion

CTSVersion


5.3 SP65.3.x andlater NA NA Y NA NA NA NA NA NA



65.3.x andlater NA NA N Y NA NA NA NA NA

6 SP15.3.x andlater NA NA N Y Y NA NA NA NA

6.55.3.x andlater NA NA Y Y Y Y NA NA NA

6.5 SP15.3.x andlater NA NA Y Y Y Y Y NA NA

6.5 SP26.5 SP2and later NA NA N Y Y Y Y Y NA

6.5 SP36.5 SP2and later NA NA N Y Y Y Y Y Y

Content ServerInteractive DeliveryServices Accelerated

(IDSx)DA

VersionCTSVersion







6.5 NA NA NA NA NA NA NA NA NA NA

6.5 SP16.5 SP2and later NA NA N Y Y Y Y NA NA

6.5 SP26.5 SP2and later NA NA N Y Y Y Y Y NA

6.5 SP36.5 SP2and later NA NA N Y Y Y Y Y Y

Content ServerDocumentumApplication

Connectors (DAC)DA

VersionCTSVersion



6.0 SPx NA NA NA NA NA NA NA






















Content ServerDocumentumCollaborativeServices (DCS)

DAVersion

CTSVersion

























Content ServerDocumentumRepository Servicesfor MicrosoftSharePoint(SharepointJournaling)

DAVersion

CTSVersion









6.5 SP2 NA NA NA N Y Y Y Y Y NR

6.5 SP3 NA NA NA NR NR NR NR NR NR NR

Content ServerMy Documentumfor MicrosoftSharePoint

(Advanced ECM)DA

VersionCTSVersion









6.5 SP2 NA NA NA Y Y Y Y Y Y NR


Content ServerArchive Servicesfor MicrosoftSharePoint

DAVersion

CTSVersion


5.3 SP6 NA NA NA Y Y Y NA NA NA NA



6 NA NA NA Y Y Y NA NA NA NA

6 SP1 NA NA NA Y Y Y NA NA NA NA





Content ServerContent Servicesfor MicrosoftSharePoint

DAVersion

CTSVersion


5.3 SP6 NA NA NA Y Y Y NA NA NA NA

6 NA NA NA Y Y Y NA NA NA NA



6 SP1 NA NA NA Y Y Y NA NA NA NA





Interactive Delivery Services /Interactive DeliveryServices Accelerated (IDSx)

Web Publisher (WP)DA

VersionCTSVersion







6.5 NA NA NA Y Y Y Y Y Y Y




Content ServerDigital AssetManager (DAM)

DAVersion

CTSVersion


5.3SP6 5.3 SP6 Y Y Y Y Y Y Y

NA 6.0 SPx NA NA NA NA NA NA NA

5.3 SP6 NA NA 6.5 SPx NA NA NA Y NA NA NA

NA 5.3 SP6 NA NA NA NA NA NA NA

6.x 6.0 SPx Y Y Y Y Y Y Y

6 NA 6.x 6.5 SPx Y Y Y Y Y Y Y





6 SP1 NA 6.x 6.5 SPx Y Y Y Y Y Y Y



6.5 NA 6.x 6.5 SPx Y Y Y Y Y Y Y



6.5 SP1 NA 6.x 6.5 SPx Y Y Y Y Y Y Y







Content ServerImport Manager

(IM)DA

VersionCTSVersion


5.3 SP6 NA NA NA Y Y* Y* Y* Y* Y* Y*

6 NA NA NA Y* Y Y* Y* Y* Y* Y*



6 SP1 NA NA NA Y* Y* Y Y* Y* Y* Y*

6.5 NA NA NA Y* Y* Y* Y Y* Y* Y*




Content ServerPhysical RecordsServices (PRS)

DAVersion

CTSVersion



6 NA NA NA NA Y Y Y Y Y Y

6 SP1 NA NA NA NA Y Y Y Y Y Y



6.5 NA NA NA NA Y Y Y Y Y Y

6.5 SP1 NA NA NA NA Y Y Y Y Y Y



Content ServerRecords Manager(RM)

DAVersion

CTSVersion



6 NA NA NA N Y Y Y Y Y Y



6 SP1 NA NA NA N Y Y Y Y Y Y

6.5 NA NA NA N Y Y Y Y Y Y

6.5 SP1 NA NA NA N Y Y Y Y Y Y


6.5 SP3 NA NA NA N *Y *Y *Y *Y *Y Y

Content ServerRetention PolicyServices (RPS)

DAVersion

CTSVersion



6 NA NA NA N Y Y Y Y Y Y

6 SP1 NA NA NA N Y Y Y Y Y Y



6.5 NA NA NA N Y Y Y Y Y Y



6.5 SP3 NA NA NA N *Y *Y *Y *Y *Y Y

Content Server

Forms BuilderDA

VersionCTSVersion


5.3 SP6 NA NA NA Y NA NA NA NA NA NA

6 NA NA NA NA Y Y N N N N

6 SP1 NA NA NA NA Y Y N N N N

6.5 NA NA NA NA Y* Y* Y Y Y Y



6.5 SP1 NA NA NA NA Y* Y* Y* Y Y Y

6.5 SP2 NA NA NA NA Y* Y* Y* Y* Y Y*

6.5 SP3 NA NA NA NA Y* Y* Y* Y* Y* Y

Content Server

Process BuilderDA

VersionCTSVersion











Content Server

Process IntegratorDA

VersionCTSVersion











Content Server

TaskSpaceDA

VersionCTSVersion



6 NA NA NA NA Y Y N N N N

6 SP1 NA NA NA NA Y Y N N N N



6.5 SP2 NA NA NA NA Y* Y* Y* Y* Y Y**




Content ServerContent Services forSAP (CS SAP)

DAVersion

CTSVersion

























Content ServerArchive Services forSAP (AS SAP)

DAVersion

CTSVersion

























Content ServerERP Integration

ServiceDA

VersionCTSVersion









6.5 SP2 NA NA NA Y Y Y Y Y Y NA


Content ServerPDF AnnotationService (PAS)

DAVersion

CTSVersion

























Content ServerCTS products:Audio VideoTransformationService, MediaTransformation

Service, DocumentTransformationService, Advanced

DocumentTransformationService, XMLTransformation

Service, ThumbnailServer

DAVersion

CTSVersion

























Content ServerThumbnailGenerator

DAVersion

CTSVersion


NA NA 5.3 SP6 NR NR NR NR NR NR NR

NA NA 6.0 SPx NR NR NR NR NR NR NR

5.3 SP6 NA NA 6.5 SPx NR NR NR NR NR NR NR





6 NA NA 6.5 SPx NR NR NR NR NR NR NR

NA NA 5.3 SP6 NR NR NR NA NR NR NR


6 SP1 NA NA 6.5 SPx NR NR NR NR NR NR NR



6.5 NA NA 6.5 SPx NR NR NR NR NR NR NR










Content ServerBusiness ActivityMonitor (BAM)

DAVersion

CTSVersion





6 NA NA NA NA Y NA NA NA NA NA

6 SP1 NA NA NA NA NA Y NA NA NA NA

6.5 NA NA NA NA NA NA Y NA NA NA

6.5 SP1 NA NA NA NA NA NA Y Y NA NA

6.5 SP2 NA NA NA NA NA NA NA Y Y Y


Content ServerWebDAV

DAVersion

CTSVersion




NA NA 5.3 SP6 Y Y Y Y NA NA Y




NA NA 6.0 SPx Y Y Y Y NA NA Y

6 NA NA 6.5 SPx Y Y Y Y NA NA Y



6 SP1 NA NA 6.5 SPx Y Y Y Y NA NA Y



6.5 NA NA 6.5 SPx Y Y Y Y NA NA Y









6.5 SP3 NA NA 6.5 SPx Y Y Y Y NA NA Y



Content Server

FTP ServicesDA

VersionCTSVersion









Note: The following specific notes are applicable to products listed in Table 12 with a Y**:

• If you install Content Server 6.5 SP3 and deploy Webtop and TaskSpace version 6.5 SP2 or earlier,you must perform the following tasks to ensure that the functionality in Webtop and TaskSpacework properly:

1. Navigate to the <Webtop_installation_directory>/WEB-INF/lib folder and/or the<Taskspace_installation_directory>/WEB-INF/lib folder.

2. Extract InboxResources.properties from the Workflow JAR (workflow.jar).

3. Edit the InboxResources.properties file to add the ALLOW_NEXT_ACT_FOR_SEQUENTIAL_FORWARD property as follows:QUICKFLOW_DOC_VERSION-CURRENT

OPTIONAL_DOC_VERSION=INBOX_QUERY_GROUP_COUNT=250ALLOW_NEXT_ACT_FOR_SEQUENTIAL_FORWARD=FALSE

Note:— Set the value to TRUE to allow users to go forward to the next activity even if all performershave not completed the activity.

— Set the value to FALSE to prevent users from going forward to the next activity until all theperformers have completed the current activity.

4. Repackage workflow.jar with the updated InboxResources.properties file.

5. Replace the existing workflow.jar file with the modified workflow.jar file in the<Webtop_installation_directory>/WEB-INF/lib folder and/or <Taskspace_installation_directory>/WEB-INF/lib.

6. Restart the application server.

Note: The following specific notes are applicable to products listed in Table 12 with a Y* or Y:

• Business Activity Monitor, Document Image Services, Forms Builder, Process Builder, ProcessEngine, Process Integrator, and TaskSpace must be the same exact version (6.5, for example) aseach other and the Content Server, when all are using the same repository.

• When a later version of the Forms Builder, Process Builder, Process Integrator, or TaskSpaceclient connects to an earlier version of Content Server, the Process Engine installed on ContentServer must be of the same version as the client.

• Queue management is not supported when using a Webtop 5.3 SP6 client against a 6.x SPxContent Server in which the 6.x SPx BPM TBO has been installed.

• CIS 5.3 SP6 and 6.0 require the same exact version of Documentum Administrator. CIS 6.x SPxrequires Documentum Administrator 6.x SPx.

• The upgrade of CIS to version 6 SP1 or 6.5 on DA 6, or upgrade of CIS to version 6.5 SP2 or6.5 SP3 on DA 6 SP1 through 6.5 SP1 requires the update of the ci.jar file on DocumentumAdministrator (DA).

• The upgrade of Federated Search Services requires the update of xtrim-api.jar on Webtop.

• Documentum Composer 6.5 SPx on Content Server 6.5 SPx can use the same or earlier version ofContent Server if the Composer DAR file does not include a feature that is not available in thatversion of Content Server.



• Use the relevant Documentum Collaborative Services (DCS) 5.3x DocApps to upgrade a 5.3xinstallation or use the relevant DCS 6.x DARs to upgrade a 6.x installation on the repository.Alternatively, as a first time user you must ensure that the Collaboration Services.darand DCS Attachments.dar have been installed on the repository before you enable the DCSfunctionality for WDK-based applications. After the upgrade or installation procedure, ensure thatyou enable DCS in Webtop by configuring custom/app.xml or using Documentum Administrator.

• Ensure that the version of the Web Publisher application and the Web Publisher server files matchat any time. This also means that IDS/IDSx and Content Server are of the same version (there is nosuch restriction on Web Publisher Server files version).

• Import Manager can use earlier or later versions of Content Server if the version of DFC forthe specific version of Import Manager is installed on the same server as Import Manager andseparate from Content Server.

• Physical Records Manager, Records Manager, and Retention Policy Services must be the exactsame version (6.5, for example) as each other when all are using the same repository. Similarly,any other client (Webtop, for example) that interoperates with objects created by these products,must be at the same version.

• Please see Records Manager and Retention Policy Services Release Notes as certain functionalitymay not be present when using an earlier version of Content Server.

The IRM Services for Documentum product has different releases. The compatibility matrix forIRM Services for DCTM is available in Table 13.

Table 12. IRM Services for Documentum Compatibility against Content Server

Content ServerIRMServicesfor DCTM

DAVer-sion

CTSVersion

GlobalReg-istryVersion

5.3SP6

6 6SP1

6.5 6.5SP1

6.5SP2

6.5SP3

1.0 NA NA NA Y NA NA NA NA NA NA

6.0.1 NA NA NA N N Y NA NA NA NA

6.5 SP1(Windows)

NA NA NA N N Y N Y NA NA

6.5 SP1(SOLARIS- SPARC)

NA NA NA N N N N Y NA NA

6.5 SP2(WIN-DOWS,SOLARIS- SPARC)

NA NA NA N N Y N Y Y NA

6.5 SP3(WIN-DOWS,SOLARIS- SPARC)

NA NA NA N N N N Y Y Y



Since the Documentum Compliance Manager product was released for 5.3 SP4 and later for 6.x.x,Table 14 lists compatibility data specific to DCM only.

Table 13. Documentum Compliance Manager Compatibility against Content Server

Content ServerDocumentumComplianceManager

DAVersion

CTSVersion

GlobalRegistryVersion

5.3SP4

5.3SP6

6 6SP1

6.5 6.5SP1

6.5SP2

6.5SP3

5.3 SP4 NA NA NA Y NA Y Y N N N N

6 NA NA NA NR NR NR NR NR NR NR NR

6 SP1 NA NA NA NR NR NR NR NR NR NR NR

6.5 NA NA NA N NA N Y Y Y Y Y

6.5 SP1 NA NA NA N NA N Y Y Y Y Y



Cross-product dependenciesNote: EMC recommends that you use DARs instead of DocApps whenever possible.

Webtop, Digital Asset Manager

The WDK-based application WAR file contains scripts to upgrade a 5.3 SP2 (or greater SP) repositoryfor subscriptions. Run the DQL script subscriptionInstall.dql that is located under the root webapplication directory, in webcomponent/install. Taxonomy Manager support scripts are located inthe directory webcomponent/install/admin/tm.


Chapter 5Migrating Content Server

If you are installing a new instance of Content Server 6.5 and migrating data from a previous versionon a separate host, you need to follow a procedure somewhat different from an upgrade.

This chapter addresses any variation from the basic scenario to known issues surrounding theconfiguration of your version 6.5 server.• Rebuilding or upgrading fulltext indexes, page 88

• Configuring login tickets for backward compatibility, page 88

• Using DQL to migrate content to an XML Store, page 89

• Migrating custom Content Server methods, page 89

• Migrating DocApps and BOF2 modules, page 89

Migrating Content Server version 5.3 or 6 to 6.5 occurs in three phases:• Back up your existing data.

• Run the version 6.5 installer.

• Configure the new Content Server to use your existing repository.

These are the recommended steps for preparing and migrating your version 6 Content Server toversion 6.5.

Table 14. Steps to migrate the Content Server from version 6 to version 6.5

Step Documentation

1. Back up your repository. Several third-party tools are available forbackup.

2. Clean up your repository. Content Server Administration Guide, ContentRepositories chapter, "Cleaning up repositories.”

4. Run the Consistency Checker utility. Content Server Administration Guide, Tools andTracing chapter, "Consistency Checker.”

5. Fix any errors identified by the ConsistencyChecker.

6. Back up your cleaned, consistent repository.


Migrating Content Server

7. Install Content Server. See Content Server Installation Guide.

8. Configure Content Server to use your existingrepository.

See Content Server Installation Guide.

Rebuilding or upgrading fulltext indexesIf you are migrating from version 5.2.5 to version 5.3, then to version 6.5, you need to rebuild thefulltext index only once, when you move to 5.3. You do not have to rebuild fulltext indexes when yousubsequently migrate from 5.3 to version 6.5.

If you are upgrading from 5.3 or 5.3 SP1, you need to rebuild your fulltext indexes.

If you are using fulltext indexing, are upgrading from 5.3 SP2 or SP3 and have applied the Get Well4.3.1 hot fix, or you are upgrading from 5.3 SP4 or later, you do not need to rebuild your fulltextindexes to migrate to version 6.5.

Refer to the Content Server Administration Guide for fulltext rebuilding and upgrade procedures.

Configuring login tickets for backwardcompatibilityIn an environment that includes mixed versions of Content Server, the login tickets generated bya particular Content Server might not be accepted by a Content Server at another version level. Aversion 6.5 Content Server can accept a login ticket generated from any Content Server, regardlessof the server’s version level. A pre-5.3 SP4 Content Server cannot automatically accept login ticketsgenerated by a Content Server at version 5.3 SP4 or higher. Also, a 5.3 SP4 or 5.3 SP5 Content Servercannot automatically accept login tickets generated by a version 6.5 Content Server.

When you are upgrading a production environment with multiple repositories or multiple ContentServers for one repository, there will likely be intervals when the Content Servers are at differinglevels.

To ensure that login tickets generated by a Content Server are backward compatible, set theserver_login_ticket_version key in the server.ini file:• Set the key to 1 to generate login tickets acceptable to a pre-5.3 SP4 Content Server

This setting is only valid on versions 6.5, 5.3 SP4, and 5.3 SP5 Content Servers.

• Set the key to 2 to generate login tickets acceptable to a 5.3 SP4 or 5.3 SP5 Content Server

This setting is only valid on version 6.5 Content Servers.

• Set the key to 3 to generate login tickets acceptable to version 6.5 Content Servers.

This setting is only valid on version 6.5 Content Servers.

The key defaults to 3 if not set.



Using DQL to migrate content to an XML StoreYou can migrate XML files from an existing Documentum file store to an XML Store, between XMLStores, and out of an XML Store using an update DQL query. To migrate:• Run DQL Query as UPDATE dm_sysobject OBJECTS set a_storage_type = ’xhive_store_01’ wherea_storage_type = ’filestore_01’ and a_content_type = ’xml’

Note: This procedure migrates only the current version of the object.

Migrating custom Content Server methodsAfter Content Server upgrade, you must run the configurator tool to configure the internal Javamethod server. The configurator will write the location of your Java methods to the internalmethod server. The location of the methods directory is written to the file web.xml in the methodserver deployment directory, for example, C:\Documentum\jboss4.2.0\server\DctmServer_MethodServer\deploy\ServerApps.ear\DmMethods.war\WEB-INF:<init-param><param-name>methodlocation-1</param-name><param-value>C:\Documentum\dba\java_methods</param-value>

</init-param>

Your custom Content Server methods located in %DOCUMENTUM%\dba\java_methods (Windows)or $DOCUMENTUM/dba/java_methods (UNIX and Linux) will continue to work. If you aremigrating to a new Content Server installation, copy the methods from this directory to the samefolder location in the new Content Server installation.

Migrating DocApps and BOF2 modulesBOF version 2 modules and DocApps do not need to be changed when you upgrade a ContentServer 5.3.x or 6.0 to 6.5. If you want to make changes to a DocApp or module on an upgraded 6.5Content Server, create a project in Composer and add your BOF2 modules or DocApp. Refer toDocumentum Composer User Guide for full instructions on working with modules and DocumentumArchive (DAR) files.

Use the Composer project migration utility to migrate a DocApp or a DocApp archive to a DAR file:New > Project > Documentum Project > Documentum Project from Repository DocApp. Composerwill generate a DAR file that can be installed in a new instance of Content Server or edited in placein an upgraded Content Server instance. Complete instructions are in the "Migrating DocApps”chapter of the Composer User Guide.



If you want your version 6.5 BOF2 modules to be used by DFC 5.3 clients, you need to:1. Compile them for a Java 1.4.x target <javac target=1.4> to make them compatible with older

virtual machines.

2. Compile them against DFC 5.3 rather than DFC 6.5 to ensure they do not accidentally referencenew interfaces.

To migrate custom Business Objects in an environment of 5.3 SP6 clients that access a version 6.xContent Server, do the following:• SBO

Install your 5.3 DocApps in the 5.3 SP6 global registry. Do not upgrade this global registry.

• Module or TBO

Make sure your code will work with DFC 5.3 SP6. It must compile with JDK 1.4.2 and must notuse any classes or methods that are new in DFC 6.x.


Chapter 6Migrating DFC Customizations

The Documentum Java-Com Bridge (DJCB) and Primary Interop Assembly (PIA) are deprecatedas of version 6.

The following topics describe how to migrate customizations of DFC to version 6.5.

Java class changesNew classes, methods and class members as well as changed or deprecated methods and membersare documented in diff files available on Powerlink with the current migration guide. There are diffsets comparing DFC classes of version 5.3 SP6 to 6.5 or later, and 6.0 SP1 to 6.5 or later.

Configuring DFC for native IPv4 operationsSince: version 6.5

To configure DFC installed on a dual-stack machine for native IPv4 operation, perform the following:Mitem• Specify a host with an IPv4 address in the dfc.properties file as the value of dfc.host.name.

• Disable the dual-stack operation for Java Virtual Machine.

A custom property setting in the Java Virtual Machine determines the communications protocolused by the operating system. By default, this custom property (java.net.preferIPv4Stack) isset to False to support dual-stack communications. To configure a host for native IPv4, set thisproperty to True.


Migrating DFC Customizations

Migrating customizations to Business ObjectsSince: version 6

The Business Object Framework (BOF) provides a framework for your customizations that can beaccessed from various client applications and service-based architecture. The following kinds of DFCcustomizations should be migrated to Business Objects:• Core custom action execution logic

• Process automation, for example, creating renditions during checkin, creating workflows aftercheckin

• Custom data handlers

• Helper methods in utility classes, for example, attaching or detaching a lifecycle, promoting ordemoting a document

• Business validation, for example, permitting an export operation

Examples of BOF classes

Updating attributes of an object based on its location — Generally, you organize documents in ameaningful folder hierarchy. You can also set one or more attributes on an object based on thelocation in which it is imported or created. The BOF module contains a type-based business object(TBO) that sets the attribute after the operation, based on the parent folder.

Attaching a lifecycle during a checkin operation — A service-based business object (SBO) can beused to perform an operation after checkin, such as attaching a lifecycle. Other possible operationsinclude promoting a workflow or creating a rendition.

Migrating DMCL API calls to DFC API callsSince: version 6

The C++ DMCL API has been replaced with the Java-based DFC API. These core changes, whileextremely significant, are largely transparent to the DFC user. C++ applications that interact directlywith the DMCL continue to work as a copy of DMCL continues to be provided. New Documentum 6features are not available through DMCL, however.

For a map of DMCL APIs to DFC APIs, refer to Appendix A, Migrating DMCL APIs to DFC.

Search serviceThe DFC search service replaces prior mechanisms for building and running queries. You can use theIDfQuery interface, which is not part of the search service, for simple queries.

The search service provides the ability to run searches across multiple Documentum repositoriesand, in conjunction with the Documentum Federated Search Services (FS2) product, externalrepositories as well. The Javadocs for the com.documentum.fc.client.search package describe howto use this capability.



Full format specifications no longer acceptedSince: version 6

DFC methods such as setFile that previously accepted a full format specification no longer do so.Those methods accept only a format name, such as txt or word, for the format argument.

Character string handling improvedSince: version 6

In previous releases, if you attempted to set a character string property with a value that exceededthe defined length of the property, DFC quietly truncated the value to the maximum length ofthe property and then set the property. For Documentum 6, DFC throws an exception instead oftruncating the value and setting the property.

To use the pre-Documentum 6 behavior, set the dfc.compatibility.truncate_long_values property indfc.properties file to T. This property is false by default.

Aspects, a new BOF module type fordevelopersSince: version 6

Documentum 6 supports aspects, a new framework for extending object behavior and attributes.Aspects are a type of BOF entity that can be dynamically attached to object instances in order toprovide fields and methods beyond the standard ones for the object type. The extended behaviorcan include functionality that applies to types across the object hierarchy. For example, an aspectcould label objects as retainable or web-viewable, and this single aspect could be applied to multipledistinct object types.

Aspects can speed development and improve code reuse, because the extended attributes andbehavior do not alter the underlying type definitions. You can create aspects and associate themwith an individual object or an object type. If you associate them with an object type, the aspect isautomatically associated with each new object of the specified object type. Aspects can also haveproperties defined for them. Properties defined for an aspect appear to users as if they are definedfor the object type of the object to which the aspect is attached.

JMX management of DfPreferences anddfc.propertiesIn J2EE DFC-based applications, active settings in DfPreferences and persistent settings indfc.properties are managed by JMX agent and Managed Bean (MBean) components. The settings are



displayed in Documentum Administrator, which separates active settings (in DfPreferences) frompersistent settings (in dfc.properties).

DFC deploymentDFC is deployed with each application or product that requires it, using a standard J2EE deploymentstrategy. In the J2EE deployment process, the dfc.jar file and related files are packaged in a product’sWAR file so that each DFC instance can have its own DFC configuration.

Configuration for application access controltokensIf you are using application access control tokens configured to be valid only when sent fromapplications on particular host machines, you must set the dfc.machine.id key in the dfc.propertiesfile used by those client applications. Set the key to the machine ID of the host from which theAAC token is sent.

Setting the maximum number of results persourceThe maximum number of results to retrieve per source by a query search is set in the parametermaxresults_per_source of the DFCfull.properties as follows:dfc.search.maxresults_per_source=350


Chapter 7Migrating WDK and WebtopApplications

The following topics describe how to migrate your customizations to WDK or Webtop 6.5:• Overview, page 95

• Updating and migrating email messages, page 96

• Java class changes, page 97

• Application framework changes, page 97

• Application-wide changes, page 104

• Content transfer changes, page 130

• Style changes, page 135

• Feature changes, page 136

The migration topics are ordered by release version, with the latest release changes first.

OverviewDeploy and configure applications based on WDK or Webtop 6.5 on an application server instancedifferent from your existing installation and then migrate any customizations to the 6.5 deployment.Do not migrate any of your existing customizations that new 6.5 functionality can replace. To enablefull 6.5 functionality, you will also need to upgrade the DocApps/DARs in the repositories (includingglobal registries) that your WDK application accesses. For more information, refer to Chapter 5,Migrating Content Server.

Effort estimates are based on the average time to perform a configuration (simple effort, measured inhours) or a custom class (complex effort, measured in days). For multiple customizations of the sametype, multiply the effort estimate by the number of customizations to migrate. For example, if youhave five custom actions for which to add shortcuts, you multiply the simple effort times 5. It is hardto give an exact time estimate, because it is based on your engineers’ familiarity with WDK and thescripting or programming tasks required to perform the configuration or customization.


Migrating WDK and Webtop Applications

To migrate WDK and Webtop applications from version 5.3 or 6.0 to 6.5:

1. Back up your customizations, if you have made changes in any of the following:• Web application customizations:

— APP_SERVER_ROOT/webtop/custom directory

— Compiled custom classes in APP_SERVER_ROOT/webtop/WEB-INF/classes directory

— Custom tag libraries in the

APP_SERVER_ROOT/webtop/WEB-INF/tlds directory

SeeWeb Development Kit and Webtop Deployment Guide.

• Application server startup file

Note: Do not migrate settings that the WDK installer added to your application serverstartup file.

SeeWeb Development Kit and Webtop Deployment Guide.

2. If you have a DFC 5.x application running in the same instance as your 6.5 application, youmust uninstall the DFC 5.x application. For uninstall procedures, refer to the 5.x productdocumentation—specifically, theWeb Development Kit and Webtop Deployment Guide.

3. If necessary, update your application server software.Refer to the supported application servers in the release notes for the WDK-based product.

4. Make the required setup changes to your Webtop WAR file, then deploy the Webtop WAR file.SeeWeb Development Kit and Webtop Deployment Guide.

5. Copy the contents of your previous /custom directory, to the /custom directory on your newserver. Copy custom Java classes and TLDs to the WEB-INF folder on your new server.

6. Recompile your custom 5.3 classes to ensure that the custom code still works.

7. Migrate your customized features if they are not present in the 6.5 application. Disable any newfeatures that conflict with your customizations.Migration is described elsewhere in this guide.

8. Test and fix your web application.

9. Deploy your web application to your production application server.SeeWeb Development Kit and Webtop Deployment Guide.

Note: Only selected versions of Content Server and WDK-based applications are forward orbackward compatible with each other.

For more information, see Forward and Backward Compatibility Notes, page 41.

Updating and migrating email messagesWebtop 6.5 or later and Documentum 5.3, 6.0, and 6.5 or later repositories can now supportdm_message_archive objects in the proprietary EMCMF format. This format encapsulates thecontent, metadata, and attachment information as a single unit of information.



The following features have been enhanced to support the EMCMF format:• Import: When a user imports an email message (.msg), the email message converts to EMCMFformat and is stored as a dm_message_archive type. All attachments in the email are importedand related to the email.

• Export: When a user exports an EMCMF object, the object converts to native email format (.msg)for viewing by Microsoft Outlook.

• View Properties and Listing pages: The Properties and Listing pages have been enhanced to showemail-centric attributes such as To, From, Date Sent and Subject.

• Transform: EMCMF messages can be transformed to HTML, XML, or PDF.

Existing email messages of the dm_email_message object type (and its subtypes) and the msg formatmust be migrated to the dm_message_archive type (EMCMF) or one of its subtypes. In addition,from 6.5, the dm_message archive message_id attribute has been lengthened from 24 to 42 characters.

EMC Documentum provides utilites to perform the migration of dm_email_message objects todm_message_archive objects. For instructions on running these utilities, refer to Webtop EmailMigration Guide.

Java class changesNew classes, methods and class members as well as changed or deprecated methods and membersare documented in diff files available on Powerlink with the current migration guide. There are diffsets comparing WDK and Webtop classes of version 5.3 SP2 to 6.5 or later, 5.3 SP6 to 6.5 or later, 6.0 to6.5 or later, and 6.0 SP1 to 6.5 or later.

Application framework changesThis section describes changes that affect how you design your custom application. These changesmay not require migration, but migration is recommended to benefit from these improvements inapplication design support.

Configuring new accessibility features and timeoutwarnings

Since: version 6.5 SP1

Effort: moderate configuration, multiple JSP pages unless otherwise noted

Several enhancements to the WDK infrastructure support accessibility and section 508 compliance.Your customizations should take advantage of these additions if your application is compliant withsection 508.

Autofocus — The form tag has an attribute "autofocusneeded” that causes the first focusable controlon the page to receive focus. By default this attribute value is false, since all forms in a multi-frame



view cannot have focus. Set to true for the frame that should receive focus. For example, in Webtopthe JSP page app_general_preferences_ex.jsp calls for autofocus, so that when the preferencescomponent is launched from the titlebar component, the general preferences tab receives focus:<dmf:form autofocusneeded=’true’>

Enhanced control labels — When a control receives focus, the tooltip or tooltipnlsid attributesrender the HTML title attribute. If this information is not sufficient for the screen reader, additionalcontext can be provided by a label tag that is associated with the control that needs context. Specifythe label using the associatedcontrolid attribute on the context control. In the following example, alabel control specifies the text for which it provides information:<dmf:label nlsid="MSG_NAME" associatedcontrolid="object_name"/><dmf:text id="object_name" tooltipnlsid="MSG_NAME_DESCRIPTION"/>

Radio, link, datasortlink, datadropdownlist, and checkbox controls can also have a prefix and/orpostfix label to provide context. For these controls, the prefix or postfix label is specified as anattribute on the control itself. In the following example, each radio control specifies a prefix label thatprovides additional context:<dmf:label nlsid="MSG_APPLICATION"/><dmf:radio nlsidid="MSG_APP_1" prefixassociatedlabelnlsid="MSG_APPLICATION_1"NAME="app1" GROUP="theme"/>

<dmf:radio nlsidid="MSG_APP_2" prefixassociatedlabelnlsid="MSG_APPLICATION_2"NAME="app2" GROUP="theme"/>

Note: The context label associated with a control will override any tooltip or tooltipnlsid setting.

The sortablelistbox control has three tooltips for the Up, Down, and Remove buttons that enhanceaccessibility.

Accessible checkboxes — Effort: none

In accessibility mode, the actionmultiselectcheckbox control renders an Actions link that displaysthe available actions.

Datagrid row information — The actions link in a datagrid row can describe possible actions. Youcan configure which information about the object in the row is displayed. By default, the object name,data type, and lock status are added to the title of the actions link in that row. Other columns can beadded using the columnsforaccessibility attribute of datagridRow tag. In the following example, thename is displayed instead of the object name:<dmf:datagridRow ... columnsforaccessibility="name">

Import files added or deselected — Effort: simple, single JSP page

The fileselector applet has the accessibilityalertsneeded attribute. When set to true, an alert isdisplayed when the user selects or removes files from the list of files to be imported.

Timeout alert — Effort: simple, single XML file

A timeout warning can be configured to warn the user before a timeout occurs. After the timeout, theusre is informed that the application has timed out, and then the user is redirected to the login pageor last active page if the user’s credentials are saved.

Session warning before timeout is configured in app.xml using <client_warning_session_timeout>.The following example displays a warning five minutes before timeout:<session_config><timeout_control>



...<client_warning_session_timeout>5</client_warning_session_timeout>

</timeout_control></session_config>

You can exclude pages from displaying a timeout warning in the <timeout_exclude_list> element. Inthe following example, the login page is excluded:<session_config><timeout_control>...<timeout_exclude_list><exclude></exclude>

</timeout_exclude_list></timeout_control>

</session_config>

Migrating scoped configurations to presets

Since: version 6

Effort: moderate based on number of configurations replaced, presets editor UI

Presets can be used to replace many customizations that deliver context-sensitive functionality tousers based on scopes such as user, group, role, folder location, or object type. Presets are appliedduring runtime, unlike configuration files, which are defined before deployment. Presets takeprecedence over scopes that are defined in configuration files.

If your customizations use qualifiers (scope elements), you can replace them with presets usingthe presets editor in Webtop. To enable a user for the presets editor, add the user to the presetscoordinator role.

With presets, you can restrict the UI and behavior in the following ways:

• Restrict actions that are available to specified users, roles, or locations

For example, you can restrict import to a particular folder.

• Set default values for attributes

Default values in presets take precedence over default values in the data dictionary.

• Restrict the object types and formats that are available for creating or importing

• Restrict the workflows, lifecycles, and templates for a group or role

• Restrict the columns that are displayed in listing pages

• Restrict the nodes in the browsertree to certain users

Presets can be used for many of the UI enhancements that were performed using XML configurationfiles in prior releases. Before migrating your customizations, check the presets editor to see if yourcustomization can be accomplished using presets. Presets offer significant benefits in terms offlexibility and maintainability.

Presets are limited to those that can be defined in the presets editor UI. Presets should not a used toset security or access to objects. For information on using presets, see theWebtop User Guide.



A new UserQualifier was added to webtop/app.xml to support presets targeted to individual users.

Deployment model changed

Since: version 6

Effort: simple to moderate

In WDK 5.x, the web application was installed by an installer that also installed DFC. In WDK 6.xapplications, the web application is deployed by the standard J2EE method: as a WAR file. DFC iscontained within the WAR file, and more than one DFC-based application of different DFC versionscan run on the same host if they do not run in the same application instance.

On a Windows system, if DFC version 5 loads first because it is launched by a 5.x application, it willinterfere with applications running DFC 6. In this case, you must uninstall the DFC 5.x applicationand DFC 5.x itself.

If a version 5.x DFC-based application such as Webtop is running in the application server, theapplication server startup file or Windows service has been modified by the DFC installer to load DFClibraries. You must run the 6.x application in a different application server instance with the standardstartup file (not modified by a Documentum installer). On a Windows host, you must make sure thatthis new instance is not started by a Windows service that has Documentum-specific libraries loaded.

Migrating configuration extensions to modifications

Since: version 6

Effort: moderate configuration, multiple XML pages

In earlier versions of WDK, XML configuration elements had to be overridden in their entirety. Thismade applications difficult to maintain with a newer version. Each customized application requiredits own WDK stack.

With configuration modifications, you can merge XML into an existing configuration file. Theseelements modify rather than override target elements in configuration files. The followingmodifications can be made on the referenced configuration definition: insert, insertbefore, insertafter,replace, and remove.

The following example inserts a node in the browsertree and removes another node.<scope role ="CSI_Investigator"><component modifies="browsertree:webtop/config/browsertreeex.xml"><insertbefore path="nodes.docbasenodes.node[componentid=homecabinet_classic]><node componentid="investigations">

</insertbefore><remove path="nodes.docbasenodes.node[componentid=administration]"/></remove>

</component></scope>

For full details on extending and modifying configuration files, refer toWeb Development Kit andClient Applications Development Guide.



Migrating JSP menus to XML menus

Since: version 6.5

Effort: moderate configuration, multiple XML files and custom JSP pages

Fixed menus are no longer in JSP pages. They are specified and configured in XML. This allowsyou to scope and modify XML-based menu definitions. JSP-defined menus are still supported forbackward compatibility.

Actions can be grouped into menus so the set of actions available on a particular object type, userrole, or other qualifier is specified in a single location. Menus can be defined in the JSP page using<dmf:menu> tags or in a menu configuration file using <menu> elements. The latter type of menu ispreferable because you can extend it and reuse it. This topic describes configuration file menus only.Individual JSP page menus are supported for backward compatibility.

A menu is defined in a menu configuration file. This menu is included in a JSP page by its id attribute.In the JSP page, a dmfx:menuconfig tag references the menu, similar to the following:<dmfx:menuconfig id=’my_menu’ />

The menu configuration file for this menu has an id that matches the configid attribute on the menutag. In the following configuration file, two menus are defined: my_menu and 222_menuconfig. Thesecond menu is included as a submenu within the top-level menu:<config><scope><menuconfig id=’my_menu’><menuitem name=’aaa’ label=’Do A’/><menu id=’111’ name=’111’ label=’B menu’>

<menuitem name=’b1’ label=’Do B1’ onclick=’event_handler’/><actionmenuitem name=’b2’ label=’Do B2’ action=’some_action’/>

</menu><menuconfig id=’222_menuconfig/>

</menuconfig>

<menuconfig id=’222_menuconfig’><menu id=’222 name=’222’ label=’C menu’><menuitem name=’ddd’ label=’Do C’/>

</menu></menuconfig>

</scope></config>

This example generates a menu with the following hierarchy:

Do A B menu C menu (included menu)

Do B1 Do C

Do B2

The <menuconfig> element defines a menu that can be included within another <menuconfig> orreferenced in a JSP page. In the example above, an empty <menuconfig> element is used to includethe ’C menu’ within the top-level ’my_menu’. The ’C menu’ can also be used separately in anothercomponent because it is in a <menuconfig> element.

The elements in a menu configuration file, except the <menuconfig> element, generate JSP tagswith the same name. Attributes on the configuration element are generated as attributes onthe tag. For example, <menuitem name=’file_help’ nlsid=’MSG_HELP’ onclick=’onClickHelpr’



runtatclient=’true’/> generates the JSP tag <dmf:menuitem name=’file_help’ nlsid=’MSG_HELP’onclick=’onClickHelp’ runatclient=’true’/>. Just as for JSP tags, the nlsid key overrides a hard-codedlabel in the label attribute. NLS values are retrieved from the nls bundle of the component thatcontains the menu. If the menu item keys are not found in the bundle, then they are retrieved fromthe menu NLS bundle specified in custom/app.xml as the value of <menu>.<nlsbundle>.

Table 15, page 102 describes the elements in a menu configuration file that can be used to generate amenu.

Table 15. Menu configuration elements

Element Description

<menuconfig> Defines a top-level menu. Contains at least one<menu> or <menuconfig> element. Has an idattribute that is used to include the menu intoanother menu or a JSP page.

<menu> Defines a menu. If within a <menu> element,it defines a submenu. Can contain anycombination of <menu> elements, which serveas submenus, <menuitem>, <actionmenuitem>,and <menuseparator> elements. Has the sameattributes as the dmf:menu JSP tag.

<menuitem> <menuitem> has the same attributes of thedmf:menuitem control. The name attribute isrequired. The menu item will not do anythingunless you set a value for the onclick attribute.

<actionmenuitem> <actionmenuitem> has the same attributes asthe dmfx:actionmenuitem control. The actionattribute is required and specifies the actionthat is launched by the menu item. The actionmust match the ID of an action definition in theapplication.

<menuseparator> Generates a separator in the menu. Has thesame attributes as dmf:menuseparator.

Menus can be extended and modified using the WDK configuration mechanism. Refer toWDKDevelopment Guide for information on how to extend a menu configuration or how to insert, remove,or override a menu item.

Tip: If you are reusing a menu in more than one component, put the menu into a <menuconfig>element. If you are making simple modifications to a WDK menu you will not be reused in othercomponents, insert menu elements into the <menuconfig> element or its child elements using the



modification mechanism. In the following example, the sample menu above is modified by insertinga menu item labeled Do X between Do B1 and Do B2.<menuconfig modifies="my_menu:custom/config/mycomponent.xml"><insertafter path="menu[id=111].menuitem[name=b1]">

<menuitem name="xxx" label="Do X" onclick="do_something"/></insertafter>

</menuconfig>

To convert a JSP menu to an XML menu

1. Remove the tags contained within the dmf:menu tag on the JSP page.

2. Change the dmf:menu tag to dmfx:menuconfig tag with an id attribute value that references theid of the <menuconfig> element in the menu definition that you will create.

3. Create the menu definition in an XML file with the primary element <menuconfig>.

4. Replace each dmf:menu JSP tag with a <menu> element.

5. Within the <menu> element, eplace each dmfx:actionmenuitem tag from the JSP menu withan <actionmenuitem> elemen. Replace each dmf:menuitem and dmf:menuseparator tag with<menuitem> and <menuseparator> elements as described in Table 15, page 102.Set the JSP tag attributes on the corresponding XML elements that replace them.

6. For each JSP menu item that is wrapped with a dmf:clientenvpanel tag, wrap the menu itemelement in the XML definition with a corresponding <filter> tag. The following example fromthe 5.3.x Webtop menubar_body.jsp page hides the New Process action menu item in the portalenvironment:<dmf:menu name=’file_new_menu’ nlsid=’MSG_NEW’>...<dmfx:clientenvpanel environment=’portal’ reversevisible=’true’><dmfx:actionmenuitem dynamic=’genericnoselect’ name=’file_newprocess’ nlsid=’MSG_NEW_PROCESS’ action=’newprocess’ showifinvalid=’true’/>

</dmfx:clientenvpanel>...

This menu item would be defined as follows:<menu id=’file’ nlsid=’MSG_NEW’>...<filter clientenv=’not portal><actionmenuitem dynamic=’genericnoselect’ name=’file_newprocess’ nlsid=’MSG_NEW_PROCESS’ action=’newprocess’ showifinvalid=’true’/>

</filter> ...</menu>

The menubar component allows you to specify all of the menus in the application menubar. Extend the Webtop menubar component and specify the menuconfig IDs for eachmenu that should appear in the menu bar. For example, the Webtop menubar definitionin webtop/config/menubar_component.xml inherits the following menuconfig IDs from thewebcomponent menubar definition:<menuconfigids><id>menubar_file_menu</id><id>menubar_edit_menu</id><id>menubar_view_menu</id><id>menubar_tools_menu</id><filter entitlement="recordsmanager"><id>menubar_rpm_menu</id>



</filter></menuconfigids>

The following example in a custom menubar component definition modifies the menu to add amenu item at the end:<component id="menubar" modifies="menubar:webtop/config/menubar_component.xml"><insert path=’menuconfigids’>

<id>menubar_mymenu</id></menuconfigids>

</component>

Application-wide changesThe following topics describe features that appear in many places in the application. You can changethe support for these features by configuration, as described in each migration topic.

Placing a custom component in a modal pop-up dialog

Since: version 6.5

Effort: moderate to complex, depending on where events are handled, multiple XML files andpossibly component classes

A custom component can be configured to display within a modal pop-up dialog. A modal pop-updialog is a child window which requires the user to interact with it before they can return to theparent application. This feature enhances performance and allows the user to see the context fromwhere the action was launched. By default components are displayed within the main window unlessthey are configured to use a modal pop-up window.

Disabling modal pop-up dialogs — Modal pop-up dialogs are enabled by default. They can bedisabled in app.xml by setting the <enabled> element to false:<modalpopup><filter clientenv=’webbrowser’><enabled>false</enabled>

</filter>...

</modalpopup>

Defining the available pop-up windows

Modal pop-up windows are defined in app.xml within each <theme> element. The<theme>.<windowsizelist> element contains one or more windows defined by three child elements:<name>, <width>, and <height>, the latter two in pixels.



For example, the small window is defined as follows:<windowsize><name>small</name><width>400</width><height>330</height>

</windowsize>

Invoking a modal component in a pop-up window

Invoking a modal component launched by an action — The action that invokes the modalcomponent must be configured to use a modal pop-up. Add an <invocation> element to the actiondefinition to specify the pop-up. In the following example, the action action definition launches theabout component in a small pop-up window that does not refresh the parent window when themodal window closes. (The default is to always refresh unless otherwise specified.) The value of the<windowsize> element must match a defined window in app.xml.<action id="about">

<params>...</params><execution

class="com.documentum.web.formext.action.LaunchComponent"><component>about</component>

</execution><invocation>

<modalpopup><windowsize>small</windowsize><refreshparentwindow>never</refreshparentwindow>

</modalpopup></invocation>

</action>

Invoking a modal component launched by an event handler — If a component is launched by acontrol event handler, you must add event arguments to the control, either in the JSP page, in theserver code that generates the control, or in the client event handler:• In a JSP page:

<dmf:link cssclass="miniButton" onclick="onBrowseLocations"nlsid="MSG_CHANGE_LOCATION" name="locationlink">

<dmf:argument name="usemodalpopup" value="true"/><dmf:argument name="modalpopupwindowsize" value="large"/><dmf:argument name="refreshparentwindow" value="onok"/>

</dmf:link>

• In a server-side event handler, with the Control method addEventArg:LinkTag linkTag = new LinkTag();linkTag.setPageContext(pageContext);linkTag.setName(ctrlName);linkTag.setLabel(ctrlLabel);linkTag.addEventArg("usemodalpopup", useModalPopup);linkTag.addEventArg("modalpopupwindowsize", modalPopupWindowSize);linkTag.addEventArg("refreshparentwindow", refreshParentWindow);

• In a client event handler:function onClickPreferences()beginModalPopupMode("content", null, "large", "onok");<%if (MainEx.isStreamlineViewVisible() == false)



%>postComponentNestEvent(null, "preferences", "content","component", "general_preferences");<%else

%>postComponentNestEvent(null, "preferences", "content","component", "general_preferences", "preferredVersion","<%=MainEx.STR_STREAMLINEVIEW_VISIBLE_CFG_VERSION%>");<%

%>

beginModalPopupMode arguments are as follows— strFrameName: Frame in which the postServerEvent method is invoked. If null, the currentframe is used.

— strFormId: ID of the form. If null, the first form in the frame is used.

— strPopupWindowSize: Size as defined in app.xml.

— strRefreshParentWindow: Specifies whether to refresh the parent window when the modalwindow closes.

Invoking a modal component to edit attributes — Editing components for attributes can belaunched in a modal pop-up dialog. Specify the modality in the docbaseobjectconfiguration file. Inthe following example, the versionlabels editor for the version label attribute is launched modally:<attribute name="r_version_label">

<valuehandler>com.documentum.web.formext.control.docbase.DocbaseAttributeVersionLabelSetValueHandler

</valuehandler><editcomponent>versionlabels</editcomponent><invocation>

<modalpopup><windowsize>small</windowsize><refreshparentwindow>onok</refreshparentwindow>

</modalpopup></invocation>

</attribute>

You can also specify multiple modal pop-up window sizes in app.xml. Compare your customcomponents to the corresponding 6.5 components to determine whether you want to include themodal pop-up dialog elements in your custom component.

Refreshing the parent window

There are three options for refreshing the parent window. The refresh setting can be specified withinthe action definition or event handler argument. Use one of the following settings:• always

The framework always refreshes the parent window when the child window is closed.



• onok

The framework refreshes the parent window when the child window is closed and the returnvalue is not null. If the user cancels the modal dialog, no refresh occurs. The component developermust ensure that there is a return value when the component closes.

• never

The framework never refreshes the parent window when the child window is closed.

Creating an action postprocessor for actions that sometimesrequire modal windows

Effort: complex, custom class

An action may require a modal window for some conditions and not for others. For example,the view action for dm_document objects uses a modal window, but for virtual documents amodal window should not be used. In this case, the action registers a postprocessor in app.xml,in the <modalpopup>.<actioninvocationpostprocessors> element. The action service checks for apostprocessor, instantiates it, and calls its getModalPopupProperties() method to overwrite thedefault modal popup settings for the action. You can overwrite use modal, modal window size, orrefresh parent window after closing.

The postprocessor is registered with the following syntax:<postprocessor id="uniqueId" action="yourAction" class="YourActionInvocationPostProcessor"/>

In the example of the view action, the action and postprocessor class are as follows:<postprocessor id="viewvdm" action="view" class="com.documentum.web.formext.action.ViewActionInvocationPostProcessor"/>

The postprocessor class implements IActionInvocationPostProcessor and checks whether the objectis a virtual document. If so, it overrides the modal behavior for the view, which was defined inthe view action definition:public ModalPopupProperties getModalPopupProperties(ModalPopupProperties modalPopupProp,ActionService.ActionDef actionDef, ArgumentList itemArgs)

boolean useModalPopup = actionDef.getUseModalPopup();if (itemArgs != null)if ("view".equals(actionDef.getActionId()) && isVirtualDoc(itemArgs))useModalPopup = false;

return new ModalPopupProperties(useModalPopup,modalPopupProp.getModalPopupWindowSize(),modalPopupProp.getRefreshParentWindow());



Using window.location.replace within a modal component

If your component executes the JavaScript function window.location.replace() API in a modal popupwindow, then you must change it to call navigateToURL(), a function in modal.js. For example, theloginRedirect JavaScript event handler in the timeout.jsp page of Webtop reloads the login pageas follows:function loginRedirect()...var strUrl = addBrowserIdToURL(g_virtualRoot+"/component/main");navigateToURL(strUrl, "timeout", targetWindow);...

Enabling and configuring IRM support

Since: version 6.5 SP1

Effort: simple, single XML fileSupport for rights management has been added to Content Serverand WDK applications. This feature provides additional persistent security for documents managedwithin a repository. Working with an IRM Server, Rights Management implements this securityby adding IRM profiles and IRM permissions.

By default, IRM support is not enabled in WDK applications. You must enable it in your customapp.xml by adding the following lines:<irm-support><enabled>true</enabled><ticket-timeout>2</ticket-timeout>

</irm-support>

Change the ticket timeout (minutes) to a setting appropriate for your network throughput.

When you enable IRM, Webtop displays an extra tree node called Rights Management under therepository node. Some IRM-specific menus for IRM protection and profiles are also displayed.

Enabling and configuring DCS support

Since: 6.5 SP2

Effort: Simple

Use the relevant Documentum Collaborative Services (DCS) 5.3x DocApps to upgrade a 5.3xinstallation or use the relevant DCS 6.x DARs to upgrade a 6.x installation on the repository.Alternatively, as a first time user you must ensure that the Collaboration Services.darand DCS Attachments.dar have been installed on the repository before you enable the DCSfunctionality for WDK-based applications. For more information about installing DARs, see theDocumentum Composer User Guide. After the upgrade or installation procedure, ensure that youenable DCS in Webtop by configuring wdk/app.xml. DCS can be enabled or disabled in Webtop bymodifying wdk/app.xml of your WDK application with the configuration described in this section. By



default, the DCS feature is disabled in the Webtop application. However, the performance of Webtopmay be impacted marginally after enabling DCS because Webtop will include the extra functionality.

Note: The DCS distribution also contains the collaboration.jar file. This JAR file containsinterface classes for users who want to write custom applications using DCS. This JAR file is not usedfor standard deployments.

To enable Documentum Collaborative Services

1. Open the app.xml file in the /wdk folder of your application.

2. Change the value of the <enabled> tag to true in the following <config> element:<collaborationsupport><enabled>true</enabled><collaborationsupport>

3. Save and close the app.xml file.

Note: You must follow the instructions provided in this section if the DCS DARs (CollaborationServices.dar and DCS Attachments.dar) or DocApps are not installed.

Notes for customers who have not installed DCS DocApps or DARs• Webtop 6.5 SP2 customers: Download the DCS-related DARs (Collaboration Services.darand DCS Attachments.dar) and install them on the repository. The collaboration features areturned on automatically on Content Server. No license key is required to enable DocumentumCollaboration Service. For information about installing DocApps or DARs, see the DocumentumComposer User Guide.

• All Webtop customers using a 5.3 repository or a repository that is earlier than 6.5 SP2: Installthe DCS DARs (Collaboration Services.dar and DCS Attachments.dar) or DocApps ifthey are not already installed on the repositories, and enable Documentum Collaboration Serviceon the Content Server using Documentum Administrator by providing the collaboration licensekey. For information about installing DocApps or DARs, see theDocumentum Composer User Guide.

Note: Users are recommended to install the DCS 6.5x DAR files instead of installing the 5.3x DocAppfiles, because several critical issues have been fixed in version 6.5.

Email conversion to EMCMF format

Since: version 6.5

Effort: simple, one or two XML files

For information on updating email messages to the new EMCMF format and enabling conversion ofmessages on import in WDK applications, refer to Updating and migrating email messages, page 96.

The following new actions and components have been created to display EMCMF email messages:• Import

emfimport is a new component in the import container. If you have customized the importcontainer, add this component to your custom importcontainer definition.



• Export (for example,

export (type dm_message_archive) is a new action. Requires no migration.

• View Properties and Listing pages

The attributes of type dm_message_archive are displayed. Requires no migration.

• Search

Search for type dm_message_archive are supported. Requires no migration.

Configuring inline refresh

Since: version 6 and 6.5

Effort: simple to moderate, single XML file and possibly multiple JSP pages

Webtop improves performance by reducing the amount of refreshes using the AJAX framework. Forexample, a user chooses a folder in the browser tree to view a list of content contained in the folder.Before Webtop 6, there was first a refresh of the browser tree control and then there was a refresh ofthe content list. In Webtop 6, there is no refresh of the browser tree.

Controls that refresh inline — Four controls have a new inlinerefresh attribute: tree andshowhide in dmform_1_0.tld and docbaseattributelist and multiobjectsdocbaseattributelist indmformext_1_0.tld. Refresh can be turned off by setting this attribute value to false in the JSP page(default is true).

Turning off inline refresh of the Webtop browser tree — The browsertree (version 6.0) Webtopcomponent is a new component, defined in webtop/config/browsertreex_component.xml.jumpToBrowserTreeLocationAction is a new action related to this feature. Custom browsertreecomponents should extend the browsertree component in webtop/config/browsertreeex_component.xml (new file).

You can turn off inline refresh by modifying classic.jsp in webtop/classic. Change from true to falsein the following line:String strBrowsertreeArgs = "?inlineRefresh=true";

Using the new showhide control — The showhide control, new in WDK 6.5, can replace existingrefresh features. For example, extendedpermissions.jsp in 5.3 used a link to reload the page when theuser clicked the link:...<dmf:link name=’<%=ExtendedPermissions.RESTRICTIONS_PERMIT_IMAGE%>’onclick=’onShowOrHideRestrictions’tooltipnlsid=’MSG_SHOW_RESTRICTIONS_TIP’/>

<dmf:link name=’<%=ExtendedPermissions.RESTRICTIONS_PERMIT_LINK%>’onclick=’onShowOrHideRestrictions’ cssclass=’showMoreHideMoreLink’tooltipnlsid=’MSG_SHOW_RESTRICTIONS_TIP’/>

In WDK 6.5, the links are replaced with a faster refresh through the showhide control:<dmf:showhide name=’restrictions_showhide’panelname=’<%=ExtendedPermissions.RESTRICTIONS_PANEL%>’shownlsid=’MSG_SHOW_RESTRICTIONS’hidenlsid=’MSG_HIDE_RESTRICTIONS’



showtooltipnlsid=’MSG_SHOW_RESTRICTIONS_TIP’hidetooltipnlsid=’MSG_HIDE_RESTRICTIONS_TIP’/>

The showhide control is associated with a panel control that is displayed when the user clicks Show.Specify the name of the associated panel in the panelname attribute of the showhide control.

Lightweight sysobject support

Since: version 6.5

Effort: simple to moderate, single XML file and possibly multiple JSP pages

Lightweight sysobjects (LWSOs) store metadata, common to many different (but similar) childobjects, at the parent object level. This dramatically reduces the storage footprint and ingestionprocessing required for the child objects.

With email archiving, individual emails can be grouped by user. Metadata common to all emailswould be stored at the parent (user) level. Thus the user would be the parent, and all of the user’semails would be the LWSO children.

The following 6.5 components have been changed to display LWSO features:• Browsing

When a user browses through cabinets and folders, he or she sees neither parents nor childrenassociated with LWSOs.

• Simple Search

When a user performs a simple search, the results display shared parent objects only. Children arenot displayed.

• Advanced Search

When a user performs an advanced search, the results display children, but NOT the parents,associated with LWSOs.

• Attributes

From search results, a user can open the properties of a LWSO and edit its properties. When anyattribute is changed, the LWSO materializes into a full object.

• Properties

Properties panels show all attributes associated with a child along with any attributes inheritedfrom the parent.

Displaying LWSO shared parent — To turn on the display of shared parents is listing and locatorpages, add the following lines to your custom app.xml file:<lightweight-sysobject><hide-shared-parent>false</hide-shared-parent>

</lightweight-sysobject>



Using strong encryption

Since: version 6

Effort: simple, XML files and Java utility

The TrustedAuthenticatorTool utility now encrypts passwords in the application using triple DESstrong encryption. An encryption and decryption key is generated for each user and is stored in akeystore file that can be secured using OS security. The location of the keystore is specified in aproperties file, and the encrypted password can be used for Java EE single sign-on, preferencesrepository user, and presets repository user. The encryption is also used to store user credentialswhen saved credentials are enabled.

Use the TrustedAuthenticatorTool tool to encrypt passwords for the drl, drlauthenticate, andvirtuallinkconnect components. You can also use this tool to encrypt passwords for the preferencesrepository user (dmc_wdk_preferences) and the presets repository user in app.xml.

To use the password encryption tool

1. From the command line, with com.documentum.web.formext.session.TrustedAuthenticatorTooland the Java SDK in your classpath, run the following command on a single line. Substitute theactual path to the class and the repository password to be encrypted:java classpath "%CLASSPATH%;path_to_WEBINF/classes;path_to_WEBINF/classes/dfc.jar;path_to_WEBINF/classes/commonsio1.2.jar" TrustedAuthenticatorToolpassword

The output will look similar to the following:Encrypted: [d7d1d6e383d6d4e1d0], Decrypted: [my.pwd6\]

2. For Java EE principal authentication, paste the encrypted form of the password into the fileTrustedAuthenticatorCredentials.properties located in WEB-INF/classes/com/documentum/web/formext/session. Each repository must have an entry for the superuser, encrypted password, anddomain if needed. Substitute the actual repository name in the sample entries below. If nodomain is needed for login, then type the following: Repository_name.domain=Repository_name.user usernameRepository_name.new‑pw passwordRepository_name.domain domainname

For example:mydocbase.user=superuser1 mydocbase.newpw= d7d1d6e383d6d4e1d0 mydocbase.domain=

3. For preferences or presets repository passwords, paste the encrypted form of the passwordinto the file app.xml in the custom directory. Insert the encrypted preferences passwordinto <preferencesrepository>.<password> or the encryped presets password into the<presets>.<password> element.

4. The symmetric keys for encryption and decryption are stored in a file namedwdk.keystore. This file must be stored in a secure location on the applicationserver file system. Open the file KeystoreCredentials.properties, located inWEB-INF/classes/com/documentum/web/formext/session, and specify your keystore location.You must also override the use of the default DFC config dir in order to substitute thisnew location, for example: keystore.file.location=C:/Documentum/config/wdk.keystoreuse_dfc_config_dir=false



By default, the keystore file location is created in the DFC config directory, which containsdfc.properties and is specified as the value of dfc.config.dir in dfc.properties. The default locationis WEB-INF/classes.

Note: Entries that were encrypted by the 5.3.x encryption tool and entered into the field .passwordinstead of the .new-pw field will be decrypted by the 5.3.x encryption tool.

The WDK samples and testbed have been removed from the application to prevent cross-sitescripting. These files are available as a separate download on the download site.

Enabling read notifications

Since: version 6.5

Effort: simple, multiple JSP pages

Two kinds of notifications are enabled in webcomponent/app.xml: event notification and readnotification. These notifications require a valid SMTP server configured for the Content Server:smtp_server_attribute of dm_server_config object. The user who requests notification as well as theuser whose activity generates a notification must each have a valid email address configured in thedm_user object.

Enabling change notification — Users can request change notification for a Content Server event onone or more objects. Any API, workflow, or lifecycle event can be notified. Notification is available ondm_sysobject and its subtypes from the Webtop menu or the right-click context menu. Notificationon replica and reference (shortcut) objects is not supported. The user who has selected changenotification on an object will receive a notification in the Documentum inbox, and by email. If anevent that is configured in app.xml does not exist in a particular repository, that event is ignored bythe event notification mechanism for users who are logged into that repository.

Add notification for an event by copying the entire <notification> element fromwebcomponent/app.xml to your custom app.xml and adding an <event> element for each notifiableelement. Server events are listed in an appendix of Documentum Content Server Administration Guide.

Enabling read notification — A user can select any object in a list view and turn on read notificationto notify the user when the document has been read. The default event for notification is dm_getfile,and the minimum permission for read notification is configured in app.xml.

Add notification for read access to objects by copying the entire <readnotification> element fromwebcomponent/app.xml to your custom app.xml and specifying the name of the read event (defaultdm_getfile) and the minimum permission required to request read notification. Server events arelisted in an appendix of Documentum Content Server Administration Guide.

Setting roles precedence

Since: version 6

Effort: simple to complex, depending on the number of roles in the enterprise

When the configuration service evaluates a user’s role in order to apply configuration scopes orpresets, it is impossible to determine the order of roles to follow. This may result in a user having the



wrong context. You can specify the precedence in which roles should be evaluated for a user. In thefollowing example, role abc takes precedence over role def if a user is assigned both roles.<rolesprecedence><role>abc</role><role>efg</role>

</rolesprecedence>

Copy the entire <rolemodel> element from /wdk/app.xml to your custom app.xml and add yourappropriate rolesprecedence element.

Right-click context menus

Since: version 6

Right-click context menus have been added to datagrids. For information on how to add or removeactions from the right-click menu, and how to turn off right-click menus, refer to Adding right-clickcontext menus, page 118 in the datagrid customizations topic.

Migrating datagrid customizations

Since: version 6

Effort: Moderate configuration, multiple JSP pages

Several substantial improvements have been made to the look and behavior of datagrid controls. Theimprovements include mouse or keyboard row selection (one or more objects), right-click contextmenus, fixed column headers, and resizable columns.

Turning off new datagrid features — The new datagrid features can be reverted with the followingaddition to your custom app.xml:<desktopui><datagrid><richui>false</richui>

</datagrid></desktopui>

Note: Cells spanning multiple columns are not permitted.

Placing content below the datagrid — A datagrid without a height attribute value will spanthe entire height of the window. If you have content to place below the datagrid, put it within admf:datagridFooter tag within a dmf:datagridRow tag.

The following topics describe migrating your custom components to use the new datagrid features.



Supporting row selection


Users click rows to select objects rather than a check box at the left margin. This feature is enabledby default and requires no migration effort for datagrids that leverage the ActionMultiSelect andActionMultiSelectCheckbox controls to drive row and object selection.

Replacing <td> with <datagridRow> — Every <td> tag within the custom datagrid dmf:datagridRowtag must be replaced with dmf:datagridRowTd tag. For example, in the 5.3 page acllist.jsp, thedescription column in the datagrid is as follows:<td class="doclistfilenamedatagrid"><dmf:label datafield=’description’/>

</td>

In version 6, the cell is changed as follows:<dmf:datagridRowTd cssclass="doclistfilenamedatagrid" style="min-width: 100px"><dmf:label datafield=’description’/>

</dmf:datagridRowTd>

Handling a double-click event in a datagrid row — If your datagrid row supported a linkevent (single or double click), you must either migrate the link to a right-click context menu orto a datagridRowEvent tag. The following example wraps a WDK 5.x double-click event with adatagridRowEvent. The event arguments, which in 5.x were passed in the actionmultiselectcheckbox,are passed in argument tags:<dmf:datagridRowEvent eventname=’dblclick’ eventhandler=’onClickObject’ runatclient=’true’><dmf:link onclick=’onClickObject’ name=’objectLink’ runatclient=’true’ datafield=’object_name’><dmf:argument name=’id’ datafield=’r_object_id’/><dmf:argument name=’type’ datafield=’r_object_type’/><dmf:argument name=’isFolder’ datafield=’isfolder’/>

</dmf:link></dmf:datagridRowEvent>

Note: A datagridrow tag can contain only one datagridrowevent tag.

Handling a single-click event (selection) in a datagrid row — The following example handles asingle-click event (selecting the row). The event handler for a select event must be client-side:<dmf:datagridRowEvent eventname=’select’ eventhandler=’onSelectObject’ runatclient=’true’><dmf:argument name=’id’ datafield=’r_object_id’/><dmf:argument name=’name’ datafield=’object_name’/>

</dmf:datagridRowEvent>

The event object that is passed to the JavaScript handler has the following properties:• type

Event type, such as select or init

• datagrid

Datagrid object instance



• startIndex

Index of the selected or deselected item, starting with 1

• count

Count of selected items

An event handler gets the item arguments, either for single or multiple selection, as shown in thefollowing example:function onSelectObject(event)//for single item selectionif (event.count == 1var args = event.datagrid.data.getItemActionArgs(event.startIndex, event.type);//handle args

//handle multiple selectelsefor (var i=0; I < event.count; i++)var args = event.datagrid.data.getItemActionArgs(event.startIndex + i, event.type);//handle args

Turning off row selection per datagrid — You can turn off row selection for an individual datagridby setting the rowselection attribute value to false on the datagrid control in a JSP page. The app.xmlfile’s <desktopui>.<datagrid>.<richui> element must be set to true to enable this attribute. Thefollowing table describes the interaction between the global row selection flag in app.xml and thedatagrid attribute rowselection attribute.

Table 16. Interaction between global versus local row selection settings

app.xml<rowselection>

dmf:datagridrowselection

Result

false true or false Checkboxes rendered, nomouse/keyboard row selectionor context menus on anydatagrid

true true No checkboxes rendered, rowselection and context menusenabled for the datagrid

true attribute not specified(for example, migratedcustomizations)

No checkboxes rendered, rowselection and context menusenabled for the datagrid

true false Checkboxes rendered, nomouse/keyboard row selectionor context menus on currentdatagrid



Migrating to resizeable columns


Your custom datagrids can be migrated to support column resizing.

To make a column in the datagrid resizeable, add resizable="true":<dmf:datagridTh resizable="true">. . .</dmf:datagridTh>

If your listing component extends the DocList component, it inherits support for resizeablecolumns. If not, you must add the initColumnWidths method to the implementation ofthe component class and call it when the component initializes. Your class must importDatagridColumnWidthPreferenceHelper:...importcom.documentum.web.form.control.databound.DatagridColumnWidthPreferenceHelper;...public void onInit(ArgumentList args). . .initColumnWidths();

protected void initColumnWidths()m_widthsHelper = new DatagridColumnWidthPreferenceHelper(this, <preference id string>, CONTROL_GRID);

private DatagridColumnWidthPreferenceHelper m_widthsHelper;

Adding fixed column headers

Headings now stay in place while the user scrolls through the items in the datagrid. To enable thisbehavior, custom components must implement header rows using the new element datagridTh. Forexample, in the 5.3 component acllist, the datagrid contains a header for the name column:<th align=’left’ scope=’col’ class="doclistfilenamedatagrid"><b><dmf:datasortlink name=’sortcol1’ nlsid=’MSG_NAME’ column=’object_name’ mode=’caseinstext’ cssclass=’doclistbodyDatasortlink’/>

</b></th>

The <th> tag is replaced in WDK 6 as follows:<dmf:datagridTh width=’30%’ scope=’col’ cssclass="doclistfilenamedatagrid nowrap leftAlignment"><b><dmf:datasortlink name=’sortcol1’ nlsid=’MSG_NAME’ column=’object_name’ mode=’caseinstext’ cssclass=’doclistbodyDatasortlink’/>

</b></dmf:datagridTh>

To globally disable fixed column headers in the application, add the following element to/custom/app.xml:<desktopui>

<datagrid>



<fixedheaders>false</fixedheaders></datagrid>

</desktopui>

Adding right-click context menus

Effort: simple, multiple XML files

WDK 6 provides access to commonly used commands via a right-click context menu. The actionsthat are displayed in the context menu are filtered by any presets that apply to the user context.This functionality provides an interface that is more familiar to users than the Streamline interface,which is now deprecated.

Context menus work in datagrids that configured for row selection (that is, rows that do not usecheck boxes). To turn off context menus, you must also turn off all datagrid enhancements in yourcustom app.xml:<desktopui><datagrid><richui>false</richui>

</datagrid></desktopui>

Context menus are defined in the <menuconfig> element of an action configuration file for a specificobject type. For example, the configuration file dm_folder_actions.xml contains the menu items thatare available for folder (the dm_folder type). The element <actionmenuitem> identifies an action thatcan be performed on the object type . You can create submenus within the <menuconfig> element bynesting a <menu> element with its own <actionmenuitem> elements.

The following example from dm_folder_actions.xml defines a context menu for actions on selecteddm_folder objects. The Properties menu item is followed by a View submenu that containsthree actions: relationships, locations, and topics. Note that some actions support multipleselection (the dynamic attribute is set to "multiselect") and some support only single selection(dynamic="singleselect").<menuconfig id="contextmenu"><actionmenuitem dynamic="multiselect" action="subscribe" .../>

<actionmenuitem dynamic="multiselect" action="unsubscribe" .../>

...<menuseparator/><actionmenuitem dynamic="singleselect" action="properties" .../>...<menu menu nlsid="MSG_VIEW_MENU"><actionmenuitem dynamic=’multiselect’ action=’relationships’ .../>

<actionmenuitem dynamic=’multiselect’ action=’locations’ .../>

<actionmenuitem dynamic=’multiselect’ action=’showtopicaction’ .../>




You could add a custom menu item to the top level menu and one to the View menu as follows:<menuconfig id="contextmenu"><actionmenuitem dynamic="multiselect" action="subscribe" .../>

<actionmenuitem dynamic="multiselect" action="unsubscribe" .../>

...<menuseparator/><actionmenuitem dynamic="singleselect" action="properties" .../>

<actionmenuitem dynamic="singleselect" action="firstcustomaction" .../>...<menu menu nlsid="MSG_VIEW_MENU"><actionmenuitem dynamic=’multiselect’ action=’relationships’ .../>

<actionmenuitem dynamic=’multiselect’ action=’locations’ .../>

<actionmenuitem dynamic=’multiselect’ action=’showtopicaction’ .../>

<actionmenuitem dynamic=’singleselect’ action=’nextcustomaction’ .../>


Toolbar hidden by default

Since: version 6

Effort: simple, single JSP page

The toolbar is no longer necessary with the introduction of the right-click menu, and so has beenhidden by default. It is still present in the webtop\classic\classic.jsp JSP page, but its frame height isset to 0. You can display the toolbar by changing the lineString strRows = "0,*";

toString strRows = "22,*";

Keyboard shortcuts (hotkeys)

Since: version 6

Effort: moderate, one XML file and custom JSP pages

Keyboard shortcuts, also called hotkeys, are supplied and supported in version 6. A shortcut calls anaction or invokes a control. You can turn off this feature in app.xml, or you can configure shortcuts toadd, change or remove a shortcut. You can add shortcut support to a custom control (effort: complex).

To disable hotkeys, add the following to a modifications file, for example, custom/config/app_modifications.xml:<application modifies="wdk/app.xml"><replace path="hotkeys"><hotkeys>



<enabled>false</enabled></hotkeys>

</replace>...(remainder of your modifications to app.xml)

Adding a shortcut or modifying existing shortcuts

Controls that support shortcuts have a hotkeyid attribute, for example:<dmfx:actionmenuitem... action=’checkin’ hotkeyid=’HOTKEY_CHECKIN’/>

The hotkeyid value is resolved by a lookup in the shortcuts (hotkeys) definition in hotkeys.xml.This file defines an NLS key for each hotkey ID. The key is then resolved to a key combinationin the hotkeys properties file HotKeysNlsProp.properties. The properties files can be localizedfor locale-specific key combinations.

Caution: When focus is on a user-entry control such as text, shortcuts are not enabled. If youset initial focus in the UI to a user-entry control, shortcuts will not be enabled until the usermoves off the control.

To create your own shortcuts mapping

1. Specify your hotkeys mapping file in app.xml. Refer to Specifying a shortcuts mapping propertiesfile, page 120.

2. If you are adding shortcuts to custom actions, create a definition by extending or modifyinghotkeys.xml. This file will have a hotkey ID for each hotkey action. Refer to Adding a shortcutdefinition in an XML file, page 121.

3. Create a map (properties file) that maps each hotkey ID to a key combination. You can includethe WDKmap and simply make your changes in your custom properties file. Refer to Creating ormodifying a shortcuts map, page 122.

4. Add your shortcut to a custom control on the JSP page. Refer to Adding your custom shortcut tothe component, page 124.

Specifying a shortcuts mapping properties file

The <hotkeys> element in your custom app.xml file specifies a mapping file that maps keycombinations to actions. You must specify the location of your properties file in your custom app.xml.If your file is located in WEB-INF/com/mycompany, for example, you would specify the location inan <nlsbundle> element as follows in app.xml:<hotkeys><enabled>true</enabled><nlsbundle>com.mycompany.HotKeysNlsProp</nlsbundle>

</hotkeys>



Adding a shortcut definition in an XML file

The hotkeyid value for a control is resolved by a lookup in the hotkeys configuration file hotkeys.xml,located in webcomponent/config. The corresponding key NLSID value is resolved by a lookupin a shortcut mapping file.

Tip: If you are changing existing shortcut combinations, you do not need a hotkeys definition file. Ifyou are adding shortcuts for your custom actions or removing shortcuts to WDK actions, a hotkeysdefinition XML file is required. You can use the modification mechanism to do this.

To insert a shortcut, create a modification XML file in custom/config, for example,hotkeys_modification.xml. This file modifies the WDK hotkeys definitions and adds custom keys.For example:<hotkeys modifies="hotkeys:webcomponent/config/hotkeys.xml"><insert><hotkey id=HOTKEY_CUSTOM_ACTION1><keynlsid>_#HOTKEY_CUSTOM_ACTION1</keynlsid>

</hotkey></insert></hotkeys>

Table 17, page 121 describes the hotkeys configuration elements.

Table 17. Hotkeys configuration elements

Element Description

<hotkeys id=...> The id attribute on this element facilitates morethan one hotkeys definition for the application

<hotkey id=...> The id attribute on this element is referenced bya control on the JSP page and contains a key forlookup of the hotkey combination. The ID mustbe unique to the definition. Contains <keynlsid>and, optionally, <labelnlsid>.

<keynlsid> Specifies an NLS key that is resolved in thehotkeys NLS properties file.

<labelnlsid> (Optional) Specifies an NLS key for a label thatto be displayed for the shortcut

To add your new shortcut to the JSP page

1. Find every instance of a control that launches your custom action in your JSP page.

2. Add the hotkeyid attribute to match the mapping that you set up for your custom shortcut. Inthe following example, the menu item launches the custom action "myaction” and maps to theshortcut with the id HOTKEY_CUSTOM_ACTION1:<dmf:menuitem id="custom_menu" name=’custom_item’nlsid="MSG_CUSTOM_ACTION" onclick="onClickCustomAction"runatclient="true" hotkeyid="HOTKEY_CUSTOM_ACTION1"/>

In the next example, the shortcut to a delete action is specified:<dmfx:actionimage name="delete" dynamic="multiselect" action="delete" hotkeyid="HOTKEY_DELETE" .../>



Creating or modifying a shortcuts map

A Java NLS properties file specifies the key combinations for each hotkey ID. Make sure your customapp.xml file specifies the fully qualified path name for this NLS properties file as described inSpecifying a shortcuts mapping properties file, page 120. If you add shortcuts to custom actions, thencreate NLS IDs for your shortcut IDs in a custom hotkeys configuration file as described in Addinga shortcut definition in an XML file, page 121.

To include the WDK or Webtop shortcuts — When you change or add hotkey combinations,include the WDK properties file in your own properties file so that you inherit the WDK shortcuts.Include the WDK map as follows:NLS_INCLUDES=com.documentum.webcomponent.keyboardshortcut.HotKeysNlsProp

To add a new shortcut combination — Add a new shortcut similar to the following, which specifiesthat the shorcut with the NLS id _#HOTKEY_CUSTOM_ACTION maps to the keystrokes Ctrl andShift and X:_#HOTKEY_CUSTOM_ACTION=Ctrl+Shift+k

To modify an existing shortcut — In your custom mapping properties file, add an entry for theshortcut with the keystroke combination. This entry will override the entry in the WDK mapping file.The following example changes the keyboard shortcut for Export from Shift + E to Shift + X:_#HOTKEY_EXPORT=Shift+X

In your key combinations, a single keyboard key can be combined with another key such as Ctrl(Windows), Cmd (Macintosh), Shift, or Alt. Table 18, page 122 describes the single keys that can beused in a shortcut combination. Shortcut definitions are case-insensitive.

Table 18. Keys that can be used in a shortcut combination

Key Description

alphanumeric A-Z or 09

navigation and command Home, End, Enter, Insert

punctuation The following punctuation keys can be used:; = , . / ’ [ ] \ ‘

function keys Unreserved function keys are valid

Tip: Do not use a shortcut combination that is reserved for browsers, such as Ctrl+c for copy in IE.WDK will not attempt to override reserved shortcuts.

The NLS ID value that is used to specify the shortcut combination can have .MAC added to providean alternate shortcut combination for the Macintosh platform, for example:_#HOTKEY_COPY_FILE=Shift+V_#HOTKEY_COPY_FILE.MAC=Shift+C

To add or change a shortcut combination

The following example changes a shortcut definition for Add to Clipboard on Windows from Shift+Cto Shift+X and adds a shortcut for a custom action.



1. Add your NLS bundle reference to app.xml in your custom directory, for example:<hotkeys><nlsbundle>com.mycompany.HotKeysNlsProp</nlsbundle>

You will create this file in step 6.

2. Create a file hotkeys_modification.xml in custom/config and open the file for editing.

3. Add the required XML structure:<?xml version="1.0" encoding="UTF-8" standalone="no"?><config><scope></scope></config>

4. Add your <hotkeys> element as follows:<hotkeys modifies="hotkeys:webcomponent/config/hotkeys.xml"><insert></insert></hotkeys>

5. Within the insert element, add <hotkey> elements for the new shortcut. You do not need tomodify the definition to replace a shortcut, because you can use the same keynlsid and justprovide a new string in the properties file.<insert><hotkey id="HOTKEY_MYACTION"><keynlsid>_#HOTKEY_MYACTION</keynlsid>

</hotkey></insert><replace>

6. Create a HotKeysNlsProp.properties file in WEB-INF/classes/com/mycompany. The followingexample adds an entry for the new hotkey ID and maps it to the key combination of the alt keyand the x key. It changes the shortcut for the copy action:NLS_INCLUDES=com.documentum.webcomponent.keyboardshortcut.HotKeysNlsProp_#HOTKEY_MYACTION=Alt+X_#HOTKEY_ADD_TO_CLIPBOARD=Shift+X

7. Add the hotkeyid attribute value HOTKEY_MYACTION to the component JSP page, in thecontrol that calls your custom action, for example:<dmfx:actionlink name="mylink" action="myaction" hotkeyid="HOTKEY_MYACTION"...>

8. Restart the application server for changes to NLS properties files. If your changes are to XMLfiles only, refresh memory by navigating to wdk/refresh.jsp.

9. Test your shortcut combination in the appropriate component.Shortcuts are bound to the top level window of the application, so you must ensure that all shortcutsare uniquely defined in the <hotkeys> configuration elements across your application. This will beeasier to manage in a single shortcuts mapping file. If two controls are assigned the same shortcut, thesecond assignment will be used. Shortcuts are not invoked when the keyboard focus is on an inputfield such as text, textarea, or password. For these controls, use the escape key to access shortcuts.



Adding your custom shortcut to the component

In every JSP page that contains your custom control, you must add the new shortcutid attribute. Inthe following example, the custom action has a shortcut with the ID HOTKEY_CUSTOM_ACTION,as defined in the properties mapping file:<mytld:customactions name="customactiona" dynamic="singleselect" action="action1" hotkeyid="HOTKEY_CUSTOM_ACTION1" .../>

Modifying a custom control to support shortcuts

The base Control class supports shortcuts with the public methods setHotKey, setHotKeyLabel,getHotKey, and getHotKeyLabel. The following WDK controls support shortcuts: ActionMenuItem,ActionButton, ActionLink, ActionImage, Button, Link, and MenuItem.

If your custom control extends a WDK control with shortcut support, add the hotkeyid attribute tothe tag library descriptor that contains your control and then set the hotkeyid value on the controlin the JSP page.

To set a shortcut combination programmatically on a control that supports shortcuts, use the APIsetHotkey(String hotKey) where the parameter is a key combination, for example: setHotkey("alt+x");If your control does not extend a control with shortcut support, add support to the tag class by callingeither the renderHotKey() or renderHotKeyHandler() from renderEnd().

The keyboard events that are handled are keyup, keydown, and keypress. WDK JavaScript handlersfor each of these keyboard events retrieve the shortcut commands and invoke the correspondingactions.

To add shortcut support to a custom control

1. Add a hotkeyid attribute for the custom control to your control tag library descriptor as follows:<attribute><name>hotkeyid</name><required>false</required><rtexprvalue>true</rtexprvalue>

</attribute>

2. At the end of renderEnd() in the control tag class, add a call to renderHotKey() orrenderHotKeyHandler().• For a control that launched as client JavaScript event, for example, a click, callrenderHotKey(StringBuffer buf, String eventName) and provide the event name, for example,onClick. The Javascript code for the shortcut will be rendered by the framework.

The following example from ButtonTag checks whether the control is enabled and, if so, addsthe renderHotKey JavaScript function key to the output.



In the Button class, the EVENT_ONCLICK is the onclick event:if (button.isEnabled())StringBuffer buf = new StringBuffer(256);renderHotKey(buf, Button.EVENT_ONCLICK);out.print(buf.toString());

• For an action control,, call renderHotKeyHandler(StringBuffer buf, String hotkeyHandler).Specify a hotkey JavaScript handler that will be invoked for the shortcut and provideyour handling in the referenced JavaScript handler. In the following example fromActionButtonTag, a handler method getClientEventFunctionCall is specified (provide yourown method):if ((isButtonGraphic(button) && button.isEnabled()) || !isButtonGraphic(button))

renderHotKeyHandler(buf, getClientEventFunctionCall());

Note: The handler getClientEventFunctionCall is implemented in ActionControlTag to passon the dynamic attribute value of an action control. If your control is not an action control,you can call a custom handler in your tag class to render your JavaScript reference.

3. Follow the steps in Adding a shortcut or modifying existing shortcuts, page 120 to set up andtest the shortcut for your control.

Tab order configuration

Since: version 6


WDK supports the HTML attribute tabindex to determine the order in which controls receive focuswhen the user types the tab key. The following WDK controls support tab ordering in version 6:• Text (also XFormsText, FileBrowse)

• Password

• TextArea (also XFormsTextArea)

• Button

• Link

• ActionButton

• ActionLink

• ActionImage

• Tree

• CheckBox

• Radio

• Image



• DropDownList (also DataDropDownList, ListBox, DataListBox)

• DateInput

• DateTime

Tab ordering is enabled by default. Tab ordering can be turned on or off for different environments inapp.xml. We recommend that you turn off tab ordering in portal applications.

When a component is included within another component, elements may have the same tabindexvalue. Place the included component in the page based on your preferred tab ordering among theelements in the parent page. WDK will ensure that tabindex collisions are resolved and elementsare navigated in the order they appear in the character stream.

Tip: As a general rule, you should assign index values incrementally based on the order of elementsin the source code for the page. Use the tab key ordering to support a different tabbing requirement.Do not use tab ordering to "fix" a bad page design. In the latter case, alter the order of the contentin the markup itself instead of altering the order using tabindex.

Supporting tab index in a custom control

1. Open the tag library descriptor for the custom control.

2. Add the tabindex attribute within the tag definition as follows:<attribute><name>tabindex</name><required>false</required><rtexprvalue>true</rtexprvalue>

</attribute>

3. Add tabindex attribute values on the JSP pages that contain the custom tag.

4. If the custom control provides its own rendering rather than that of a parent that supports tabindex, call renderTabIndex(StringBuffer) API from the base ControlTag class in the renderingmethod.

5. Save the tag library descriptor and JSP files and restart the application server

Supporting auto completion

Since: version 6


The auto complete feature provides value assistance for drop-down list and text controls. The valuesare read from the data dictionary. Completion lists are stored by autocompleteid for each user. Thevalues are not specific to an object type or repository.

Auto complete is enabled by default. Auto complete can be disabled for the entire application bysetting the <auto_complete>.<enabled> attribute to false in the app.xml file.



Configuring a custom control that can support autocompletion

Even when autocomplete is turned off for the application, it can be turned on for an individualcontrol. Set autocompleteenabled="true" for the control. Controls that have the same value forautcompleteid share the same autocomplete list. The maximum autocompletion items to be displayedis set by the maxautocompletesuggestionsize attribute. The autocompletetarget attribute specifies thename of the frame where the completion list should be displayed. By default, the popup appears inthe same frame.

If no autocompleteid is specified, the autocompleteid setting defaults to the form name concatenatedwith the control name. In this care, every control on the page will have a different autocompletion list.

Adding autocompletion support to a text or dropdown list control — You can add auto completefunctionality to any control that extends the WDK text or dropdown list controls. Add the fourautocompletion attributes to your control definition in your custom tag library. For example:<attribute><name>autocompleteenabled</name><required>false</required><rtexprvalue>true</rtexprvalue>

</attribute><attribute><name>autocompleteid</name><required>false</required><rtexprvalue>true</rtexprvalue>

</attribute><attribute><name>maxautocompletesuggestionsize</name><required>false</required><rtexprvalue>true</rtexprvalue>

</attribute><attribute><name>autocompletetarget</name><required>false</required><rtexprvalue>true</rtexprvalue>

</attribute>

Adding autocompletion support to a non-text control — You can create custom controls that donot extend text or dropdown list but can support auto complete (effort: complex). To implementautocompletion in these controls, implement IAutoCompleteEnabledControl in the control class.The method getInputValue() should get the value that the user has entered and add it to theautocompletion list. For example, the Text class implements the method in the following way:public String getInputValue()return getValue();

The tag class must bind the autocomplete object during rendering. The following example from theTextTag class calls a rendering method from renderEnd:protected void renderEnd(JspWriter out)throws IOException

//...if (text.isAutoCompleteEnabled())

// generate the JavaScript to support AutoComplete// generate the auto complete list



renderAutoCompleteTextBinding(buf, Text.EVENT_ONVALUECHANGE, null);

Your control class must manage autocompletion data, inclusing retrieving or storing data, managinglist, and flushing old data when needed. You can use AutoCompleteService, which provides thefollowing APIs:• public synchronized static AutoCompleteService getInstance ()

• public List getAutoCompleteEntries(String key)

• public void addAutoCompleteEntry(String key, String value)

• public void clearAutoCompleteEntries()

• public int getAutoCompleteMaxSuggestionSize ()

• public Option getAutoCompleteOption ()

• public static void setAutoCompleteOption (Option option)

Add the autocompletion attributes to the tag library descriptor entries for your custom tag.

Adding a "Starts with” filter

Since: version 6

Effort: simple to moderate, multiple JSP pages

A new control, <dmf:datacolumnbeginswith>, allows you to filter the selection in datagridsand dropdown lists. The filter is bound to the containing control on the JSP that implementsIDataboundControl. Filtering is case-insensitive by default.

In the following example from myobjects_list_body.jsp, the filter adds a text box that filters on objectname starting with the text entered by the user:<dmf:datacolumnbeginswith name=’namecolumnbeginswith’ column=’object_name’ autocompleteid=’ac_namecolumnbeginswith’ size="24" nlsid="MSG_BEGINSWITH_FILTER"/>

The data source that will be filtered is specified in the column attribute of the datacolumnbeginswithcontrol. The column must match a column that is specified within a <column> element of thecomponent definition. For example, to enable filtering on the object name, the value of the columnattribute should be "object_name".

In the following example, the datacolumnbeginswith control is bound to a datadropdownlist:<dmf:datagrid ...><dmf:datadropdownlist ..><dmf:datacolumnbeginswith ../>

</dmf:datadropdownlist ..></dmf:datagrid>



Displaying invalid actions

Since: version 6

Effort: simple, single XML file

By default, actions that are invalid for the user are hidden. Your can display them with a setting in/wdk/app.xml, <display>.<hideinvalidactions>. This setting overrides theshowifinvalid setting on actioncontrols. Set this element to false to display ctions that are not valid in the user’s current applicationcontext, regardless of the setting in the showifinvalid attribute of the action control.

Drag and drop improvements

Since: version 6.5

Users can select multiple files and perform a drag and drop. The multi-select drag and dropfunctionality is available for all areas where single file drag and drop was previously available. Forexample, users can multi-select files and drag and drop them to another location in the repository.Multi-select drag and drop also works when exporting and importing multiple files to and fromthe local file system.

These improvements require no migration.

You can turn off drag and drop for the application, to improve performance. In your custom app.xml,add the following lines:<dragdrop><enabled>false</enabled>

</dragdrop>

Since: version 6

When a user drags a document into a directory with an item of the same name, a popup menudisplays to allow the user to choose between creating a new rendition of the repository file, orreplacing the content of the existing file with the dropped file. This feature does not require migration.

Preferences changes

Since: version 6

Effort: none to simple, single XML

User preferences are now stored in the global registry in addition to local cookies. Preference storagein the repository enables users to see their preferences on more than one machine. This featuredoes not require migration.

The cookie size has been streamlined for scalability. This enhances reliability and makes the user’scustomized settings available from any client machine.

Saving preferences in a separate repository — By default, user preferences are stored in the globalregistry. You can specify a different repository for preferences storage in your custom app.xmlfile. Copy the <preferencesrepository> from wdk/app.xml to your app.xml and add the name of



your preferences repository to the child element <repository>. You can add a triple-DES encryptedpassword to the <password> element using the utility class TrustedAuthenticatorTool. With the classcom.documentum.web.formext.session.TrustedAuthenticatorTool in your path, execute the followingcommand. Substitute the actual password (pwd below) for the user dmc_wdk_preferences_owner:java com.documentum.web.formext.session.TrustedAuthenticatorTool pwd

Paste the resulting encrypted password into the <password> element in app.xml.

Specifying cookies that are not persisted — User preferences that should not be stored (cookie only)should be added to the <non_repository_preferences> element. Use this for preferences that shouldnot be stored in a repository and should be stored only in a cookie, such as login preferences. Thesecookies are used before the preferences are downloaded from the preferences storage repository.

Within the <non_repository_preferences> element, each <preference> element contains a value thatcorresponds to the XML path to the element within a configuration file that defines the cookie(nonrepository) preference. If an element has an ID, it must be specified, as in the following examplefrom the login component:component[id=login].username

Content transfer changes

UCF performance improvements in Webtop

Since: version 6.5

Effort: none to moderate: for PDF byte-serving, one XML file plus all PDF files in repository

UCF content transfer is more usable and performs better. These enhancements require no migration.The following lists the UCF enhancements for Documentum 6.5:• Reduction in the number of round trips between the UCF client and server. This feature isespecially effective for improving transfer performance for smaller files over a high latency WAN.

• The following UCF client initialization/startup improvements:— Sharing a JVM instance across multiple web sessions

— Starting JVM upon login

• Support for PDF byte streaming through a native viewer. Refer to Enabling PDF byte-serving,page 131 for information on configuring this feature.

• Use of parallel streams to increase content transfer rate. This feature is especially effective forimproving content transfer performance of large files over a high latency WAN (outbound andinbound).

• Freeing up stuck threads to optimize resources and increase concurrency.

• Reduction in unnecessary WDK UCF client calls.



Enabling deep export

Since: version 6.5


WDK provides the ability to export one or many folders, keeping the same folder structure if the userhas at least read permission on the files and browse permission on the folders.

By default, deep export is disabled, and you must enable it in app.xml. Add the following lines toyour custom app.xml:<deepexport><enabled>true</enabled>

</deepexport>

Turning off UCF preload

Since: version 6.5


The UCF invoker component preloads the Java browser plugin and UCF process for each user.This preload makes content transfer faster in a multi-frame application. It is enabled out of thebox in Webtop.

To preload UCF in a custom application that is not based onWebtop, you must include the componentin a hidden frame of the application frameset. Add the residentucfinvoker frame as shown below toyour application frameset in the main application JSP page. The example is taken from the Webtopframeset defined in mainex.jsp:<dmf:frameset ... onunload=’onUnload()’><dmf:frame name="timeoutcontrol" .../><dmf:frame name="residentucfinvoker"src="/component/residentucfinvoker" marginwidth="0"marginheight="0" scrolling="no" .../>

<dmf:frame nlsid="MSG_TITLEBAR" name=’titlebar’ .../><dmf:frame nlsid="MSG_CLASSICVIEW" name=’view’ .../><dmf:frame nlsid="MSG_MESSAGEBAR" .../>

</dmf:frameset>

Enabling PDF byte-serving

Since: version 6 SP 1

Effort: simple to moderate: one XML file plus all PDF files in repository

PDF documents can be streamed to the browser so that the user can read a document before it hasfully downloaded to the browser. This feature is available for PDF documents served from ContentServer 6 SP1 repositories if the user has configured preferences to view PDF documents inline.



To enable PDF byte-serving

1. Administrator: Enable PDF documents for fast web view. This is done in Adobe Acrobat. ChooseFile > Properties and check Yes for Fast Web View.

2. Administrator: Enable ACS read in app.xml. It is enabled by default, but if your customapp.xml turns if off, PDFs will not be served incrementally. To enable it, set the value of<accelerated-read>.<enabled> to true in custom/app.xml..

3. User: Select inline viewing for PDF documents. In Webtop Preferences, choose the Formats taband click Add. For Choose object type, choose All types. For Primary Format, choose AcrobatPDF. For Would you like this content to appear in the web browser? choose Yes.

Specifying the content transfer mechanism for a groupor role

Since: version 6.5


Webtop 6.5 and later enables administrators to specify HTTP or UCF content transfer for differentusers within the sameWebtop installation. Before Documentum 6.5, all users within the sameWebtopinstallation had to use either HTTP or UCF content transfer.

Configure the content transfer mechanism with a role qualifier filter. Copy the <contentxfer> elementfrom wdk/config to your custom app.xml file and add configuration for each role that will have acontent transfer mechanism different from the default. In the following example, the contributors areassigned to the role of ucfgroup with UCF content transfer while consumers are assigned to the roleof httpgroup which has HTTP content transfer:<contentxfer>

<filter role="ucfgroup" ><mechanism>ucf</mechanism>

</filter><filter role="httpgroup" ><mechanism>http</mechanism>

</filter><default-mechanism>ucf</default-mechanism>...

</contentxfer>

Enabling scanning of Microsoft formats for linkedobjects

Since: 6.5 SP1


For WDK-based applications that use UCF content transfer, scanning for linked documents inMicrosoft compound documents can be enabled. Link scanning may have a performance impact,and it is not enabled by default for the application. The user must also set a preference to enable linkscanning. This preference is not enabled by default.



When link scanning is enabled, the following formats will be scanned for links and the linkeddocuments will be imported or checked in:• Microsoft Word

• Microsoft Excel

• Microsoft Powerpoint

The following versions of these Office documents are supported:• 97

• 2000

• XP

• 2003

• 2007

While importing or checking in a document containing linked documents, the user can select theDocument Links option in the Import or Checkin dialog box. When this option is selected, theuser enables scanning of Microsoft Word, Powerpoint, and Excel formats for linked objects whileimporting and checking in such files. In addition, when linked documents are imported, the parentand children are internally treated as virtual documents, but the user will not be able to reorder thelinked documents within the compound document.

Alternatively, users can configure theDocument Links option to appear selected by default. The userselects Tools > Preferences in theGeneral tab of the Preferences dialog box, and selects theDocumentLinks option to check for links to other documents and include linked documents while importingand checking in files for Microsoft Word, Powerpoint, and Excel formats. As a result, the DocumentLinks option is selected by default when the Import and Checkin dialog boxes are displayed.

Note: Content linked with the Office hyperlinks feature is not included in an import or check-in.

To enable link scanning for the application:

1. Open app.xml in the custom directory in a text editor or IDE.

2. Add the following lines to the <contentxfer> element:<embeddedlinksscan><enabled>true</enabled></embeddedlinksscan>

3. Save and close the file, and restart the application server.The user must set the preference to enable link scanning, but this preference will not take effectunless link scanning is enabled for the application.

To disable link scanning for a specific content transfer component:

1. Extend the action definition that launches a specific content transfer component, for example,dm_sysobject_actions.xml.

2. Copy the action definition into your extended action definition, for example, the checkout action.

3. Uncomment the following line:



4. Save and close the file, and refresh the configurations in memory by navigating tohttp:server/webtop/wdk/refresh.jsp.

Allowing user selection of viewing application forrenditions

Since: version 6


In previous versions, the path to a rendition viewing application had to be the same for every user.This feature can now be configured in app.xml to use the user’s preferred viewing application set inthe format preferences UI.The <preferred_renditions> element in wdk/app.xml contains elements thatspecify the default list of renditions (document type and format combinations) and the application tobe used for viewing or editing a specific document type and format combination. Users can overridethese settings using the preferred renditions component UI.

To enable the user to specify a personal viewing application, copy the <preferred_renditions> inwdk/app.xml to your custom app.xml and set the value of <rendition>.<app> to blank.

Configuring ACS and BOCS settings

Since: version 6


You can enable or disable ACS and BOCS write operations in the application configuration fileapp.xml. If you enable BOCS write, you can set the mode to synchronous, asynchronous, or both. Ifyou enable both, you can set the default mode, and business users will see a UI on import and checkinin which they can select the mode of transfer. ACS supports only synchronous writes.

These settings replace the <acs> configurations in 5.3 app.xml. Following are the default settings.Copy the entire <contentxfer> element from wdk/app.xml to your custom app.xml and make changesrequired by your business environment. Accelerated read uses ACS and, where optimal, BOCS todownload content to the user. Accelerated-write performs the same optimization for uploadedcontent. Other settings are described fully in theWDK Development Guide.<accelerated-read><enabled>true</enabled><attemptsurrogateget>true</attemptsurrogateget><maintainvirtuallinks>true</maintainvirtuallinks>

</accelerated-read><accelerated-write><enabled>true</enabled><bocs-write-mode>prohibit-async</bocs-write-mode><allow-override-bocs-write-mode>false</allow-override-bocs-write-mode>

</accelerated-write>



Content transfer applet removed

Since: version 6

Effort: complex

The content transfer applet is no longer supported. We recommend that you upgrade your customapplications to use the UCF file transfer utility.

Style changesThe following topics describe changes that affect the style of the UI in recent releases. For informationon CSS style changes, refer to Appendix D, Changes to Webtop Cascading Stylesheets.

Streamline deprecated

Since: version 6

Effort: simple to revert, possibly complex to migrate

The streamline interface was designed to provide quick access to the most commonly usedcommands. Version 6.5 introduces the right-click context menu, which provides the same ease of usein a way that is familiar to most users. The streamline interface is now obsolete and is disabled bydefault. However, it still ships with our product for backward compatibility. If you would like toenable the streamline interface, use one of these methods:

• To re-enable streamline view for all users and all HTTP sessions, add the following settingin /custom/app.xml:

<streamlineviewvisible>true</streamlineviewvisible>

• To re-enable streamline view for one HTTP session, launch the main component with theparameter entryPage set to streamline.

For example, Webtop can be launched using a URL similar tohttp://localhost:8080/webtop/component/main?entryPage=streamline

Once the streamline view is enabled, it cannot be disabled again within the same HTTP session.

Specific themes deprecated

Since: version 6

Effort: complex if custom theme is not based on the base documentum theme

Version 6 introduces a new version of the documentum and high contrast themes. These themes enhanceperformance and maintainability, and provide additional "look and feel" benefits. Any 5.3 theme canbe enabled in app.xml, but features that are new in version 6 or 6.5 will not display a custom themethat extends a 5.3 theme. If you want to use a custom theme that extends the documentum or high



contrast theme, you will need to adjust your JSP pages to match the changes introduced in the JSPpage design. Refer to the WDK stylesheet changes in the appendix of this document.

Feature changesThe following are changes to the implementation of controls or specific components in WDK/Webtopapplications. Most of these features are enabled by default. These topics tell you how to disable thenew behavior if you prefer not to use it.

Deprecated components

The following component configuration files are deprecated. Customization to the old componentsshould be updated to point to new component xml files in order to pick up bug fixes and new features.

Table 19. Deprecated components

Component Name Old definition(ends in _component.xml)

New definition(ends in _component.xml)

Changed in

browsertree browsertree browsertreeex 6.5

login (wdk layer) login loginex 6.5

login (webtop layer) login loginex 6.5

main main mainex 6

display_preferences display_preferences display_preferences_ex

6

dqlsearchdelegate dqlsearchdelegate none (removed) 6

dqlsearchdelegate dqlsearchdelegate none (removed) 6

all drilldowncomponents

drilldownXXX same, deprecated 6

general_preferences general_preferences general_preferences_ex

6

search (webtop layer) searchex_component.xml

search60 6

search (webcomponentlayer)

search_component.xml

search60 6

To disable 5.3 customizations that you may have added to a WDK 6 application, copy this element toyour custom app.xml and remove the <version> element for 5.3:<supported_versions><version>6.0</version><version>5.3</version>

</supported_versions>



Supporting conditional value assistance in advancedsearch

Since: version 6

Effort: moderate, in one JSP page

Conditional value assistance is supported. It requires your custom advanced search component touse individual search attribute controls. The searchattributegroup tag provides only simple attributeassistance.

The lists of conditional values are set in Documentum Composer. Query value assistance can use areference ($value(attribute)), for example:SELECT "MyDocbase"."MyTable"."MyColumn1" FROM "MyDocbase"."MyTable"WHERE "MyDocbase"."MyTable"."MyColumn2" = ’$value(MyAttribute)’

The following example lists four attributes, three of which have conditional value assistance lists thatwere set up in Documentum Composer. The drop-down list for Make determines the list available forModel. The drop-down lists Fuel and Year both depend on Model.

Figure 4. Conditional value assistance in search

This UI was generated from the following set of controls in the JSP page:<tr><td>Make:</td><td><dmfxs:searchattribute name=’make’ attribute="make"/></td>

</tr><tr><td>Model:</td><td><dmfxs:searchattribute name=’model’ attribute="model"/></td>

</tr><tr><td>Year:</td><td><dmfxs:searchattribute name=’year’ attribute="year"/><td>

</tr><tr><td>Fuel:</td><td><dmfxs:searchattribute name=’fuel’ attribute="fuel"/></td>

</tr>



Assigning relationships

Since: version 6

Effort: none

A user can create a relationship between any two documents in the repository. A user can alsodelete a relationship between two documents. This feature requires a version 6.5 Content Serverand repository.

This feature does not require migration.

Lifecycle enhancements

Since: version 6

Effort: none

Lifecycle is now displayed on the Properties Screen (part of the default attribute set). Lifecycle isexposed as a column in object lists. Users are able to apply a lifecycle on documents at creation time(and Import, Create, Checkin), or later, via the Properties screen. The process of applying a lifecycle toa document has been enhanced to include the ability to specify the initial lifecycle state and the aliasset. The current success/error messages for the lifecycle-related actions displayed on the Message Barthat involve a lifecycle state change (Apply, Detach, Promote, Demote, Suspend and Resume) will beenriched to contain pertinent information about the object lifecycle state (previous and current).

This feature does not require migration.


Chapter 8DFC, BOF and WDK ApplicationMigration to DFS

Documentum Foundation Classes (DFC), Business Object Framework (BOF), and WDK-basedapplication customizations are a part of many enterprise applications. Documentum FoundationServices (DFS) is the new EMC Documentum service-oriented architecture that facilitates applicationdevelopment and produces high quality, maintainable systems. Should existing applications migrateto DFS? There is no single answer that applies to all custom applications. Table 20, page 139 will helpyou decide whether to migrate your applications to the new service-oriented architecture. Detailsfor these decisions are provided after the table.

Table 20. Developing custom applications

Existing Custom Application Migrate to DFS Do not migrate

DFC or BOF customapplications

Can migrate to DFS if you havea web services client

No migration if you do nothave a web services client

WDK-based application Migrate if you have few UIcustomizations and a preferredweb services client

Do not migrate f you havemajor UI customizations or noweb services client

TaskSpace application Migration not recommended Continue development withWDK and BOF modules

ExistingDFC and BOF custom application — DFS does not involve rendering or application-specificlogic. DFS is a DFC client and supports all BOF customizations. DFS requires a consumer of webservices to render the UI. If your custom application uses DFC, with or without custom BOF services,it may be rewritten to use DFS if the features you use are available in DFS. You will need to build DFSservices to expose your BOF code. BOF TBOs and aspects are natively supported by DFS.

Existing DFC and BOF custom applications can be migrated to DFS if you have a web services clientto render the custom application such as Struts, JSF, ASP.NET, or Flex.

Note: BOF modules cannot consume DFS services directly.

Existing WDK-based custom application — If DFS provides feature parity and your WDK-basedapplication does not have a heavily customized UI, it can be replaced by DFS and a web servicesclient to render the custom application such as Struts, JSF, ASP.NET, or Flex. If you migrate theapplication to DFS and a web services client, you will not be able to apply service packs or futurereleases of WDK, Webtop, or the Webtop-based application.


DFC, BOF and WDK Application Migration to DFS

Heavily customized WDK-based applications would generally require much work to replace featuresusing DFS and a web services client. For new customizations of a WDK-based application, movebusiness logic to BOF modules or aspects so that they can easily be reused when you migrate toweb services at a later time.

Existing TaskSpace custom application — TaskSpace is built on WDK, so the guidelines above forWDK-based applications would apply to customized TaskSpace applications. If you migrate theapplication to DFS and a web services client, you will not be able to apply service packs or futurereleases of TaskSpace.

Developing new custom logic in your applications — Whether your existing application isDFC-based or WDK-based, you should develop custom business logic by building BOF services andaspects. When you deploy your service on the global registry, your logic is available to all applicationsusing the global registry, and your custom logic will be easily migrated to a web service in the future.

Moving an existing application to a web services UI — If you have identified a web services UIfor your custom application, you can migrate the application to DFS. Note the guidelines abovefor DFC, BOF and WDK custom applications.


Appendix A

Migrating DMCL APIs to DFC

This chapter provides information that can help you migrate a DMCL-based application to a DFCapplication. Please also consult the Documentum Foundation Classes Release Notes for any knownlimitations or exceptions to the material in this appendix.

OverviewThere are essentially three languages used to access the platform: Java, DocBasic, and C++.

If you are using Java for your customizations, they will continue to work in 6.5 and later versions.There have been no changes to the methods or interfaces of existing classes.

In previous releases, DocBasic applications accessed the DMCL via dmcl40.dll (on Windows).From version 6.5, DocBasic applications will automatically access the new dmcl.dll, which passesinstructions back and forth to DFC via an emulator.

C++ accesses DMCL through dynamic links. Applications can be configured to work with dmcl40.dll,which ships with version 6.5 and later for backward compatibility. The applications will continueto work, but they will be working with, in essence, the 6.0 version of DMCL (with some bug fixes).C++ applications using the dmcl40.dll will not have access to methods or interfaces introduced inversion 6.5 and future releases.

Methods with no corresponding DFC methodThe following methods are not implemented in DFC 6.5:• Listmessage

• Lpq

• Reset

• Unprint



Methods with corresponding DFC methodsTable 21, page 142 lists the DMCL API methods and the corresponding DFC methods. The listing isintended to help you migrate a DMCL-based application to DFC. It is not intended as a completelisting of all DFC methods.

Table 21. DMCL API methods and corresponding DFC methods

DMCL API method DFC correspondence

Interface Method name

Abort, for transactions IDfSession

IDfSessionManager

abortTrans

abortTransaction

Abort, for work flow IDfWorkflow abort

Acquire IDfWorkItem acquire

Addigsignature IDfSysObject addDigitalSignature

Addesignature IDfSysObject addESignature

Addactivity IDfProcess addActivity

Addlink IDfProcess addLink

Addnote IDfSysObject

IDfPackage

addNote

appendNote

Addpackage IDfWorkflow

IDfWorkitem

addPackage

addPackageEx

Addpackageinfo IDfActivity addPackageInfo,addPackageInfoEx

Addport IDfActivity addPort

Addrendition IDfSysObject addRendition, addRenditionEx,addRenditionEx2,addRenditionEx3,

Addroutecase IDfActivity addRouteCase, addCondition-RouteCase

Anyevents IDfSession hasEvents

Append IDfTypedObject appendBoolean, appendInt,appendDouble, appendId,appendString, appendTime,appendValue

Appendcontent IDfSysObject appendContent, appendCon-tentEx

Appendfile IDfSysObject appendFile

Appendpart IDfSysObject appendPart





Appendstate IDfPolicy appendState

Apply IDfSession, IDfQuery apply, in IDfSession

execute, in IDfQuery

Archive IDfSession archive

Assemble IDfSysObject assemble

Assume IDfSession assume

Attach IDfSysObject attachPolicy, detachPolicy

Audit IDfAuditTrailManager registerEventForType,registerEventForObject,registerEvents, registerEventsFromQuery,registerEventsInFolder

Authenticate IDfClient

IDfSession

IDfSessionManager

authenticate

Begintran IDfSession

IDfSessionManager

beginTrans

beginTransaction

Bindfile IDfSysObject bindFile

Branch IDfSysObject branch

Cachequery IDfQuery execute

Changepassword IDfSession changePassword

Checkin IDfSysObject checkin

Checkinapp IDfSysObject checkinEx

Checkout IDfSysObject checkout, checkoutEx

Close IDfCollection close

Commit IDfSession

IDfSessionManager

commitTrans

commitTransaction

Complete IDfWorkitem complete, completeEx,completeEx2

Connect IDfSessionManager

IDfClient

newSession

Count IDfTypedObject getAttrCount

Create IDfSession newObject, newObjectWithType

Createaudit IDfAuditTrailManager createAudit





Datatype IDfTypedObject getAttrDataType

Delegate IDfWorkitem delegateTask

Demote IDfSysObject demote, scheduleDemote,cancelScheduleDemote

Dequeue IDfSession dequeue

Dereference IDfReplica

IDfMirror

dereferenceReplica

dereferenceMirror

Describe IDfSession describe

Destroy IDfPersistentObject destroy

Disassemble IDfSysObject disassemble

Disconnect IDfSession

IDfSessionManager

disconnect (in IDfSession)

release (in IDfSessionManager)

Dump IDfTypedObject dump

Dumpconnection IDfSessionManager Use getStatistics method inIDfSessionManager to returnan IDfStatisticsManger object,which has the getDocbasesand getSessions methods,which return informationequivalent to that returned byDumpconnection

Dumploginticket

Encryptpass IDfClient encryptPassword

Execquery IDfQuery execute

Execsql

Execute IDfWorkflow execute

Fetch IDfSession getObject, getObjectWith-Caching

Flush IDfSession flush

Flushcache IDfSession flushCache

Flushconnectpool IDfSessionManager clearIdentities

Freeze IDfSysObject freeze





Get IDfTypedObject getBoolean, getInt, getDouble,getId, getString, getTime,getValue

getRepeatingBoolean, getRe-peatingInt, getRepeatingDouble,getRepeatingId, getRepeat-ingString, getRepeatingTime,getRepeatingValue

Getconnection IDfSessionManager newSession

Getcontent IDfSysObject getContent

Getdocbasemap IDfDocbrokerClient getDocbaseMap

getDocbaseMapFromSpecific-Docbroker

Getdocbrokermap IDfDocbrokerClient getDocbrokerMap

Getevents IDfSession getEvents

Getfile IDfSysObject getFile, getFileEx, getFileEx2

Getlastcoll IDfSession getLastCollection

Getlogin IDfSession GetLoginTicket, getLoginTicke-tEx, getLoginTicketForUser

Getmessage IDfSession getMessage

Getpath IDfSysObject getPath, getPathEx, getPathEx2

Getservermap IDfDocbrokerClient getServerMap

getServerMapFromSpecific-Docbroker

Grant IDfSysObject grant,

see also grantPermit

Halt IDfWorkflow halt, haltEx, haltAll

Id IDfSession

IDfTypedObject

getIdByQualification (inIDfSession)

getObjectId (in IDfTypedObject)

Initcrypto IDfClient initCrypto

Insert IDfTypedObject insertBoolean, insertInt,insertDouble, insertId,insertString, insertTime,insertValue

Insertcontent IDfSysObject insertContent, insertContentEx





Insertfile IDfSysObject insertFile, insertFileEx

Insertpart IDfSysObject insertPart

Insertstate IDfPolicy insertState

Install IDfActivity, IDfPolicy,IDfProcess

install

Invalidate IDfActivity, IDfPolicy,IDfProcess

invalidate

Iscached

Kill IDfSession killSession (for sessions)

flushObject (for SysObjects)

Link IDfSysObject link

Listconnection IDfSessionManager Use getStatistics method inIDfSessionManager to returnan IDfStatisticsManager object,which has the getDocbases andgetSessions methods, whichreturn information equivalent tothat returned by Listconnection

Locate IDfTypedObject findBoolean, findInt, findDouble,findId, findString, findTime,findValue

Lock IDfPersistentObject lock

Mark IDfSysObject mark

Mount IDfSysObject mount

Movestate IDfPolicy moveState

Next IDfCollection next

Offset IDfTypedObject findAttrIndex

Pause IDfWorkitem pause

Print IDfSysObject print

Promote IDfSysObject promote, schedulePromote,cancelSchedulePromote

Prune IDfSysObject prune

Publish_dd IDfSession publishDataDictionary

Purgelocal IDfSession purgeLocalFiles

Query_cmd IDfQuery execute

Query IDfQuery execute





Queue IDfSysObject

IDfWorkflow

IDfWorkitem

queue

Readquery IDfQuery execute

Refresh IDfReplica

IDfMirror

refreshReplica

refreshMirror

Register IDfSysObject registerEvent

Reinit IDfSession reinit

Remove IDfTypedObject remove

Removeactivity IDfProcess removeActivity

Removecontent IDfSysObject removeContent

Removelink IDfProcess removeLink

Removenote IDfSysObject removeNote

Removepackage IDfWorkitem removePackage

Removepackageinfo IDfActivity removePackageInfo

Removepart IDfSysObject removePart

Removeport IDfActivity removePort

Removerendition IDfSysObject removeRendition,removeRenditionEx,removeRenditionEx2

Removeroutecase IDfActivity removeRouteCase

Removestate IDfActivity removeState

Repeat IDfWorkitem repeat

Repeating IDfTypedObject isAttrRepeating

Resolvealias IDfSysObject

IDfSession

resolveAlias

Restart IDfSession

IDfWorkflow

restart

restartAll (for work flow)

Restore IDfSession restore





Resume for lifecycles: IDfSysObject

IDfworkflow

IDfWorkitem

resume, scheduleResume,cancelScheduleResume(IDfSysObject)

resume, resumeAll(IDfWorkflow)

resume (IDfWorkitem)

Retrieve IDfSession

IDfTypedObject

getIdByQualification (inIDfSession)

getObjectId (in IDfTypedObject)

Revert IDfPersistentObject revert

Revoke IDfSysObject revoke

see also revokePermit

Save IDfPersistentObject save

Saveasnew IDfSysObject saveAsNew

Seek IDfContentCollection seek, seekEx

Set IDfTypedObject setBoolean, setInt, setDouble,setId, setString, setTime, setValue

setRepeatingBoolean, setRe-peatingInt, setRepeatingDouble,setRepeatingId, setRepeat-ingString, setRepeatingTime,setRepeatingValue

Setbatchhint IDfSession setBatchHint

Setcontent IDfSysObject setContent, setContentEx,setContentEx2

Setcontentattrs setContentAttrs

Setdoc IDfSysObject setIsVirtualDocument

Setfile IDfSysObject setFile, setFileEx

Setoutput IDfWorkitem setOutput, setOutputByActivi-ties

Setpath IDfSysObject setPath

Setperformers IDfWorkflow setPerformers

Setpriority IDfWorkitem setPriority

Setsupervisor IDfWorkflow updateSupervisorName

Shutdown IDfSession shutdown

Signoff IDfPersistentObject signoff





Suspend IDfSysObject suspend, scheduleSuspend,cancelScheduleSuspend

Trace IDfSession TraceDMCL

Truncate IDfTypedObject removeAll, truncate

Type IDfSession getTypeDescription

Unaudit IDfAuditTrailManager unRegisterEvent,unRegisterEventForType,unregisterEvents,unRegisterEventsFromQuery,unRegisterEventsInFolder,unRegisterAllEvents

Unfreeze IDfSysObject unfreeze

Uninstall IDfActivity, IDfPolicy,IDfProcess

uninstall

Unlink IDfSysObject unLink

Unlock IDfSysObject cancelCheckOut

Unmark IDfSysObject unMark

Unregister IDfSysObject unRegisterEvent

Updatepart IDfSysObject updatePart, updatePartEx

Useacl IDfSysObject useACL

Validate IDfActivity, IDfPolicy,IDfProcess

validate, validateProcessAndAc-tivities

Values IDfTypedObject getValueCount

Vdmpath IDfObjectPath getAccessPath, getAccessible-FolderIds

Vdmpathdql IDfObjectPath getAccessPath, getAccessible-FolderIds

Verifyaudit IDfPersistentObject verifyAudit

Verifyesignature IDfSysObject verifySignature




Appendix B

Object Type and Property Changes forversion 6.5 SPx

These tables describe types and properties that are new, changed, deprecated, or obsolete in version6.5 SPx.

New object typesTable 22, page 151 lists the new object types for version 6.5.

Table 22. New Object Types

Type Name Description

dm_bocs_config Records configuration information for a BOCS server

dm_client_registration Records a client instance’s registration, for use in authorizingpermission and privilege escalation requests

dm_client_rights Records the privileged roles a client instance is allowed to assert.

dm_cont_transfer_config Defines content transfer capabilities for a distributed environment

dmc_class Added with Smart Container DAR file.

dmc_constraint_set Added with Smart Container DAR file.

dmc_metamodel Added with Smart Container DAR file.

dm_dms_config Records configuration information for a DMS server

dm_lightweight Serves as a supertype for all user-defined lightweight object types.This is a ’pseudo’ type in that there are no repository tables for thistype and instances of this type cannot be created.

This type is only for internal use in 6.5.

dm_message_route_user_data

Records route-specific user information for an email message

dm_validation_descriptor Used internally in distributed environments

dmc_preset_package Installed with the Preset DAR file during repository configuration.Used by WDK-based applications


Object Type and Property Changes for version 6.5 SPx


dmc_preset_info Installed with the Preset DAR file during repository configuration.Used by WDK-based applications

dmc_relationship_def Defines a relationship. This provides a higher level of abstractionfor relationships, allowing easier management and querying ofrelationships by applications.

dmc_scope_config_relation

Installed with the Preset DAR file during repository configuration.Used by WDK-based applications

The following object typesare added to support anew workflow feature:

dmc_wfsd_elementdmc_wfsd_element_booleandmc_wfsd_element_datedmc_wfsd_element_doubledmc_wfsd_element_integerdmc_wfsd_element_stringdmc_wfsd_parentdmc_type_infodmc_wfsdrp_booleandmc_wfsdrp_datedmc_wfsdrp_doubledmc_wfsdrp_integerdmc_wfsdrp_stringdmc_wfsdrp_parent

These types support the ability to add structured data to a workflow.

The following typesare added to supportCollaboration Services:

dmc_calendardmc_calendar_eventdmc_datatabledmc_datatable_rowdmc_datatable_schemadmc_datatable_settings

These types are installed with the Collaboration Services DocApp.




dmc_xfm_adaptor_config Records information about a forms adaptor.

The following newtypes of the audittrailimprovement project areadded for version 6.5 SP3:

dm_audit_policy

dmi_audittrail_asp_attrs

Note: The new audittrailimprovement types arecreated after executing thefollowing Docbasic script,in the content server:

%DM_HOME%\bin\dm_

ondemand_schema_

changes.ebs

A persistent type that stores audit purge policies.

A new type that stores audit information about aspect attributechanges that are attached to objects.

Changed object typesTable 23, page 153 lists the changes to existing types.

Table 23. Changed Object Types


dm_acs_config Added the following properties:• server_major_version

• server_minor_version

Modified the following properties:• acs_rw_capability

• is_cache_acs




dm_activity Added the following properties:• activity_group_flag

• activity_group_id

• exec_retry_interval

• exec_retry_max

• post_timer_calendar_flag

• post_timer_calendar_id

• pre_timer_calendar_flag

• pre_timer_calendar_id

• r_performer_cond_id

• r_performer_cond_name

• r_performer_cond_user

• r_port_type, from string(8) to string(16)

• sd_element_flag

• sd_element_name

The following string properties were lengthened to 128:• r_package_name

• resolve_pkg_name

The following properties have new values added to their valid values:• exec_err_handling

• exec_subtype

dm_aspect_type Added the following properties:• i_attr_def

• is_data_shared

dm_audittrail Added the following property:• attribute_list_old

dmi_audittrail_attrs Added the following property:• attribute_list_old

dmc_completed_workitem

Lengthened the following property:• act_name




dmr_content Added the following properties:• i_parked_state

• other_file_size

dm_dd_info Added the following property:• fulltext_support

Note: Used only for lightweight object subtypes.

The reference_kind property, previously unused, is now used byCollaboration Services for internal purposes.

dm_dd_attr_info Added the following new property:• ftindex_attrs

Note: Used only for lightweight object subtypes.

The reference_kind property, previously unused, is now used byCollaboration Services for internal purposes.

dm_docbase_config Added the following properties:• audit_old_values

• docbase_roles

• r_normal_tz

• approved_clients_only

dm_format Added the following property:• a_page_plugin_name

Modified the following property:• mime_type

This property was lengthened from 64 to 256 in 5.3 SP5.




dm_func_expr Lengthened the following property:• object_alias

dm_group Added the following properties:• i_nondyn_supergroups_names

• is_module_only

• is_protected

dm_ldap_config Added the following properties:• failover_ldap_config_ids

• failover_use_interval

• map_rejection

• retry_count

• retry_interval

Modified the following properties:• map_val_type

Added support for the value "E” (meaning expression) for thisproperty

dm_media_profile Added the following properties:• filter_names

• filter_values

• related_objects_only

• src_obj_type

dm_message_address The addr_type property was lengthened from string(1) to string(2)

dm_message_route The following property was added:• route_user_data_hash_id

dmc_module Added the following properties:• a_is_privileged

• a_privilege_roles




dm_process Added the following properties:• act_performer_from

• act_performer_rule

• act_performer_to

• calendar_id

• execution_flag

• post_timer_calendar_flag

• post_timer_calendar_id

• pre_timer_calendar_flag

• pre_timer_calendar_id

• sd_element_acl

• sd_element_default_acl

• sd_element_default_value

• sd_element_name

• sd_element_options

• sd_element_parent_id

• sd_element_type

The following string properties were lengthened to 128:• act_choose_by

• act_choose_for

• act_choose_name

• r_link_dest_act

• r_link_src_act

dm_public_key_certificate Modified the following properties:• key_type

• private_key_identifier

dmi_queue_item Lengthened the following property:• task_name




dm_relation_type Added the following property:• a_controlling_kind

dm_retainer Added the following property:• aging_method

dmc_routecase_condition Lengthened the following property:• a_object_alias

dm_smart_list Added the following new properties:• has_results

• query_type

• results_count

• selected_sources

dm_sysobject The a_extended_properties property is no longer used to record theobject ID of the room governing the object if the object is in a room. ASysObject’s governing room is now recorded in the a_gov_room_idproperty, which is an aspect property associated with the SysObjectwhen the Sysobject is placed in the room.

dmc_transition_condition Lengthened the following property:• r_object_alias

dm_type Added the following new properties:• attr_identifier

• attr_restriction

• next_attr_identifier

• type_category

dmi_type_info Added the following new properties:• i_type_features

• type_version

• default_aspects

dmc_aspect_type Added the following new properties:• i_attr_def

• is_data_shared




dm_workflow Added the following new properties:• correlation_identifer

• initiate_act

• parent_act_name

• parent_act_seqno

• parent_id

The following string properties were lengthened to 128:• r_act_name

• r_perf_act_name

dmi_workitem Added the following properties:• r_exec_retried_count

• r_handling_instruction

• r_next_retry_date

• r_target_task_id

The following string property was lengthened to 128:• r_runtime_state

dmc_workqueue Lengthened the following string property to 128:• package_name

dmc_wf_package_skill Added the following new property:• skill_info_ids

dmi_wf_timer Added the following new properties:• r_calendar_id

• r_calendar_status

Lengthened the following string property to 128:• r_act_name

dmc_workqueue_policy Added the following new properties:• calendar_id

• increment_priority_method

• increment_priority_mode

scs_admin_config Added the following properties:• is_scs_advanced

• aspera_tcp_port




dm_webc_config Added the following properties:• ingestion_directory

• last_failed_ingest_dir

dm_webc_target Added the following properties:• export_properties

• last_publish_dir

• replication_status

• system_validate

• target_udp_port

• target_ingestion_directory

• ingest

• ingestion_status

Deprecated or obsolete propertiesTable 24, page 160 lists the persistent properties that are either deprecated or obsolete from version6.5 and later.

Table 24. Deprecated and obsolete properties

Object type Property Deprecated or obsolete

session config docbase_scope obsolete

Table 25, page 160 lists the computed properties that are either deprecated or obsolete from version6.5.

Table 25. Deprecated and obsolete computed properties

Object type Property Deprecated or obsolete

_content_buffer S obsolete

Properties added conditionallyThe properties listed in Table 26, page 161 are only added to an object type under certain conditions.The description of each property explains the property’s use and the conditions under which itappears in a object type definition.



Table 26. Properties added conditionally

Property Datatype Single/ repeating Description

i_shared_status integer S This property is added to theobject type definitions of typesthat are created as shareabletypes. Only dm_sysobject or itssubtypes can be shareable types.

Note: Shareable types arecurrently only used internally.Users and applications cannotcreate shareable types.

The property indicates whetheran instance of the object typeis shared by any lightweightobject. Valid values are:

0, the object is not shared

1, the object is shared

i_property_bag string(2000) S This property is added to anobject type if the type definitioncontains a NONQUALIFIABLEproperty. The property can alsobe explicitly added by alteringthe object type.

The property stores thenames and values ofNONQUALIFIABLEproperties.It is also used to store thenames and values of aspectproperties if the properties areadded to the aspect with theOPTIMIZEFETCH option.

r_property_bag string(2000) S This property is added to anobject type if the type definitioncontains a NONQUALIFIABLEproperty. Altering a type toadd i_property_bag also addsr_property_bag automatically.

This property stores anyoverflow from i_property_bag.



Deprecated or obsolete object typesTable 27, page 162 lists the changes to existing types.

Table 27. Deprecated or Obsolete Object Types

Type Name Deprecated Obsolete

dmi_linkrecord X

dm_linked_store X

dm_router X

enable_workitem_mgmt Boolean Previously used to enableworkqueue use

Changed propertiesThe implementation of the local_diskfull_limit property in the non-persistent objects that define asession configuration’s configuration has changed. Previously, the limit specified in this propertywas expressed as a percentage. From version 6.5, the limit value is now expressed as a number ofmegabytes.

Valid values are now from 0 and 100. Values from 1 to 100 are interpreted as megabytes. For example,a value of 50 means that the client local area is limited to 50MB in size. A value of 0 means thatthe size is unlimited.


Appendix C

Deployment Settings in WDK-basedApplication Deployment

These tables list the mandatory and optional configuration elements that can be set before, during,and after deployment of WDK-based applications. Because WDK-based applications encapsulateDFC, you can also configure DFC settings as described in dfcfull.properties located in theWEB-INF/classes directory of the WDK-based application. Functions marked with an asterisk (*)must be performed for every deployment.

Table 28, page 163 lists the configuration elements that must be set before deploying a WDK-basedapplication, such as Webtop or TaskSpace. Not all of these elements must be set for every deployment,but if you wish to support the function in the first column, you must enable it before deployment.Refer toWeb Development Kit and Webtop Deployment Guide for more information on these settings.

Table 28. Mandatory configuration before deployment

Function Element Location

Turn off tag pooling (Tomcat,Oracle)*

servlet.init-param web.xml

Global registry indications* dfc.docbroker.hostdfc.globalregistry.repositorydfc.globalregistry.usernamedfc.globalregistry.password

dfc.properties inWEB-INF/classes

WAS compiler and classloader* Classloader orderuseJDKCompiler

WAS admin console

Table 29, page 163 lists the optional configuration settings that can be set before deployment.

Table 29. Optional configuration before deployment


WAS failover NoAffinitySwitchBack WAS cluster configuration

WAS global security Security policies andenvironment variables

Download from Powerlink ifneeded

UCF to use file, not Windowsregistry

registry.mode ucf.installer.config.xml


Deployment Settings in WDK-based Application Deployment


Default content transferdirectories for client

option ucf.installer.config.xml

Unsigned SSL certificates option ucf.installer.config.xml

Proxy servers http11.chunked.transfer ucf.server.config.xml inWEB-INF/classes

Set content transfer modeAdd filter for groups

contentxfer.default-mechanismcontentxfer.mechanism

custom/app.xml

Change ACS and BOCSbehavior

contentxfer.accelerated-readcontentxfer.accelerated-write

custom/app.xml

Locale settings language custom/app.xml

Java EE principalauthentication

principal credentials

securityconstraint

TrustedAuthenticator-Credentials.properties inWEB-INF/classes/com/docu-mentum/web/formext/sessionweb.xml in WEB-INF

Table 30, page 164 lists the configuration settings that can be changed after deployment. Fornon-deployment related configuration, refer toWDK and Webtop Reference Guide. This guide lists allconfigurable elements in WDK and configuration files and tag libraries and notes in which releasethe change was introduced.

Table 30. Optional configuration after deployment


App server timeout sessionconfig web.xml in WEB-INF

Cached pages init-param web.xml in WEB-INF

DCS support in Webtop collaborationsupport custom/app.xml

Deep export deepexport custom/app.xml

Default repository authentication.docbase custom/app.xml

Email message archive messageArchive-support custom/app.xml

Enable accessibility accessibility custom/app.xml

Encrypt passwords fordrl, drlauthenticate, andvirtuallinkconnect

com.documentum.web.formext.session.TrustedAuthenticatorTool

Failover: turn off failover.enabled custom/app.xml

IRM support irm-support custom/app.xml

Lightweight sysobject parentdisplay

lightweight-sysobject custom/app.xml

Modal popup modalpopup custom/app.xml

Preferences repository (default= global registry)

preferencesrepository custom/app.xml




Presets repository (default =global registry)

presets custom/app.xml

Saved credentials save_credentials custom/app.xml

Scan Microsoft formats forlinked objects

embedded-links-scan custom/app.xml

Timeout warning timeout_control custom/app.xml

UCF mechanism contentxfer custom/app.xml




Appendix D

Changes to Webtop CascadingStylesheets

The majority of styles used in Webtop are defined in webforms.css. To see new styles that you canuse in your JSP pages, you can use a differencing utility to compare the stylesheets from your oldapplication to the 6.5 application.

The following selectors were removed from webforms.css:.buttonLinkfont-family: Trebuchet MS, Verdana, GillSans, Arial;color: #333333;text-decoration: none;font-size: 12px;line-height: 14px;font-weight: normal;.buttonDisabledLinkcolor: #999999;font-family: Trebuchet MS, Verdana, GillSans, Arial;text-decoration: none;font-size: 12px;line-height: 14px;.actionButtonLinkfont-family: Trebuchet MS, Verdana, GillSans, Arial;color: #333333;text-decoration: none;font-size: 12px;line-height: 14px;font-weight: normal;.actionButtonDisabledLinkcolor: #999999;font-family: Trebuchet MS, Verdana, GillSans, Arial;text-decoration: none;font-size: 12px;line-height: 14px;font-weight: normal;


Changes to Webtop Cascading Stylesheets

.bannerboxbackground: white url("../images/banner/top_left.gif") no-repeat topleft;


Appendix E

dfc.properties

These topics are included:• Overview, page 169

• Changes to existing key names, page 169

• dmcl.ini key migration to dfc.properties, page 172

• Obsolete dmcl.ini and session configuration options, page 173

• Obsolete dfc.properties keys, page 175

OverviewIn version 6, DFC replaced the Server API as the API for Content Server. As part of this change,the dmcl.ini file became obsolete and its relevant entries were migrated to the dfc.properties file.In addition, the naming conventions for entries in the dfc.properties file were standardized. Thisappendix describes the changes to the dfc.properties file.

Changes to existing key namesTable 31, page 169, describes the changes to existing key names. Both new and old names are listed.For backward compatibility, both new and old names continue to work in versions 6.5 and later.Invalid entries do not generate an error, but have no effect on functionality.

Table 31. Name changes for existing dfc.properties for version 6.5 SPx and dfc.new properties

Old name New name

dfc.acs.avail.refresh.frequency dfc.acs.avail.refresh_interval

dfc.acs.config.refresh.frequency dfc.acs.config.refresh_interval

dfc.acs.network_location.refresh.frequency dfc.acs.network_location.refresh_interval

dfc.admin.ldif.file.charset dfc.admin.ldif_file_charset

dfc.appledouble.resource.file.extension dfc.appledouble.resource_file_extension

dfc.cacs.check.http.method dfc.bocs.check.http_method


dfc.properties

Old name New name

dfc.cacs.check.keep.number dfc.bocs.check.keep_number

dfc.bocs.config.refresh.frequency dfc.bocs.config.refresh_interval

dfc.cache.append.name dfc.bof.cache.append_name

dfc.bof.cacheconsistency.interval dfc.bof.cache.currency_check_interval

dfc.bof.registry.connect.attempt.interval dfc.globalregistry.connect_attempt_.interval

dfc.bof.registry.preload.enabled dfc.bof.cache.enable_preload

dfc.bof.registry.password dfc.globalregistry.password

dfc.bof.registry.repository dfc.globalregistry.repository

dfc.bof.registry.username dfc.globalregistry.username

dfc.cache.ddinfo.globalCacheSize dfc.cache.ddinfo.size

dfc.cache.dir dfc.cache_dir

dfc.cache.object.globalCacheSize dfc.cache.object.size

dfc.cache.query.globalCacheSize dfc.cache.query.size

dfc.core.truncate_long_values dfc.compatibility.truncate_long_values

dfc.config.timeout dfc.config.check_interval

dfc.checkout.dir dfc.data.checkout_dir

dfc.data.dir dfc.data.dir

dfc.docbase.max_deadlock_retries dfc.session.max_deadlock_retries

dfc.docbase.max_error_retries dfc.session.max_error_retries

dfc.exception.include_decoration No change

dfc.exception.include_id No change

dfc.exception.include_stack No change

dfc.export.dir dfc.data.export_dir

dfc.housekeeping.cleanup.interval dfc.resources.cleanup_interval

dfc.max.vdm.children.flush.count dfc.vdm.max_children_flush_count

dfc.recordInlineDescendants dfc.xml.record_inline_descendants

dfc.registry.file No change

dfc.registry.mode No change

dfc.resources.diagnostics.enabled dfc.diagnostics.resources.enable

dfc.search.docbase.brokers dfc.search.docbase.broker_count

dfc.search.ecis.adapter.domain dfc.search.external_sources.adapter.domain

dfc.search.ecis.broker_count dfc.search.external_sources.broker_count

dfc.search.ecis.enable dfc.search.external_sources.enable

dfc.search.ecis.host dfc.search.external_sources.host

dfc.search.ecis.password dfc.search.external_sources.password


dfc.properties

Old name New name

dfc.search.ecis.port dfc.search.external_sources.port

dfc.search.ecis.request_timeout dfc.search.external_sources.request_timeout

dfc.search.ecis.rmi_name dfc.search.external_sources.rmi_name

dfc.search.ecis.username dfc.search.external_sources.username

dfc.search.formatcache.timeout dfc.search.formatcache.refresh_interval

dfc.search.fulltext.enabled dfc.search.fulltext.enable

dfc.search.ecis.max.results dfc.search.ecis.max_results

dfc.search.sourcecache.timeout dfc.search.sourcecache.refresh_interval

dfc.search.typecache.timeout dfc.search.typecache.refresh_interval

None dfc.search.matching_terms_computing.enable

dfc.session.dynamic_delay No change

dfc.session.pool.enabled dfc.session.pool.enable

dfc.session.pool.timeout dfc.session.pool.expiration_interval

dfc.session.surrogate.check.interval dfc.session.surrogate.check_interval

dfc.session.surrogate.mode No change

dfc.storagepolicy.diagnostics.enabled dfc.diagnostics.storagepolicy.enable

dfc.storagepolicy.ignore.rule.errors dfc.storagepolicy.ignore_rule_errors

dfc.storagepolicy.validation.interval dfc.storagepolicy.validation_interval

dfc.strictURI dfc.xml.use_strict_uri

dfc.tracing.baseTraceFileName dfc.tracing.file_prefix

dfc.tracing.compactModeBufferSize dfc.tracing.compact_mode_buffer_size

dfc.tracing.enabled dfc.tracing.enable

dfc.tracing.entrancePointExprs dfc.tracing.method_name_filter

dfc.tracing.loggingMode dfc.tracing.file_creation_mode

dfc.tracing.maxFileSize dfc.tracing.max_file_size

dfc.tracing.maxThreadsToTrace dfc.tracing.max_threads_to_trace

dfc.tracing.maxUsersToTrace dfc.tracing.max_users_to_trace

dfc.tracing.mode No change

dfc.tracng.rpcCountingEnabled dfc.tracing.display_rpc_count

dfc.tracing.scriptableMethodsMarked dfc.tracing.display_scriptable_mark

dfc.tracing.stackDepth dfc.tracing.max_stack_depth

dfc.tracing.threadNameExprs dfc.tracing.thread_name_filter

dfc.tracing.timestampDateFormat dfc.tracing.date_format

dfc.tracing.timingStyle dfc.tracing.timing_style


dfc.properties

Old name New name

dfc.tracing.traceFileDirectory dfc.tracing.dir

dfc.tracing.userNameExprs dfc.tracing.user_name_filter

dfc.user.dir dfc.data.user_dir

dfc.validation.expr.currency.check dfc.validation.expr.currency_check_interval

dfc.validation.expr.debug.all No change

dfc.validation.expr.debug.code No change

dfc.validation.expr.debug.eval No change

dfc.validation.expr.debug.tree No change

dfc.validation.expr.disable_java No change

dfc.validation.overrides.currency.check dfc.validaton.overrides.currency_check_interval

Note: Compatibility is ensured with previous properties that refer to "ecis”.

dmcl.ini key migration to dfc.propertiesTable 32, page 172 describes the dmcl.ini keys that migrated to the dfc.properties file in version 6.5.

Table 32. dfc.properties keys migrated from dmcl.ini file

dmcl.ini key Corresponding new dfc.properties key

application_code dfc.application_code

auto_request_forward dfc.docbroker.auto_request_forward

batch_hint_size dfc.batch_hint_size

backup_host dfc.docbroker.host

backup_port dfc.docbroker.port

backup_protocol dfc.docbroker.protocol

backup_service dfc.docbroker.service

backup_timeout dfc.docbroker.timeout

castore_write_max_attempts dfc.content.castore_max_write_attempts

castore_write_sleep_interval dfc.content.castore.write_sleep_interval

client_date_format dfc.date_format

client_locale dfc.locale

connect_pooling_enabled dfc.session.pool.enable

connect_retry_interval dfc.session.connect_retry_interval

connect_retry_limit dfc.session.connect_retry_limit

debug_dbid dfc.docbroker.debug.docbase_id


dfc.properties

dmcl.ini key Corresponding new dfc.properties key

debug_host dfc.docbroker.debug.host

debug_port dfc.docbroker.debug.port

debug_service dfc.docbroker.debug.service

docbroker_search_order dfc.docbroker.search_order

ini_file_path dfc.config.file

local_clean_on_init dfc.data.local_clean_on_init

local_diskfull_check dfc.data.diskfull_check

local_diskfull_limit dfc.data.local_diskfull_limit

local_path dfc.data.local_dir

local_purge_on_diskfull dfc.data.local_purge_on_diskfull

max_collection_count dfc.session.max_collection_count

max_session_count dfc.session.max_session_count

primary_host dfc.docbroker.host

primary_port dfc.docbroker.port

primary_protocol dfc.docbroker.protocol

primary_service dfc.docbroker.service

primary_timeout dfc.docbroker.timeout

re_binding_label dfc.reference.binding_label

secure_connect_default dfc.session.secure_connect_default

token_storage_path dfc.tokenstorage.dir

token_storage_enabled dfc.tokenstorage.enable

umask dfc.data.umask

use_compression dfc.content.use_compression

use_content_server dfc.content.use_content_server

Obsolete dmcl.ini and session configurationoptionsTable 33, page 174 lists the dmcl.ini keys that are obsolete in 6.5 and later versions, and have noequivalent to set in dfc.properties. It also lists properties formerly present in the session configurationobjects that are obsolete in version 6.5 and later.


dfc.properties

Table 33. Obsolete session configuration options

Entry Source Comments

block_during_rpc dmcl.ini Is specific to native codeDMCL.

client_codepage dmcl.ini none

client_os_codepage dmcl.ini none

connect_callback_enabled api config and session configobjects

none

connect_failure_callback api config and session configobjects

none

connect_failure_data api config and session configobjects

none

connect_success_callback api config and session configobjects

none

connect_success_data api config and session configobjects

none

content_callback_data api config and session configobjects

none

content_callback_function api config and session configobjects

none

local_diskfull_warn dmcl.ini none

network_callback_data api config and session configobjects

none

network_callback_function api config and session configobjects

none

new_connection_callback none

new_connection_data none

nfs_enabled dmcl.ini

r_trace_file dmcl.ini Replaced by new tracingimplementation—refer to theContent Server AdministrationGuide for information.

r_trace_level dmcl.ini Replaced by new tracingimplementation—refer to theContent Server AdministrationGuide for information.

client_cache_size dmcl.ini Implementation now allowsper-session caches todynamically adapt to freememory.

connect_timeout dmcl.ini Is specific to native codeDMCL.

connect_recycle_interval dmcl.ini Is specific to native codeDMCL.


dfc.properties


exception_count Is specific to native codeDMCL.

exception_count_interval Is specific to native codeDMCL.

terminate_on_exception Is specific to native codeDMCL.

i_override_list

cache_queries

max_connection_per_session

use_local_always dmcl.ini Option to use server commonarea is not available in DFC 6.5,so this becomes unneeded

use_local_on_copy dmcl.ini Option to use server commonarea is not available in DFC 6.5,so this becomes unneeded

Obsolete dfc.properties keysTable 34, page 175 lists the dfc.properties keys that are obsolete in 6.5 and later versions. Settingthese keys have no effect on DFC 6.5 and later.

Table 34. Obsolete dfc.properties keys


dfc.tracing.combineDMCL dfc.properties Replaced by new tracingimplementation—refer to theContent Server AdministrationGuide for information.

dfc.tracing.compactMode dfc.properties Replaced by new tracingimplementation—refer to theContent Server AdministrationGuide for information.

dfc.tracing.recordParameters dfc.properties Replaced by new tracingimplementation—refer to theContent Server AdministrationGuide for information.

dfc.tracing.recordReturnValue dfc.properties Replaced by new tracingimplementation—refer to the


dfc.properties

Entry Source CommentsContent Server AdministrationGuide for information.


Index

AACS

configuration, 134attribute, 25auto complete, 126

BBOCS

configuration, 134BOF, 92BOF2 modules

migrating, 89

CCHANGE...OBJECT statement, 28CLEAN_LINKS, 26client compatibility

matrix, 48<client_warning_session_timeout>, 98column resizing, 117compatibility

DCM, 86IRM Services for DCTM, 85matrix, 42

conditional value assistance, 137configuration

WDK, 163configuration service extensions, 100configuring

DCS support, 108consistency checker utility, 87content server

upgrade matrix, 43Content Server

listener queue length, configuring, 29content store

changing location, 17content transfer applet, 135

Ddatabase

changing location, 17changing version, 17

datacolumnbeginswith, 128datagrid enhancements, 114date literals, 28DCM

compatibility, 86DCS support

configuring, 108enabling, 108

deep export, enabling, 131DFC classes

migration, 91dfc.compatibility.truncate_long_values, 26dfc.machine.id, 26dfc.properties, 26 to 27dfc.session.allow_trusted_login, 28DFS, migration to, 139differences

DFC Java classes, 91WDK Java classes, 97

dm_bof_registry, 33dm_extern_file, 27dm_linkedstore, 26dm_startedworkitem, 26dmcl.ini-keys, 27dmi_linkrecord, 26DocApps

migrating, 89DocList component, 117DQL

CHANGE...OBJECT statement, 28date literals, 28migrating content, 89POSITION keyword, 28

drag and drop, 129dump and load, 17dynamic filters, 128


Index

Eemail migration

introduction, 96EMCMF

displaying, 109enable_workitem_mgmt (server.ini

key), 29enabling

DCS support, 108export, deep, 131

Ffixed column headers, 117fixed menus, 101

Gglobal registry

defined, 33

Hhotkeys, 119

key combination map, 122XML definition, 121

<hotkeys>, 121HotKeysNlsProp, 122

IIDfSession.setServerTraceLevel, 29insertbefore, 100installation order

new system, 12IPv4 configuration, 91IRM Services for DCTM

compatibility, 85IRM support, 108

Kkeyboard shortcuts, 119

LLDIF file, 27lifecycle, 138lightweight sysobjects

migrating to, 25support in WDK, 111

linked store storage areas, 26listener_queue_length, 29listener_queue_length (server.ini key), 29login tickets

backwards compatibility, 88LWSO

support in WDK, 111LWSOs

migrating to, 25

Mmatrix

client compatibility, 48compatibility, 42upgrade, 42

max_backup_index, 27max_file_size, 27memory

application server usage, 20DFC usage, 20

<menu>, 101menus

fixed, 101migrating

BOF2 and DocApps, 89migrating content with DQL, 89migration

overview, 12modal popuup. See pop-up, modalmodules

migrating, 89

Ooptical storage devices, 27

Pperformance

planning, 20Server, common problems, 21web application, 22

planning worksheetapplication server host, 31

Planning worksheetclient machine, 31Content Server host, 30customized components, 32index server host, 31

pop-up, modal


Index

disabling, 104 to 105invoking, 104overview, 104refresh parent, 106window.location.replace, 108

POSITION keyword, 28preference persistence, 129presets, 99

Qquery

performance enhancement, 22

Rrelationships, 138renditions

viewing application per user, 134repositories

upgrade multiple, 25resizeable columns, 117right-click menus, 118row selection, 115

Ssafe harbor, 9SBO, 92server.ini file

enable_workitem_mgmt key, 29server_login_ticket_version (server.ini

key), 88shortcuts

key combination map, 122showifinvalid, 129showinvalidactions, 129

Streamline, 135SYNC_REPLICA_RECORDS, 27system

sizing, 19system updates

order, 13

Ttab order, 125TBO, 92themes, 135timeout warning, 98Toolbar component, 119tracing, memory

DFC, 20

Uupgrade

matrix, 42multiple repositories, 25overview, 11

upgrade matrixfor content server, 43

Vvalue assistance, conditional, 137

WWDK classes

migration, 97work flow

enable_workitem_mgmt (server.inikey), 29