Retain Utilities

Retain Tools

Retain has a number of tools and utilities for data handling and troublshooting.

Plugins

[Exchange]

• Outlook 2010/2013/2016 32 bit Download and Search your Retain Archive(s) within Outlook 2010/2013/2016 (32 bit)
• Outlook 2010/2013/2016 64 bit Download and Search your Retain Archive(s) within Outlook 2010/2013/2016 (64 Bit)
• Outlook 2007 Retain Single-Sign-On plugin for Outlook 2007
• OWA 2007/2010 Retain Single-Sign-On plugin for Outlook Web Access 2007/2010
• OWA 2013/2016 Retain Single-Sign-On plugin for Outlook Web Access 2013/2016
• Office 365 Retain Plugin for Office 365 (this is the sync365.ps1 script for getting the address book)[1][2]

[GroupWise]

• Windows Client Retain Single-Sign-On plugin for GroupWise Client (versions 7/8/2012 and 2014, Windows only)
• WebAccess Retain Single-Sign-On plugin for GroupWise WebAccess (versions 7/8/2012 and 2014)

[Mobile]

• Android APK 4.0.2 Retain App for Android Phones (Ice Cream Sandwich (4.0.4) through Marshmallow (6.0))

Tools

[Migration]

• TMA M+ and Netmail to Retain Migration Netmail and M+ to Retain Migration Utility (GroupWise and Exchange Data)

Import

• PST Importer Import PST files into Retain [3]
• GW Archive Migration Import Groupwise Archive(s) into Retain (versions 7/8/2012 and 2014) also known as the PAM Tool [4]

[Publisher]

• Publisher This tool allows you to download (publish) specific archived messages from Retain where it can be viewed, searched, redacted and exported to PST and PDF format (Windows Only)

Utilities

Retain also has a number of utilities hidden under the about page.

Core Info

Generates a .XML file of server configuration data.

JAR List

Generates a .XML file of installed .JAR files.

Jobs

Generates a .XML file of the jobs.

Schedules

Generates a .XML file of the schedules.

Profiles

Generates a .XML file of the profiles.

Workers

Generates a .XML file of the workers.

Quartz

Displays Quartz diagnostic data.

Retention Date Utility

This is the most commonly used utility. When there is an error on a message, Retain will not advance the date flag so it knows to go back and try dredging the message again.

We can set the retention date behaviour in the Profile/Scope/Set Storage Flags. The Retention and Purge Flags are GroupWise specific and are stored in GroupWise. Retain can set both but generally, Retain uses the Retention Flag and Reload uses the Purge flag. The Item Store Flag is stored in the Retain database and is used for all other message systems.

Errors will show up in Reporting and Monitoring(R&M) under the Job Mailbox Summary, by clicking on the number under the Errors column you can get more detail about the error. For the most detail, you will need to dig into the RetainWorker log. Solutions to common errors can be found in the knowledgebase [[5]]

If the error cannot be resolved by dredging the mailbox successfully, you can use this utility to skip the message.

The Mailbox ID can be copied from R&M Mailbox column. For example, if the mailbox column tells us user test1(SFEX13SRV) has an issue, you can copy test1 and paste it into the Mailbox ID field.

Choose the message system the item was dredged from and click Get current values.

In a moment, the Storage Flag fields will populate. The numbers are Unix Timestamps as stored in the database. They are translated just to the right of the field. There is a link to a timestamp converter near the top of the utility page. A timestamp of 0 is also known as the "Beginning of Time" (Wed Dec 31 17:00:00 MST 1969) or Wed Dec 31 00:00:00 UTC 1969 in Unix parlance.

You will need to advance the appropriate flag to skip the problematic message. Note: When Retain runs a job it will start dredging from storage flag time minus one hour. This overlap is intended to prevent data loss when dredging highly active mailboxes. This needs to be taken into account when advancing the flag. You will need to advance the flag at least 3601 seconds, but as a rule of thumb advancing by 4000 seconds is sufficient, because Retain doesn't give up when it encounters an error so subsequent messages are archived.

Warning: Do not set the date flag to the current time since that would lead to data loss. Set the timestamp, at most, to the start time of the previous archive job.

Example

User test1 has a message that caused an error when Retain attempted to archive it from Exchange. After investigating it was found to be a newsletter and can be safely ignored.

Open the Retention Time Utility and enter the users Mailbox ID test1, set the drop down to exchange, and click on Get current values.

Retain has stored the Item Time Flag as 1466003175 (Wed Jun 15 09:06:15 MDT 2016)

You add 4000 to the timestamp 1466007175 and click on Set current values and the result is updated to (Wed Jun 15 10:12:55 MDT 2016)

Indexer Status

This will show the current number of unindexed items and how many are in memory being processed. Buttons are available to turn the indexer on and off.

Exchange Test

When you setup an Exchange module and run a successful Test Connection a link appears at the end of the report that allows you to further test the connection to the exchange system. You can also reach that test through this utility. This utility uses the impersonation account credentials to enter the user's mailbox.

Fill out all fields:

• Exchange LDAP Host (e.g. 10.1.4.255 or ex13srv.sf.gwava.net)
• Exchange LDAP Security (none or ssl)
• Exchange LDAP Port (3268 cleartext/3269 ssl)
• Exchange LDAP Search DN (e.g. dc=sf,dc=gwava,dc=net)
• Impersonation User UPN (the AD logon name)
• Impersonation User Password
• Target User EMail

If the test is successful you will enter the user's mailbox. The UI is very primitive but sufficient for our needs.

If the test is unsuccessful there will be extensive error reporting.

Most often there is some kind of [LDAP error] or [Basic Authentication] is not enabled on all CAS servers.

Other times it may be because the Impersonation user does not have [sufficient rights] to the domain or part of the domain

Mailbox Merger/Splitter

In Module Configuration you can set up mailbox mapping which will map a user's GroupWise and Exchange mailboxes together so they can switch between them via a dropdown menu. That utility has a difficult time with users that have the same name. The Mailbox Merger/Splitter utility allows you to do the process manually.

Merge mailboxes

Choose a source mailbox and a destination mailbox group and click on Merge.

Split Mailboxes

Choose a merged mailbox for the source, for the destination choose New Entity and click on Merge.

Development has not been able to explain how to use the merge.xml file so don't expect to use it.

Indexer Test

This requires a perfectly formatted query. It is best to take a successful query from the log and alter it for this use.

System Properties

Displays a list of diagnostic data.

Generate License Report

Customers can use this to see how many active users they have. An active user has had new messages archived in the last 90 days.

Other Utilities

[IndexCheck Utility: Check and Fix Indexes ] [RATS Instructions: Run the Lucene IndexCheck Utility]

[Backing Up Retain]

[Tool for Creating Additional Workers on Windows]

---

Return to Retain Training