Product: Open Text eDOCS DM

Version: 5.1.0.5
Task/Topic: Administration, Features and Functionality
Audience: General
Platform: Microsoft Windows
Document ID: 134051
Updated: 2009-09-22

Application Note
Open eDOCS DM Server 5.1.0.5 -
Content Cache and the Lazy Write
Feature
 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

Contents
Summary ...................................................................................................................... 1
DM Server Content Cache and the Lazy Write Feature ........................................... 2
How Content Cache and Lazy Write Work ............................................................. 2
DM Server Content Cache ............................................................................... 2
Lazy Write ........................................................................................................ 3
How Long Documents Remain in the Cache Directory .......................................... 4
How to Enable Content Cache and the Lazy Write Feature .................................... 6
Installation Instructions: ................................................................................... 6
Administration and Maintenance .............................................................................. 9
Content Cache Parameters Used to Manage the Internal Upload
Process ...................................................................................................... 9
Content Cache in a Clustered Environment .................................................... 9
Tips and Troubleshooting ..................................................................................... 10
Documents Failed to Upload to the Content Cache ...................................... 10
Files Appear in the Cache That Exceed the "Days to keep" Setting ............. 10
Content Cache Logging ........................................................................................ 10

Champion Toolkit Document www.opentext.com

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

Summary
This document includes information on DM Server Content Cache and the Content
Cache Lazy Write feature in DM 5.1.0.5 and supplements the existing documentation
in the DM 5.1.0.5 Administration Guide.

Champion Toolkit Document www.opentext.com 1

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

DM Server Content Cache and the Lazy Write

Feature
DM Server Content Cache was designed to help reduce the transfer of content where
eDOCS DM may be deployed in a distributed environment, giving users faster access
to the documents they need by providing local access to centralized content. Content
Cache is most beneficial if you are accessing documents over a wide-area network
(WAN).
In a centralized implementation of eDOCS DM, all documents are stored in a single
geographical location. This means the eDOCS DM repository back-end components,
such as the SQL server, document server, and full-text indexes reside in the same
geographical location. Downloading documents from within this centralized
environment usually poses no problems for end users; however, connections
between remote offices might not be as efficient, resulting in slow file retrieval. With
content caching enabled, when a user requests a document, it can be retrieved from
a local cache directory, eliminating transmission time across the WAN.

IMPORTANT! DM Server Content Cache does require a separate

license key and activation code.

The Lazy Write feature was added to Content Cache in DM 5.1.0.5 SR6. This feature
enhances performance when users in remote offices save documents. Instead of
having to wait for documents to be transferred back to the DM Server, the documents
are immediately released back to the users while synchronization is being performed.
NOTE: In DM 6.0.x, the Lazy Write feature is built in to the Content Cache
functionality and does not need to be enabled. For more information on Content
Cache in DM 6.0.x, please refer to the DM 6.0.1 DM and RM Administration Guide.

How Content Cache and Lazy Write Work

DM Server Content Cache

When the Content Cache feature is enabled, and a user requests a document, DM
Server retrieves the document from the document server as usual, but it also stores a
copy on a local share designated as the content cache. The content cache location
can be any share or server accessible via UNC file naming convention, with a few
exceptions. The process of uploading a content file to the cache is performed by a
background thread. This allows the upload to occur without impacting the user. Once
the file upload is complete, the thread terminates. The next time the user requests
the same document, DM Server retrieves it from the Content Cache directory rather
than from the document server, thus eliminating transmission time across the WAN.
A non-cached read of document content occurs if ONE of the following conditions is
true:

Champion Toolkit Document www.opentext.com 2

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

• Content caching is disabled.

• The content for the requested document is not in the cache.
• The modified date time stamp of the cached version of the document content
is not equal to the modified date time stamp of the version on the document
server.
When a non-cached read is detected, the content data file is queued for addition to
the cache.
A cached read of document content occurs if ALL of the following conditions are true:
• Content caching is enabled.
• The content for the requested document is in the cache.
• The modified date time stamp of the cached version of the document content
is equal to the modified date time stamp of the version on the document
server.
To ensure that the user receives the latest version of the document, DM Server
verifies that the last write date on the two versions is the same. If these time stamps
do not match, because for example another user has made subsequent edits to the
document, DM Server retrieves the document from the document server rather than
from the Content Cache directory. If the appropriate content file is found, the file UNC
path is redirected to point to the cached file instead of the file one the document
server. Document updates are automatically synchronized between the source
repository and the content cache location, ensuring users access to the most recent
version of the document regardless of their location. If the document on the
document server has a status of Checked Out, DM Server retrieves the version from
the content cache if the last write dates of the two versions are the same. However,
the document will be delivered in read-only format, as is usual with checked out
documents.
Because some environments have users in multiple time zones, files are stored and
retrieved based on Microsoft's universal time zone structure, which automatically files
dates and times across time zones.
Cached content files are stored within the cache physical location/directory using a
structure that mirrors the documents file path on the document server. The cache
implementation replaces the server name segment of the files document server UNC
path with the cache location parameter. The remaining directory structure of files’
UNC path (as it exists on the document server) is constructed under the cache
location directory.

