Chat now with support
Chat with Support

Metalogix Archive Manager for Exchange 8.1.1 - Administration Guide

Getting Started Enterprise Manager Tools Manager view
Groups tab Settings tab Public folders tab Jobs tab Retention tab – Retention Categories management Post Processing tab Locations tab
Archive view Status view Toolbar icons - Description Advanced Search Appendix

Retention categories and their usage

The following types of settings are available:

Settings related to emails in the HSM Store:

·Retention time – the archived email is not delete-able from the HSM Store for the defined time period. Retention time is thus the MOST CRUCIAL feature of Archive Manage for Exchange related to law regulations. Emails ‘deleted’ using functionalities of Enterprise Manager or Outlook Addin are actually only marked for deletion and they reside in the archive until this retention time expires.

·Delete time – the email, although not marked for deletion, is automatically deleted (by the Delete Files job) from the archive after the expiration of the defined time period. It is the MAXIMAL time for which the emails reside in the HSM Store. This time period cannot be smaller than the retention time.

·Keep-alive time – it is the time period after email deletion, during which the deleted email can be turned back to the store. However, this is possible only if the Delete time has not elapsed yet.

Settings related to emails on the MS Exchange Server:

·Keep the original email – email is archived but it is not modified in any way (no icon, no shortcut, keep residing on the MS Exchange Server). This option is used just for backup.

·Delete original email – the email is removed from the MS Exchange Server immediately after archiving, no shortcut is created thus it is not reachable from the user’s mailbox and it is displayed as “lost” in the Archive view.

·Create shortcut – the email is archived and it is replaced with a shortcut. This type of archiving saves the space on the MS Exchange Server and at the same time enables the user to work with the archived email just as with non-archived one. Email can be replaced with the shortcut immediately or it is kept without changes for the defined time period and after its expiration shortcut is created (“Delay shortcut creation by” option ).

oDelete shortcut after a time – the shortcut of the email is automatically removed from the MS Exchange Server after the expiration of the defined time period (email cannot be reached from the user’s mailbox any longer and is displayed as ‘lost’ in the Archive view). However the email still resides in HSM Store.

The starting point of all the above mentioned times (except the Keep-alive time) is either the moment of archiving or the moment of receipt. The starting point can be set when the retention category is created.


CAUTION: Please consider carefully the retention settings, especially when setting receive time as the starting point. If a message has been received e.g. 6 months ago and your retention time/delete time is just 3 months, the message will be archived. However, it can be deleted from the archive immediately, as 3 months has already passed since the beginning of its retention time.


In addition to the default retention category created during installation the administrator is able to create any number of retention categories satisfying specific criteria of the enterprise. The retention category consists of a name, a description, the above mentioned retention times and of the HSM scheme. It is fully manageable from Enterprise Manager.

Creating a new retention category

Steps to create a new retention category

1.On the View menu click Manager.

2.Click on the Retention tab.

3.Right-click inside the list view, select New category from the context menu and navigate through the wizard as follows:

b-new ret

4.Basic settings window pops-up. Enter the name for your retention category in the Category name text box (e.g. Keep shortcut for 3 years).



5.In the Target HSM scheme dropdown box choose the target scheme which will be used for archiving. In the HSM system you may define different HSM Schemas, which are virtual categories for documents. (One HSM Schema has been created at installation of Archive Manage for Exchange and you may have created more HSM Schemas during the setup of Archive Manage for Exchange, each with a particular number assigned to it.)

6.In the Lifetime calculated from dropdown box you can choose from two options – Archive time and Receive time; i.e. you can define here the starting point from which the all the retention related times should be calculated. Either it will be the time when the item gets archived (Archive time) or it will be the item’s Received time.

7.In the Category description text box fill in a short description of the new category.

8.Click Next.

9.In the Document lifetime window specify your settings.

It is strongly recommended paying very much attention to these settings as they define the time period for which the emails are archived.

Set the Retention time. During this period none of the emails in the HSM store archived via this retention category can be removed from the archive. It is possible to select:

·Fixed period (set the desired period)

·Indefinite period (the retention time is not set specifically but can be defined later)

·Infinite period (retention is everlasting)

Select Enable automatic document deletion check box and specify Delete time if you want to COMPLETELY DELETE an archived emails whose retention time has elapsed from the HSM Store after a defined time.


NOTE: Enable automatic document deletion option applies to emails which are not marked for deletion.

By specifying the Keep alive time you set the time period for which the email, deleted after its retention time has elapsed, will be still kept in the HSM Store. Just use the arrows to set the time or directly overwrite it. Delete and Keep alive time can be set in days, months or years.



NOTE: The Delete time cannot be smaller than the Retention time. Pay due attention to these crucial settings as here you set the time for which emails exist in the archive.

10.Click Next.

11.In the Shortcut lifetime window you can choose from three options:

a.Keep the original e-mail – select this option, should you wish to archive email and not to modify it in any way. In this case no shortcut will be created and the whole email will reside in the MS Exchange Server. In the Archive view on the Mailbox tab such item will be displayed with the following icon: ARCHIV~1_img214 .

b.Delete original e-mail – select this option, should you wish to delete all original email from the MS Exchange Server immediately after its archiving. No shortcut is created and the email is not accessible from the user’s mailbox. In the Archive view such item is displayed as lost.


c.Create shortcut – select this option, should you wish to replace the original email with a shortcut after archiving and thus make it accessible for the user and save the space on MS Exchange Server at the same time.


