Software Change Notice - Retain 1.6

  • 7020141
  • 21-Aug-2008
  • 07-Aug-2017


Retain 1.6


Retain 1.6 Release Notes:



Indexer updated
Lucene, the indexing engine that Retain uses to catalog and index the mail archive, has been updated from version 2.2 to 2.3.  The update changes the index schema, providing performance enhancements. Because of the update, once 1.6 has been installed and run, it is impossible to return to 1.5, as 1.5 will view the index as broken.  RETAIN 1.5 WILL NOT WORK WITH A 1.6 INDEX.  The upgrade is permanent.

Current Retain 1.0x Customers:
 There is a schema update between 1.0 & 1.6  which takes place the first time Retain 1.6 is run after an update. With large databases, the update can take hours. WHILE THE DATABASE SCHEMA IS BEING UPDATED, THE WEB CONSOLE DISPLAYS AN INFORMATION PAGE ABOUT THE UPDATE AND WILL BE UNAVAILABLE. DO NOT INTERRUPT THE SCHEMA UPDATE OR DATABASE CORRUPTION MAY RESULT. Retain will write to the Retain Server log that a schema update is needed and then performs the update. Retain also warns, in the log, if any issues occurred, and lists them. Otherwise a successful schema update is logged, and Retain proceed to complete its startup. The Retain Server logs are nested with the embedded Tomcat 5 logs, which differs depending on installation platform.
Windows:  C:\Program Files\Apache Software Foundation\Tomcat 5.5\logs
SLES 10.x  /opt/beginfinite/retain/tomcat/logs

RetainServer moving to full 64-bit architecture
RetainServer, to accommodate the needs of large systems and stability, is moving to 64-bit architecture. 32-bit Server support will end with the Retain 1.x tree and Retain 2.x will only support 64-bit server operation.. It is suggested that administrators begin planning their systems accordingly. The RetainWorker will still be supported on both 32-bit and 64-bit systems.

The list of supported operating systems is as follows:
SuSE Enterprise Linux 9 SP4 32-bit
SuSE Enterprise Linux 10 SP2  32-bit
Open Enterprise Server  1, 2 (Linux) 32-bit versions
SuSE Enterprise Linux 10 SP2  64-bit
Open Enterprise Server 2  64-bit
NetWare 6.5 SP6+ (RetainWorker only)
Microsoft Windows Server  2000, 2003 32-bit (Support for Windows 2000 will end at end of 2008)
Microsoft Windows Server 2003 64-bit

New Supported Software or features:
64 Bit Support
Retain now supports 64-bit JVM for SLES 10 SP2, OES2, and Windows Server 2003. This includes Centera.

Tomcat 5.5.26 Now Embedded With Retain
Retain now ships with Tomcat embedded. If Retain has not been installed on a machine before, then it will require you to install and use the embedded Tomcat. Installation with an existing Retain system running on a standard Tomcat installation will require you to disable the current Tomcat connection, and install the embedded Tomcat that comes with Retain.  With the embedded Tomcat, the memory tuning has been initially set to 1GB for the Server and 256MB for the Worker.  Adjust according to your own system needs.

Retain's Tomcat will not interfere with any current tomcat installation or ports; they have been changed as follows:
Listen ports
HTTP:             48080
AJP:            48009
Home Directory:      /opt/beginfinite/retain/tomcat
Log Diretory:       /opt/beginfinite/retain/tomcat/logs
Start Script:         /etc/init.d/retain-tomcat5    start | stop | restart | status
Configuration file:     /etc/opt/beginfinite/retain/tomcat/j2ee
Memory Tuning:         Defaults to 1024MB for Server and 256MB for the Worker

BASIC GroupWise 8 Support
Retain now has basic support for GroupWise 8, (Bonsai), systems. All items that are common to GroupWise 7 can be archived and function as normal. New items and stubbing are not currently supported.


RetainWorker is now password protected. Once you have uploaded your RetainWorker.cfg file to the worker, you must authenticate against the worker in order to have access to the worker page.

Revamped GUI including:
Worker page refresh:
The RetainWorker page will now automatically refresh after the 'Refresh job cache now' button is pressed, eliminating the need to manually refresh and login to the worker page.

A 'Check for latest version button' has been added to the worker and the Server has a new interface on the main Status and Updates page which automatically checks for updates and alerts the user when they browse to this page.


NetApp support
Retain also supports NetApp and its SnapLock feature

EMail Address Lookups for Login
Retain now performs LDAP email address lookups. For large eDirectory trees, email addresses will need to be indexed for this feature to work.  eDirectory does not index these addresses by default.

Livelink enhancement
Retain also supports auto-creation of users in Livelink.

MIME Header indexing
The Profile now has a new option to index the headers of a MIME file. All other parts of the MIME file are already being archived. This option is found under the miscellaneous tab in the Profiles configuration page. It is
now a reasonable option for most users to shut off archiving MIME.822 attachments, saving considerable disk space, as headers (the only unique items) are indexed and stored.

Skips NNTP/IMAP/RSS items by default
These are normally not needed for compliance.

Revamped GUI for Status Page
Easier to use, and find active jobs or specific jobs quickly.

Job Expiration Timestamp
The Job Expiration feature allows you to set a timestamp in Retain on each message archived with that job, which can be used in conjunction with the Deletion manager to automatically remove mail that has expired, or passed its retention date, as set in the jobs configuration window. This setting is only applicable to newly archived mail, and cannot be set retroactively. Support for SnapLock requires that the Job expiration feature be set in order to function.

Deletion Manager
The deletion manager provides for the removal of mail from the archive according to the specified criteria.  The Deletion management runs as a scheduled job in the archive, looking for, and processing or deleting messages that match the search terms.  Full reporting is also supported by the option, and the Administrator also has the option to process a job without removing the messages from the archive, but producing a report on the messages that would be processed.
Mail removed from the archive is permanently deleted. Use this option with care. 
Mail can be removed according to:

Job Expiration date, Storage Date, Delivery Date
Message status
Item type
Item source

Auditing Records
Retain now will create an auditing record of all actions, specified by the user, which are taken on a specific piece of mail.  Auditing records can be removed automatically after a specified length of time. The variable is set in days.  All of the options associated with this feature are found under the Server Configuration page, Logging tab. 
This logging option is very detailed for the options selected, and it is very important to know that if every option is turned on, the logs can become extremely large. It is highly recommended that an expiration date is set for the logs, so that they are automatically removed from the system.  Logging all options will also adversely affect performance. 

Store Partition by Year
Retain can store the mail in folders by year for the user's archives. This will sort all mail archived into year folders, which then contain the root mailbox folders and their contents for that year. (i.e.  John->2007->cabinet | mailbox| calendar| etc…     instead of john -> cabinet|mailbox|calendar…)  This option is irreversible. If you set this option, all mail archived after the option is set will be categorized into years. This is not retroactive.  If the option is then deactivated, the year folders will still be present, but newly archived mail will appear in their respective folders as if the option was never set.  Mail archived into these folders with this option will be located there permanently.

Retain's Indexing and Searcher are faster. Concurrent Access by multiple workers is considerably improved in speed. Caching of Address Book info by the Workers is improved up to 2000%. XML File export is sped up considerably.

Additional Information

This article was originally published in the GWAVA knowledgebase as article ID 392.