Lazy Write
With the Lazy Write feature enabled, any edits made by the user are stored in the
Content Cache directory, and the user has immediate access to the document
without waiting while the document is uploaded to the document server. Once the
upload to cache process has been completed, a background thread will be initiated to
"lazily" upload the content file to the document server. The document is uploaded to
the document server on each save and close. If Quick Saves is enabled in an
application, the document is only uploaded to the document server when the

Champion Toolkit Document www.opentext.com 3

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

document is closed. When using DM Attaché, if you check in an edited document, the
document is copied to the Content Cache directory as well as the document server.
Two new version-level status values have been created to indicate that the content
file associated with the document version is in the process of being uploaded or that
the upload has failed. They are as follows:
22 – STATUS_CACHE_UPLOAD_IN_PROGRESS
AND
23 – STATUS_CACHE_UPLOAD_FAILED.
These status values are set at the version level because Upload activity is version-
relative and can happen as the result of a number of activities. In the case of a Save
As operation, the document status will remain LOCKED and cannot be changed to
indicate the Upload activity.
In addition, there are three Content Cache parameters used to manage the internal
Upload process; "Upload Timeout," "Retry Count," and "Retry Interval." The Upload
Timeout value is used to specify the number of milliseconds the Upload process
waits before checking the status of the Upload thread. The Upload process will not
wait for the full timeout interval if the Upload thread completes; Upload thread
completion causes the Upload process to terminate without waiting for the full timeout
interval. The "Retry Count" value is used to specify the number of times a failed
upload will be retired before the version is marked with the status
STATUS_CACHE_UPLOAD_FAILED. During the Upload process, there is a minimum
of one (1) Upload attempts. Thus, the actual number of Upload attempts will be equal
to the Upload Retry count plus one. The “Retry Interval” value specifies the amount of
time the system will wait between Upload attempts. These values are set in the
system registry. For information on the default values and how to modify the default
values for these settings, refer to the Parameters section below.
The Lazy Write mechanism is turned off by default. No user interface is provided to
enable the Lazy Write mechanism. Once enabled, two new columns must be added
to the VERSIONS table using the "content_cache.SQL" script file; CACHE_SERVER
and CACHE_LOCATION. The CACHE_SERVER column contains the name of the
server performing the cache upload. The CACHE_LOCATION column contains the
cache path to the cached version of the file that needs to be uploaded to the
document server. For more information on enabling Lazy Write and adding these
columns, refer the Installation Instructions section below.

How Long Documents Remain in the Cache Directory

Documents are removed from the Content Cache directory based on the following
circumstances:
• The cached content file has not been accessed for the amount of time
specified in the "Days to keep" setting. The content cache implementation
automatically deletes this file and overwrites the file contents with a random
sequence of characters. For more information on the "Days to keep" interval,
refer to the Installation Instructions section below.

Champion Toolkit Document www.opentext.com 4

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

• The cached content file is among the oldest files in relation to the last
accessed date, and the cache directory is about to exceed its’ prescribed
maximum size specified in the "Maximum cache size" setting. The content
cache implementation automatically deletes this file and overwrites the file
contents with a random sequence of characters. For more information on the
"Maximum cache size" setting, refer to the Installation Instructions section
below.
• A user has deleted the document or version from the DM Library that the
cached content file resided in. The Content Cache implementation
automatically deletes this file and applies the overwrite pattern that was
specified for the original document content based on the two circumstances
listed above. To prevent any performance degradation on the user's side
when deleting a document, delete operations are queued to be processed by
a background thread, instead of inline with the Delete request.
• The DM Administrator clears the Content Cache directory by selecting Delete
in DM Server Manager.

Champion Toolkit Document www.opentext.com 5

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

Enabling Content Cache and Lazy Write

Before Content Cache can be enabled, a license code and activation key must be
provided during the DM Server installation. The Content Cache tab does not appear
in DM Server Manager if this information has not been provided.
The Lazy Write feature is only available after applying DM 5.1.0.5 SR6 or later.

