Chat now with support
Chat with Support

Metalogix Archive Manager for Exchange 8.1.1 - HSM Guide

Packer tab


Packers are joining multiple files stored in HSM into large ZIP archives. It is better to have several large files than a plenty of small ones – the disk space utilization is more efficient in this case, because it helps to avoid internal disk fragmentation.


Packers can be created and managed on the Packer tab. Created packers can then be assigned to specific schema on the Stores tab.




First select the store in Temporary store for packages dropdown. It will be the temporary store for archived files before they got packed. Then the packed files will be moved to the final store (it can be the same store as well).

To create a packer, click Create. The HSM Packer dialog pops-up. Configure the settings:

Name                        – enter packer name

Type                        – the file to be used by the packer

Max. package size        – if the specified limit is reached, new package will be created

Max. files in package – package starts to be created when the specified number of files is reached

Max single file size – if the file size is bigger than the specified value, the file will not be included in the package (otherwise it would be much time consuming)


File types & Action        – allow specifying file types to be included / excluded in/from the package

Max age of files – is files to be packed are waiting in the packer queue longer than the specified value, a new package will be created

Disable                – disable processing of files in the packer queue



Following table displays how archived files in HSM are handled during ‘Asynchronous packer’ task process:

Temporary store for packages

Source Store result

Target store result

Same as Source store (*)

Original archived files are deleted after they are compressed and stored in Temporary store for packages.

ZIP container with archived files

Different as Source store (*)

Original archived file remains at store after they are compressed and stored in Temporary store for packages.

ZIP container with archived files


Temporary store for packages: HSM store that is used by packer process to store compressed temporary files that are subsequently stored in ZIP container. Current version of HSM uses only GZ compression.

Source store: HSM store that is processed by ‘Asynchronous packer’ task.

Target store: HSM store where ZIP containers are stored as a result of ‘Asynchronous packer’ task


NOTE: Files archived into HSM with compress option enabled at schema always remains at source store regardless settings of temporary store for packages. These files also do not use ‘Temporary store for packages’ since they are already compressed. This behavior is by HSM design.


Tasks tab



On this tab you can create asynchronous operations for HSM. The ‘asynchronous’ means that if the user creates a task, this task can be executed in the near future (if possible) not immediately after the creation. Basic tasks are the following:

·Copy from store to store

·Move from store to store

Advanced tasks based on specific criteria can be also created.





Creating Move / Copy task

NOTE: Before creating any asynchronous task, stores must be created under the Stores tab.

Click Create / Move task (or Copy task). In the pop-up dialog specify all task configuration options:

In the Source store dropdown menu select the store from which the files will be moved (copied).

In the Target store dropdown menu select the store to which the files will be moved (copied).

In the Name text box type the task display name or click Generate to fill in the text box with generic name.

It is a good practice to add a short Description of the task.

Check the Resume at FILEID check box if you want the task to “remember” the last processed file and resume at the next one when it starts again after a pause. (The textbox displays the file ID of the latest processed file.)

Check Activate to enable the task.

Check Auto-deactivate should you wish the task to become inactive as soon as it carries its work out. The check box is available only when Resume at FILEID is checked.

Use the Scheduling box to set the task runtime. Besides the default perpetual unlimited scheduling, you can add your own start time and stop time by clicking Define. There can be several schedulers defined. Then select the actual scheduling time. The task will be started every day at the defined time.


NOTE: Scheduling can be modified anytime. To do it, select it in the list and click Modify. If “anytime” is selected the task starts whenever the MAM HSM Asynchronous Operations service starts.



Once the task is configured, click OK. The task displays in the Tasks list.



Creating Advanced Task

Advanced task allow configuration of specific task criteria. To create the Advanced task:

1.Click Create / Advanced option from the menu. Task wizard opens. In the first dialog enter the general task configuration:

Store – select the source store for which the task should apply

Task name – enter tasks display name

Description – it’s a good practice to add short task description

Click Next.



2.Advanced task can consist of several operations. This dialog allows you to define the operations and the sequence in which they should be performed.

