DataArchiver Outlook Add-In

Topics | How To


Overview

Using the Archive List

Using the Erase List

Recovering a Mail Message or Public Folder Item

Configuring Offline Archive Options

Performing Compliance Searches from Outlook Add-In

Finding and Restoring/Recovering Messages from Outlook Add-In

Erasing Data in the Outlook Add-In

Accessing and Using the Search Console from Outlook Add-In

Accessing and Using the Exchange Offline Mining Tool from Outlook Add-In

Using the Outlook Add-In In Citrix Environments

Configuring Java Updates

Support Information - Languages


Overview

The DataArchiver Outlook Add-In is a multi-purpose tool that provides Outlook users with a convenient way to browse, search, restore, recover and/or erase e-mail messages that were backed up or archived for your mailbox. It can also be used to perform stub recalls. Once the e-mail messages are located, they can easily be restored back to the original location, recovered to the Recovered Items folder, or erased. Integrated Search Console capabilities are also provided from Outlook Add-In. For more information, see:

When used with the Exchange Mailbox Archiver Agent, the Outlook Add-In provides the additional capability to add mail messages/folders into an Archive List for later archiving and remove mail messages/folders from the Archive List. This agent also supports the capability for adding/removing message stubs to/from the Erase List for the Erase Data feature. Offline archiving is available for this agent as well. For more information, see:

When used with the Exchange Compliance Archiver Agent, the Outlook Add-In allows compliance officers to perform compliance searches from Outlook. For more information, see Performing Compliance Searches from Outlook Add-In.

The following capabilities are supported by this component:


Using the Archive List

For the Exchange Mailbox Archiver Agent, the Outlook Add-In will add a series of menu items under the Outlook Tools menu allowing end-users to make additions to the Archive List, and remove entries from the Archive List. When selected messages/folders are added to the Archive List, then the next migration archiving operation on the Exchange Server will include them for archiving.

For step-by-step instructions, see:


Using the Erase List

For the Exchange Mailbox Archiver Agent, the Outlook Add-In provides options under the Outlook Tools menu allowing end-users to make additions to the Erase List, and remove entries from the Erase List, if configured for your client. When selected message stubs are added to the Erase List, then the next Erase Stubs operation on the Exchange Server will include them for erasing. The folder used for the Erase List can also be customized using the EraseStubsFolderName registry key.

For step-by-step instructions, see:

See also: "Erase Backup/Archived Data" in Books Online.


Recovering a Mail Message or Public Folder Item

In Outlook, the stubs will appear as messages with the icon. The stubs include information on sender, recipient, subject and body text. To find a stub, users can look for the icon in the folder view.

Once a stub is located, users can open the stub by clicking on it in Outlook. The DataArchiver Outlook Add-In will intercept the Outlook users open item event and then ask for the users confirmation. Once the user decides to recover the original message, the DataArchiver Outlook Add-In will get the recovery information from the stub and submit the recovery request to the system. A recovery job will be started and the message or item will be recovered back to Exchange Server. After the recovery is completed, Outlook users will see the recovered message or item in their Recovered Items folder. If the RecoveredItemsFolderName registry key is configured, users will find their messages in the folder specified in this registry key.

During recovery, the DataArchiver Outlook Add-In allows the user to cancel the recovery job. At the end of recovery, the DataArchiver Outlook Add-In will display the result and related information to the user. Because a recovered message will have the most recent modification time, it will not be archived again until it meets the minimal message age or is added to the Archive List by the Outlook user, unless the user decides to delete the stub or the recovered message/item after use.

If you have another user's mailbox attached to your mailbox and recover an archived message from the other user's mailbox, the message will appear in the Recovered Items folder of the other user. However, when the recovery operation is complete, the Outlook view will automatically change to your Recovered Items, which will not include the recovered message. To ensure that the message recovered successfully, locate the recovered message in the Recovered Items folder of the other user.

For step-by-step instructions, see:


Configuring Offline Archive Options