Installation Instructions:

1. Download and apply Service Release 6 for DM 5.1.0.5.

2. Select Start > Programs > Hummingbird > DM Server > Server Manager.
3. Select the Server State tab, and click Stop to stop the DM Server process.
4. Using a SQL query tool, such as Microsoft SQL Query Analyzer, run the
CONTENT_CACHE.SQL script on all DM libraries (this file can be found in
the \\Tools\DM Server\ folder of the DM 5.1.0.5 SR6 download), or copy
the following text in to Query Analyzer and execute it. Note: If the owner of
the library is not DOCSADM, replace DOCSADM in the following script with
the database owner.

ALTER TABLE DOCSADM.VERSIONS ADD CACHE_SERVER

varchar(128)

ALTER TABLE DOCSADM.VERSIONS ADD CACHE_PATH varchar(255)

GO

EXECUTE DOCSADM.sp_nextkey SYSTEMKEY

INSERT DOCSADM.DOCSCOLUMN (SYSTEM_ID) SELECT LASTKEY

from DOCSADM.DOCS_UNIQUE_KEYS WHERE TBNAME = 'SYSTEMKEY'

UPDATE DOCSADM.DOCSCOLUMN SET TBNAME='VERSIONS',

COLNAME='CACHE_SERVER', CREATOR='DOCSADM',
COL_LENGTH=128 WHERE SYSTEM_ID=(SELECT LASTKEY from
DOCSADM.DOCS_UNIQUE_KEYS WHERE TBNAME = 'SYSTEMKEY')

EXECUTE DOCSADM.sp_nextkey SYSTEMKEY

INSERT DOCSADM.DOCSCOLUMN (SYSTEM_ID) SELECT LASTKEY

from DOCSADM.DOCS_UNIQUE_KEYS WHERE TBNAME = 'SYSTEMKEY'

UPDATE DOCSADM.DOCSCOLUMN SET TBNAME='VERSIONS',

COLNAME='CACHE_PATH', CREATOR='DOCSADM', COL_LENGTH=255
WHERE SYSTEM_ID=(SELECT LASTKEY from
DOCSADM.DOCS_UNIQUE_KEYS WHERE TBNAME = 'SYSTEMKEY')

GO

Champion Toolkit Document www.opentext.com 6

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

5. In DM Server Manager, select the Content Cache tab and ensure that the
Enable Content Cache check box is selected.
6. On the Content Cache tab, the following options are available:

Champion Toolkit Document www.opentext.com 7

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

Physical The folder or share on the machine where cached

Location: documents are stored.

Maximum cache The maximum size of the Content Cache. When the size
size (MB): of the cache exceeds this maximum size limit, the oldest
data files in the cache, based on the last access date, are
deleted to free up needed space. The default value of this
field is 500 MB. The current size of the cache is shown
above the Maximum Cache Size field.

Days to keep: The maximum number of days to keep a file in the cache.
If a file has not been accessed for this number of days, it
will be deleted from the cache. If this number is set to
zero, files are not deleted unless the maximum cache size
is exceeded. The default value for this field is zero.

Delete Files: This option enables you to delete all files currently held in
the Content Cache. When a user deletes a file from the
repository, the cached document is also deleted from the
cache server.

7. Select the Physical Location lookup button to browse to the folder where
the content cache should be stored.
8. Enter a value for the Maximum cache size and Days to keep boxes. Click
the Apply button to save your settings.
9. Select the Server State tab, and click Start to restart the DM Server.
10. On the DM Server, select Start > Run and type REGEDIT; create the
following registry subkey:

HKEY_LOCAL_MACHINE\SOFTWARE\Hummingbird\DOCSFusion\Content
Cache

New String value = Lazy Write

Value = Enabled

NOTE: The following text can be converted to a registry file

(.REG) and then use REGSVR32.EXE to register it into your DM
Server’s registry file. Change the location entry to the location you
have chosen to store the Content Cache files.

[HKEY_LOCAL_MACHINE\SOFTWARE\Hummingbird\DOCSFusi
on\Content Cache]
"Cache"="Enabled"
"Max Size"=dword:000001f4
"Lazy Write"="Enabled"
"Location"="C:\\content_cache\\"

Champion Toolkit Document www.opentext.com 8

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

Administration and Maintenance

Content Cache Parameters Used to Manage the Internal Upload
Process
The three parameters used to manage the internal Upload process for the Lazy Write
feature are stored in the system registry under the registry subkey
HKEY_LOCAL_MACHINE\Software\Hummingbird\DOCSFusion\Content Cache
and can be modified to customize the Lazy Write performance for a DM library.