To do so, select the operation in the Operations list and click the arrow to add the operation to the Task operations list. The operation sequence can be customized easily by selecting the desired operation and moving it up or down by clicking the Move up / Move down arrows under the list.



3.In case no operation is created in the Operations list or you wish to create a new one, click the Create button. You will be able to create:

a)Store operation (Copy, Move and Delete) or

b)Packer operation



a)Store operation

In case the Create/Store operation has been selected, the Store operation configuration dialog opens. The source store will be the store you have selected in the previous dialog. In the dialog enter the operation configuration:


Operator – select the type of store operation you wish to create (Copy, Delete, Move)

Target store – target store where ZIP archives are stored

Name – Name of the operation. To generate the name automatically click Generate button.

To confirm, click OK.



b)Packer operation

In case the Create/Packer operation has been selected, the Packer operation configuration dialog opens. In the dialog enter the operation configuration:


Packer – select the packer which the task should apply. Packers are defined in Packer tab.

Target store – target store where ZIP archives are stored.

Name – Name of the operation. To generate the name automatically click Generate button.

To confirm, click OK.



When finished, click Next.


4.As a next step set up filters defining files to be processed from the source store. To do so, click the filter you want to use from the left pane:

·Resume at – the task will start from the specified file

·Schema – specifies the schema under which the files are store

·Expired – (yes/no) – specifies whether files where retention time has expired should be processed

·File ID – specifies the ID of files

·Date – specifies the archive date

·Size – specifies the file size

The filter displays in the main pane where you can configure it. To remove the selected filter, click its name again.



SQl View tab – displays the defined filter criteria in SQL View. When you are modifying already existing task it is not possible to edit the query using the Query Builder directly. You have to edit your query in the SQL view. Should you want to use the Query Builder, you have to create a completely new query.

Click Next.


5.Finally set the task scheduling. Make sure to check the Active check box to enable the task.

To set Run interval when the task will be executed, select the desired option from the list or click Define button to set up custom interval.

Check Auto-deactivate should you wish the task to become inactive as soon as it carries its work out. The check box is available only when Resume at FILEID filter is defined.

Finally click Finish.




Once the task is created, it displays in the Asynchronous task list view. Menu under the Asynchronous Tasks list provides access to the following functions:

·Create – create a new asynchronous task; two most common tasks can be created directly:

oMove task

oCopy task

Other specific tasks can be created via wizard that is launched by clicking the Advanced option.

·Change – change settings of the task selected in the list view (for detailed description see the section “Creating Advanced Task”)

·Delete task – delete the selected asynchronous task

·Action – access to immediate Start, Stop or Restart of the selected task

·Logs – view log of the selected task or clear the respective log or logs of all tasks

·Refresh – refresh the tasks list



·Creating an MS SQL database with a database user

·Remote HSM Server

·HSM configured for firewall (Windows Server 2008 R2 SP1 / 2012 / 2012 R2 / 2019)

Creating an MS SQL database with a database user

When planning to install HSM, an empty database and an appropriate database user must be created before running the setup. The database providers supported by HSM are MS SQL Server 2008 and higher and Oracle 11g, 12c and 18c.

NOTE: This section guides you through the configuration of SQL Server 2012 and creation of a database with a database user. In case of higher versions, you can use this as a reference.


To configure your SQL Server 2012:


1.Open the SQL Server Configuration Manager and click the SQL Server Services node. Both the SQL Server (SERVERNAME) and the SQL Server Browser services have to run.



2.If the SQL Server Browser service is not started and the Start option available in its context menu, it means that this service is disabled. To enable the service, right-click it and from the context menu select Properties.



3.The Properties window opens. Switch over to the Service tab and change the Start Mode from Disabled to Manual. Conclude by clicking Apply and OK and then try to start the service again.



4.In the SQL Server Configuration Manager expand the SQL Server Network Configuration node from the navigation tree. On the Protocols for SQL node you need to enable the Named Pipes, the Shared Memory and the TCP/IP protocols.



5.Instead of enabling the TCP/IP using the context menu, we recommend opening its Properties window. This window has two tabs, Protocol and IP Addresses. On the Protocol tab set the Enabled to Yes.