In case you have selected the Create shortcut option, further settings become available and you can adjust shortcut behavior to meet your needs. You can choose if the shortcut creation will follow immediately after archiving of the email (Create shortcut immediately radio button) or will be delayed for the specified period of time (Delay shortcut creation by radio button) when e.g. Blackberry users will be able to view their attachments. While no shortcut is created, the email is displayed in the Archive view with the following icon: ARCHIV~1_img214.

Moreover, you can decide whether you want to keep the shortcut in the user’s mailbox until the user deletes it (Keep shortcut for ever option) or the shortcut will be deleted automatically after the defined time (Delete shortcut after a time option).

12.Click Next.

13.Extra settings window pops-up. If the Allow automatic deletion of unreferenced emails check box is selected, emails archived via this category will be marked for deletion whenever the Shortcut Sync job cannot find the reference to the emails in any of the users’ mailboxes. If the check-box is not selected, Shortcut Sync job will not marked eventual “lost items” for deletion (see the section “Shortcut Sync job”).


I.Emails are archived by a retention category with Allow automatic deletion of unreferenced emails checked and shortcuts are left in the Exchange Server

II.You delete shortcuts from Exchange (either by removing the shortcuts manually in a mailbox, or by deleting a folder in Outlook that contains shortcuts etc.) → emails become “lost items”

III.You run the Shortcut Synchronization Job → lost items are marked for deletion


CAUTION: If the items were archived with 0 retention time and with Allow automatic deletion of unreferenced emails allowed, the Shortcut Synch Job deletes them COMPLETELY.

IV.Items marked for deletion are deleted from archive when their Retention (and Keep alive) time elapses and you run the Delete Files job



IMPORTANT: Items marked for deletion still reside in the HSM Store but cannot be restored using Enterprise Manager, e.g. on the Archive tab.

14.Click Next to finish the creation of the new retention category.

Changing the settings of a retention category

To change the settings of an existing retention category:

1.Double-click the selected retention category to open the Retention category properties window (or right-click it to open its context menu and select Properties).


2.On the respective tabs specify your new settings for the retention category. On the General tab you can change the name, HSM Scheme, retention time, keep alive time as well as allow automatic deletion of old documents and modify related Delete retention time. Click Apply and OK.


3.Shortcut settings can be modified on the Shortcut tab. Click Apply and OK to apply the new settings.


4.On the Additional tab set the shortcut synchronization behavior – if the Enable document clean-up by Shortcut synchronization job check box is selected, emails archived via this category will be marked for deletion (or completely deleted if their retention time is 0) whenever the Shortcut synchronization job cannot find the reference to the emails in any of the users’ mailboxes. If the check box is not selected, Shortcut synchronization job will not mark them.


5.Click Apply and OK to apply your settings.

How to customize retention categories list view

After right-clicking any retention category on the Retention tab, the context menu appears.

·Add/Remove columns – click it in case you want to add or remove columns from the list view. Add/Remove columns window appears. To add/remove a column, select the desired one from the Available columns/Selected columns list. Then click on the Add/Remove button.

To change the order of the selected columns click the one you want to move and use the Up and Down buttons. Click OK.


·Delete category – retention category can be deleted only if nothing was archived via this retention category

Post Processing tab

Post Processing is a service which allows running customer specific tasks over archived emails and their attachments, for a voluntary number of mailboxes. This service was primarily developed to meet additional clients’ requirements. So those clients who are using other software programs and wish to process within those software programs archived emails and their attachments may do so via the Post Processing service.

How to use post processing service

To use the Post Processing service, the user must have a plugin available.

By a customer plugin we mean a customizable component used for processing of emails and their attachments that have been archived by Archive Manage for Exchange. It is a code which is a section of an assembly that is developed specifically to customer requirements.

Upon receiving a plugin, take the following steps:

1.Make sure that the Post Processing service is started.


IMPORTANT: Without the Post Processing service started (i.e. MAMPostProcessingSv), any plugin – even the active ones – will not run and therefore no post processing will be performed.


2.Load this plugin into Enterprise Manager.

3.Select all mailboxes to which post processing is to be applied;

4.Define the initial bookmark date for the plugin (if necessary);


NOTE: A bookmark specifies a point in time (date and time), which is the starting point for post processing. This means that all e-mails and their attachments having been archived after this bookmark date will be processed within post processing.

There can be several plugins running in parallel, each with a different bookmark date. However, do not start post processing service on multiple servers for the same database. Starting the post processing service on multiple servers is not recommended, since that can cause conflicts in bookmarking. The same database should not be indexed by more than one post processing service.

The Post Processing service manages (starts and stops) the plugins at regular intervals. Advanced Post Processing settings can be configured after clicking the Settings button on the Post processing tab (see the section Post Processing settings ).

Each plugin is loaded by default with the date and time (initial bookmark date). This means that the plugin processes emails and their attachments having been archived after this initial bookmark date. If post processing should begin from some other bookmark date, then make sure to reset the initial bookmark date.

How to add a plugin

To add a plugin, follow these steps:

1.On the View menu, click Manager.

2.In Manager view, click on the Post Processing tab. Click on the Add button.


NOTE: You may also click with your right mouse button inside the left pane and in the context menu select New Plugin.


3.Installed plugins will be loaded in the Add Plugin pop-up window. Select the desired plugin in the down-drop box and click Add.


4.The plugin becomes listed on the Post Processing tab in Enterprise Manager. By default it is active.


When a new plugin is added onto the Post Processing tab, there are no mailboxes specified for it by default. The user needs to specify the mailboxes as well as the bookmark date (if necessary). For further information see the section How to configure a plugin.


NOTE: If no mailboxes are selects then post processing will not process any archived emails and attachments.


TIP: You can check the number of already processed items in plugin statistics. Right-click the plugin and from the context menu select Statistics to display the info dialog.

Related Documents