Upload Timeout The default value for “Upload Timeout” is 10000(10 seconds).

Retry Count The default count is 5 entries. Because 1 retry occurs by default,
add 1 to the value specified here to determine the number of
retires.

Retry Interval The default value for Retry Interval is 30000 milliseconds (5
minutes).

Content Cache in a Clustered Environment

The values specified on the Content Cache tab in DM Server Manager are stored in
the system registry. This registry data must be propagated out to all of the server
machines within the cluster. The Content Cache administrative process obtains the
list of servers in the cluster and then uses the remote update capabilities of the
Windows system registry API to propagate the data values to each of the individual
servers within the cluster.
When changes are made to the Content Cache settings, these changes are
automatically propagated to all servers in the cluster. Additionally, the FOLB
administration functionality has been enhanced to propagate Content Cache settings
when new servers are added to a cluster.
Although the DM Content Cache location can be on any share or server accessible
through a UNC file naming condition, it should not be placed on a DM Server that
participates in Fail Over and Load Balancing. All DM Servers in an FOLB cluster can
access the cache directory; however, if the content cache directory is on a DM Server
in the FOLB cluster, and that DM Server goes offline, the cache is not available to the
other remaining DM Server.

IMPORTANT! DM Servers that are running document Previewer

or Indexing services should not be in a DM Server cluster that has
Content Cache enabled.

Champion Toolkit Document www.opentext.com 9

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

Tips and Troubleshooting

Documents Failed to Upload to the Content Cache

If a document fails to upload to the Content Cache using the Lazy Write feature, the
STATUS column on the VERSIONS table for that document version is set to 23,
STATUS_CACHE_UPLOAD_FAILED. To determine which DM Server was performing
the cache upload, refer to the CACHE_SERVER column on the VERSIONS table for
that same document version. To determine where the DM Server was attempting to
upload the document to, or what path was being used, refer tot he
CACHE_LOCATION column on the VERSIONS table. If this issue occurs, refer to the
logging section below for information on how to view error messages associated with
this issue.

Files Appear in the Cache That Exceed the "Days to keep" Setting
Files might appear in the cache that exceed the "Days to keep" setting specified in
DM Server Manager on the Content Cache tab. This occurs because this
maintenance task is enforced "lazily" using a background thread to simplify and
improve caching. If this occurs, as soon as a file needs to be added or updated to the
cache, the "Days to keep" setting is enforced.

Content Cache Logging

Error messages generated during the Content Cache Lazy Write upload of a
document are logged to the Windows Application Event Log file.
If you experience issues with Content Caching, you can enable logging in DM Server
Manager. Logging monitors all activities of Content Caching. To enable Content
Cache logging, complete the following steps:
1. Select Start > Programs > Hummingbird > DM Server Manager.
2. Select the Preferences tab.
3. Select Content Cache in the Logging level drop-down menu.

Champion Toolkit Document www.opentext.com 10

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

4. Click Apply and OK to save your changes and exit DM Server Manager. The
Content Cache log file is created in the directory specified in the Log file box in
DM Server Manager on the Preferences tab.

Champion Toolkit Document www.opentext.com 11

 Document Title
Application Note Open Text eDOCS DM 5.1.0.5 Content Cache and the Lazy Write Feature

Sales Americas Europe Asia/Pacific

www.opentext.com United States Germany United Kingdom Australia
[email protected] 100 Tri-State Int’l Parkway Technopark 2 Grosvenor House Level 23
North America Sales Lincolnshire, IL Werner-von-Siemens-Ring 20 Horseshoe Crescent 100 Miller St.
USA 60069 D-85630 Grasbrunn Beaconsfield, Buckinghamshire North Sydney
1-800-499-6544
Phone: 847-267-9330 Germany United Kingdom HP9 1LJ NSW 2060
International Sales Fax: 847-267-9332 Phone: +49 89 4629 0 Phone: +44 1494 679700 Australia
+800-4996-5440 Fax: +49 89 4629 1199 Fax: +44 1494 679707 Phone: +61-2-9026-3400
Fax: +61-2-9026-3455

If you are an Open Text partner or customer, visit online.opentext.com for more information about this and other Open Text
solutions.
Open Text is a publicly traded company on the NASDAQ (OTEX) and the TSX (OTC).
© Copyright 2008 by Open Text Corporation. Open Text, Livelink, Livelink ECM, and Great Minds Working Together are trademarks or registered trademarks of Open Text Corporation. All other trademarks or
registered trademarks are the property of their respective owners. All rights reserved.

www.opentext.com 12