The offline archive feature allows you to retain a full copy of archived messages or items in a local cache on the Outlook client for offline recall access, and is supported for use with the Exchange Mailbox Archiver Agent.

When this option is enabled on the subclient and configured for use on the Outlook client from the Offline Archive Optionshtm">Offline Archive Options dialog, any items that are archived off the Exchange Server to secondary storage are also archived to a file that is maintained in local cache to give you easy access to full copies of those archived items when working offline.

Offline archiving can also be configured to run when Outlook loads by creating the bEnableOfflineArchiveAtStartup registry key. When this key is created and configured with a non-zero value, the user will be prompted to run an offline archiving operation upon opening Outlook.

Keep in mind that Outlook Add-In users must have local administrative level privileges to configure their clients for offline archiving.

Data Aging for Offline Archive Files

After an offline archive job has been run, full copies of any archived messages or items are sent to an offline archive file that is maintained in cache on your local client. You can decide how long you want to keep those cached items on your local client by specifying the number of days to keep the file in which the cached items reside, or you can keep them indefinitely by selecting the Disable Pruning option.

Use the LMOptions registry key to disable the Offline Archive Pruning process and LMPSTExpiry key to set the number of days before which, the offline achieved files will be pruned.

For step-by-step instructions, see Configure Offline Archive Options.

Additional Information

This section includes additional information relating to the offline archive feature.

Offline Archive Candidate

Once an offline archive job has been run from the CommCell Console, any messages or items that met the archiving rules criteria will be considered offline archive candidates and will display the icon in Outlook. Messages or items will continue to display the offline archive candidate icon until an offline archive is triggered from the Outlook client, after which they will display the normal stub icon.

Recovering Offline Archive Data

Recovering an offline archived message or item from a stub is similar to regular stub recovery. Just double-click the stub to recall the archived message or item. The only difference is that the full copy of the archived item is recalled from local cache instead of the Exchange Server.


Performing Compliance Searches from Outlook Add-In

Compliance management facilities are available from the Outlook Add-In to make it easier for compliance officers or other authorized users to search archived messages from Outlook on their workstations. This provides an alternative interface to the CommCell Console for performing compliance searches of archived data. The following types of compliance searches are supported using the Outlook Add-In:

NOTES


Finding and Restoring/Recovering Messages from Outlook Add-In

The Outlook Add-In, when used in conjunction with the Exchange Mailbox iDataAgent or the Exchange Mailbox Archiver Agent, provides end-users with the capability of finding and restoring and recovering messages from Outlook on their workstations. Searches can be performed on message properties such as Subject, From and To. A time range for the search can also be specified. Messages or items that match the search criteria are returned as search results, which can then be restored or recovered to the Recovered Items folder.

The Outlook Add-In also provides the capability to Browse and Recover messages that were archived by the Exchange Mailbox Archiver Agent and Exchange Mailbox iDataAgent.

For step-by-step instructions, see:

NOTES

Finding and Restoring/Recovering Messages from a Web Browser

The Outlook Add-In Find and Recover capability can be accessed from a web browser in cases where Outlook is not installed on the client computer. This is accomplished by:

Once this capability is configured, end-users can access the Find and Recover functionality by typing the web URL of the CommCell Console into a supported web browser. For example, an Entourage user can access the Find and Recover functionality by typing the following URL into a Safari web browser:

http://<commserve_name>/<commcell_console_alias>

Due to the privileges allotted with the End User Search capability, end-users will only be shown Find and Recover functionalities. No other CommCell Console features will be available.

Erasing Data from a Web Browser

You can utilize the Erase Data feature when performing Find and Recover from a web browser by first performing the following configuration:


Erasing Data in the Outlook Add-In

The following erase data capabilities are supported by the DataArchiver Outlook Add-In:


Accessing and Using the Search Console from Outlook Add-In

The Data Discovery and Search capabilities of the Search Console are provided for Outlook end-users and compliance officers to search for data across computers and supported applications to find the information they need to perform their job functions. When this feature is configured, a toolbar button is displayed in Outlook which allows users to conduct either End-User Searches or Compliance Searches. The toolbar buttons for Compliance Search and End-User Search are depicted below.