6.On the IP Addresses tab you will see several sections - one for each network connection and a local loopback connection indicated by the standard address of For remote access to the SQL Server Express 2012 instance the loopback connection is of no interest.

For the desired network connection the Active option should say Yes as should the Enabled option. The IP address will probably be filled in for you (by Windows) and will be different on your machine.


If you wish to enable dynamic ports for your SQL Server Express 2012 instance then the TCP Dynamic Ports option should be 0. To disable this option and use a fixed port change this field to a blank value and fill in the port on the TCP Port option. Disabling dynamic ports is non standard for named instances and should really only be done if you know exactly what you are doing and why you want to do it.

Conclude by clicking Apply and then OK.



7.For the changes to take effect you need to restart both the SQL Server (SERVERNAME) and SQL Server Browser services have to be restarted switching over to the SQL Server Services node.

8.Check the Shared Memory, the TCP/IP and the Named Pipes client protocols on the SQL Native Client Configuration node in the SQL Server Configuration Manager too. They should all be enabled.


9.Conclude by clicking Apply and then OK. To apply changes, go to SQL Server Services > SQL Server (<instance_name) and click Restart.


Furthermore you will need to create the empty database and a database user (a SQL Authentication) for your Archive Manager. To do so:

1.Connect to your SQL Server 2012 with the Microsoft SQL Server Management Studio, then expand its tree and right-click on the Databases node and choose to create a new database.

2.On the New Database dialog, give the new database a name (for instance exchangeDB) and you can leave the owner to be the <default>. This owner will be changed later on, when you will create a new login with table owner rights over the database you are creating. You can also choose to change the default location for the Data file and Log file, if needed. Conclude by clicking OK.



3.To create the Table Owner for the exchangeDB database you will need to create a new login, a new scheme and a new user as well. We will name each one of them exchange. To create a new login, expand the tree of the Microsoft SQL Server Management Studio tool. Right-click on the Security tab and choose New/Login.

4.The new dialog opens. Before proceeding further on the General tab decide on the type of authentication to be used:

Windows authentication - the user (e.g. “exchange”) must already exist in the Active Directory. Use the Search button to find your desired user in AD.

SQL authentication – specify the login name (“exchange” in our example). Make sure to uncheck the Enforce password policy check box.




As for the Default database, select the exchangeDB database and set the Default language to be English.

Note: As default the Enforce password policy, the Enforce password expiration and user must change password at next login checkboxes are all selected. You need to make sure that none of them is selected.


5.Once this is done, you can switch over to the User Mapping tab. Here map to the exchangeDB database a user (it will be automatically created and named with the same name as the login) and select also the db_owner and public membership role for the exchangeDB database.



6.Switching over to the Status tab make sure the Permission to connect to database engine is granted and also that the Login is enabled. Conclude by clicking OK.



7.Next you will need to create a schema for your new database login. To do so, expand the tree on the new created database (exchangeDB) in the Microsoft SQL Server Management Studio tool down to Security/Schemas. Right-click on Schemas and choose New Schema from the context menu.

On the new schema dialog just give a name to the schema you want to create (name it for instance exchange) and click the browse button to select the schema owner. Select the schema owner to be the previous user you have specified in step 4 (exchange). Conclude by clicking OK.



8.Furthermore you will need to assign the new created schema to your new database user. The new database user (exchange) was automatically created when creating the new login and mapping a user to the exchangeDB database.

To locate this new user, expand the tree of the exchangeDB database in the Microsoft SQL Server Management Studio tool down to Security/Users.

By expanding the Users node you will see the user called exchange.

Double-click on it to open its properties window.

Click the General tab. Here the default schema assigned to your new user is the dbo and you will have to replace it to the one previously created (exchange) by clicking the browse button.



9.Switch to Owned Schemas node where you will see that the one called exchange is selected. Make sure that the db_owner is selected too.

Now switch to the Membership node and make sure that db_owner is selected here, too. Save the changes you have made by clicking OK.



At this point we have successfully created one database (exchangeDB) with a database user (exchange). The database, database user, database-user password and database owner will have to be entered in the database Configuration tool.


Related Documents