Compliance Search
End-User Search

For step-by-step instructions, see Access and Use the Search Console in Outlook.

NOTES


Accessing and Using the Exchange Offline Mining Tool from Outlook Add-In

The browse and search capabilities of the Exchange Offline Mining Tools are provided for Outlook end-users and administrators to browse and search for data from an offline copy of the Exchange Database. When this feature is configured, a toolbar button is displayed in Outlook which allows users to launch either the Exchange Offline Mining Tool (for End-Users) or the Exchange Offline Mining Tool for Administrators to conduct browse/search and restore operations for e-mail messages from an offline copy of the Exchange Database. The toolbar button for launching the Exchange Offline Mining Tool is depicted below.

DB Mining Tool

Note that when launching the Exchange Offline Mining Tool from the Outlook Add-In, only Exchange 2003 databases can be loaded into the tool.

For more information on this feature, and for configuration procedures, see Restore Exchange Data using the Offline Mining Tools in Books Online.

For step-by-step instructions, see Access and Use the Exchange Offline Mining Tool from Outlook.


Using the Outlook Add-In In Citrix Environments

Configuring Outlook Add-In for Citrix environments is accomplished through the use of the AllowPerUserSettings registry key. When this key is configured on the Citrix server, user profiles can be configured with unique settings for their Outlook Add-In functionality.

This functionality utilizes three registry key areas:

All the registry keys in the following table are configured in the following path:

[Registry_Key_Area]\SOFTWARE\Microsoft\Office\Outlook\Addins\Galaxy.Ex2KMBDM.CVEAAddin

User Specific (HKEY_CURRENT_USER)

Common (HKEY_LOCAL_MACHINE)

UIOptions SocketTimeout
RecoveryOptions IpFamilyPref
AutoOpenMail nSearchRangeDays
LM_PST_LOCATION  
LMOptions  
LMPSTExpiry  
AutoLMJobFreq  
AutoLMJobRunTime  
EnableLMToolBar  
bEnableOfflineArchiveAtStartup  
SearchPageURLOption  
nEvMgrCPortNumber  
ConnectOverHTTP  

By default, users logged into the Citrix sever with the AllowPerUserSettings configured are assigned the registry key values that exist in HKEY_CURRENT_USER. If a key exists in the HKEY_LOCAL_MACHINE area which does not exist in the HKEY_CURRENT_USER area, the respective key will be created and its value copied into the HKEY_CURRENT_USER area. If a registry key exists in both locations with different values, then by default, the value of the key as configured in HKEY_CURRENT_USER will be used.

In some cases, it may be desirable to change the value of a user-specific registry key. This can be accomplished in one of two ways:

  1. A login script can be created to change the value of the key located in HKEY_CURRENT_USER when the user logs in.
  2. A script can be created to match a user's security ID as configured under HKEY_USERS with its Active Directory object. Registry keys can then be configured under this security ID as desired for the user.

Configuring Java Updates

The software can be configured to periodically download any available Java updates that are present on the CommCell Console. Three options are available for automatically downloading updates:

By default, these registry keys will check for and download Java updates from the CommCell Console installed on the CommServe computer. If you wish to use an alternate computer for downloading Java updates, you must configure the CommServe computer's CommCell Console to obtain Java updates from the desired alternate computer. Doing so helps offset network traffic from the original CommServe computer. The alternate computer must have the following:

See Configure an Alternate Computer for Launching Stand-Alone Add-Ins for step-by-step instructions on specifying an alternate computer for Java updates.


Support Information - Languages

See Books Online for complete language support information.

Note that the UseOSLocale registry key can be used to further configure language options for Outlook Add-In. Refer to Registry Keys in Books Online for information about this key.


Keywords

data archive solution, data archive solutions, data archiving software, data archiving solution, data archiving solutions, enterprise data archiving, exchange archiving tool.

Back to Top