Chat now with support
Chat with Support

Metalogix Archive Manager for Files 8.3 - HSM Guide


HSM (Hierarchical Storage Management system), as a data storage systemis a complement of several Metalogix archiving products.

HSM, as a complement of Archive Manager products, can be installed by:

·HSM separate setup

·Installation package of the given Metalogix product (Archive Manager for Exchange Installation package, Archive Manager for Files Installation package etc.)

When installed by the Installation package as a part of the Archive Manager product installation, necessary configuration is performed by the Installation package itself (see the "Archive Manager Quick Start Guide" etc.).

This manual leads you through the HSM installation and configuration when the separate HSM setup is used, i.e. when the Archive Manager product and its components are installed manually.

HSM allows storing of data (even all company data) on one or more file-servers. It is possible to use a shared store as well. HSM includes the Single Instance Store service (SIS), which ensures that identical content is stored only once. The SIS service enables versioning, allowing the HSM system to keep track of any changes made to files or emails. With versioning enabled, the administrator may retrieve older versions. Even if the original file or email was deleted, it can be restored back.

Process of archiving using HSM store


When archived with Archive Manager, the desired file or email with its attachments is transferred to the HSM system. It is the HSM System that takes care of storing and retrieving files/emails. The HSM system works with a database because the information contained in the shortcut is stored either in an ORACLE or MS SQL database. The HSM system passes down the file/email to a store specified by the administrator and this file/email is compressed “on the fly”. Only shortcut of a few kilobytes remains at the file/email’s original location. This shortcut includes information about the new location of the archived file/email. The only difference a user notices is that the shortcut is displayed with a slightly modified icon.

Users may work with archived files/emails as usual which means: when an archived file/email is reopened, Archive Manager passes the information from the shortcut onto the HSM system. The HSM system restores the file/email from the store. For users it seems as if they are working in a normal environment.


The HSM system includes the Single Instance Store service (SIS), which enables versioning in cooperation with Archive Manager products. Due to versioning the HSM system keeps track of any changes made to a document, e.g.:

·who modified the document;

·when this modification occurred;

·what was modified within the document.

With versioning enabled, the administrator may retrieve older versions. Even files whose shortcuts were deleted can be retrieved as well.


The HSM Server (Hierarchical Storage Management Server)

The HSM Server (i.e. the computer where the HSM system is installed), as a complement of Archive Manager products, takes care of saving and securing archived documents. Archived data reside in store. HSM works with different store types depending on administrator’s choice.

Supported operating systems:

oWindows Server 2012

oWindows Server 2012 R2

oWindows Server 2019



·.Net Framework 2.0

·.Net Framework 3.5 – if not available, setup can be installed but the following store types will not be functional:

Amazon S3, Windows Azure, Caringo CAStore, EMC Atmos, FileNet IS, Hitachi HCAP, Hitachi HCP, Nirvanix, Rackspace, Simple Foldering Store, XAM

·.Net Framework 4.5 – if not available, Google Drive store will not be functional.

NOTE: If .NET Framework 4.5 is installed after HSM, it is necessary to run the HSM setup in “Repair” mode to enable the Google Drive store.

·IIS (32-bit support) – if not available, setup will continue but the HSM web client will not be installed.

·Microsoft WSE 3.0 – if not available, the iTernity store cannot be created.

·Database - ORACLE Database (version 12c or higher) or MS SQL Server (version 2012 or higher).


General database requirements:

·If you are using an MS SQL Database, then installation of MDAC (Microsoft Data Access Components) is necessary, as it contains the required OLEDB Data Provider for MS SQL Server. The MS SQL Data Provider for .Net is also needed for accessing MS SQL (part of the .NET Framework installation). We recommend installing the latest version of MDAC (Currently we recommend installing MDAC 2.8.)

·If you are using an ORACLE Database, and it has not been installed on the HSM server, then an ORACLE Database Client must be installed on your HSM server and a Net8 connection from the HSM server to the ORACLE Database server must be established. The ORACLE OLEDB Data Provider (part of the MDAC installation) and the Oracle Data Provider for .Net (part of the .NET Framework installation) are required for connecting the ORACLE Database.

Databases with the database user(s) (who, in addition, should be the owner of the database) have to be available before HSM installation.

Creation of database with a database user in MS SQL 2012 is described in “Addendum – Creating an MS SQL database with a database user”.

NOTE: If you prefer working with an ORACLE Database, make sure to have similar data (database, database user, password, owner of the schema) available during the installation of Archive Manager for Exchange.

Installation of HSM

To install HSM on your HSM server, follow these steps:

1.Run HSM Setup.

2.On the Welcome page click Next.

3.On the Logon Information page specify the user account under which the application will be running. It must be in the format DOMAIN\Username.

Snap 2

4.If the Windows Firewall is on and enabled, it is necessary to allow HSM components to communicate through Windows Firewall. The components (COM+ Network access and HSM services) will be added to the Windows Firewall Exception list. Click Next, then Install.


5.Upon successful installation of HSM, click Finish to exit the wizard.

Snap 5


Configuring HSM

When installation of HSM is complete, the Configuration tool opens. Here you need to configure HSM, i.e. you need to specify:

·database you will be using;

·schema; and

·media store where files will be archived.


NOTE: In the Configuration tool you can see also tabs of other Archive Manager products, if they are installed on the machine. In this manual we will describe the configuration just for the HSM tab.


NOTE: Whenever you change the database password, use the Configure button of the Configuration tool to configure the database connection string. It is not enough to update the database objects in this case, since it is not updating the connection parameters.

When updating HSM from one version to another you must NOT change the following values in the Configuration tool:

1.Initial Catalog: this is the default Database where the system is writing and reading from. This name should never be changed, unless you do not specifically restore all the prior archived data back and decide to start all over with a fresh new database for the product. If by mistake another database is used the old archived data is no longer reachable.

2.Table Owner: this is the default table owner used by the product. This SQL Table owner must be always the same, even if you move the SQL databases from one SQL server to another. If another SQL Table Owner name is created and used for the archiving product all the tables will be re-created as duplicate and the system will write in the new table set. As an end-effect the old archived data will not be reachable anymore. For SQL 2012 or higher, the Table Owner is the SCHEMA NAME of the database.

3.Server Name: this is the name of the SQL server where the databases used by the Metalogix product are hosted. It is only allowed to change this name if the database(s) the Metalogix product uses are moved from one SQL server to another

To configure the HSM, follow these steps:

1.In the initial Configuration window select the HSM tab in the left pane. (By default Configuration tool can be found under C:\ Program Files (x86) \ Common Files \ PAM \ PAMConfig.)



2.Click the Configure button to start the Database Connection Wizard and update the configuration settings.



3.In the case that you are working with an MS SQL database, select the Microsoft SQL Server option and then click Next.

NOTE: For an Oracle database select the Oracle option.



4.On the next page please enter the requested data:

·If you have selected Microsoft SQL Server in the previous window, fill in these fields:

Server name (the name of your MS SQL server)

Initial catalog (the name of the database for HSM)

Table owner (the owner of the table or schema)

Authentication (authentication type used for the database)

User name (the database login name, if applicable)

Password (enter the requested password, if applicable)




·If you have selected ORACLE in the previous window, fill in these fields:


Schema (the name of the schema where HSM tables will be created)

User name (log-on user for the database with read and write rights to the table)

Password (log-on user’s password)


Afterwards, click Next.




5.Click the Finish button. Next, you will have to run the database scripts.

Back in the Configuration window on the HSM tab the data you have entered are now filled in. Run the scripts by clicking the Run Scripts button in the Scripts section.

f-execute scripts


6.Now enter the database user under which the scripts will be run. If the Use the default user credentials option is checked, the user set in the database connection configuration part is used. If the Use different credentials option is selected, it is possible to choose the type of Authentication and other user’s credentials. For the SQL Server Authentication specify the Database user and Password. Remember that the user must be allowed to create or modify tables and procedures in the database. Click Next.

g-dat user


7.Next choose the way to run the scripts. Either run them automatically (Run database scripts by this wizard option) or you can get the scripts and run them manually on your own by copying and running the script in a third party tool (SQL Manager, TOAD etc.)

We have selected the 1st automatic option. After clicking Next and again Next a confirmation dialog displays. Click OK, then Finish.

g-select method


8.Back in the Configuration tool switch to the Advanced tab. The HSM system includes the Duplicate Files Detection service, it means that identical files are stored only once.

In the Duplicate files detection section you may specify the duplicate detection method:

a)Select the Detect by content option, should you wish to use the size, checksum and content for detection.

b)Select the Detect by checksum option, should you wish to use the size and checksum for detection;

c)Select Do not detect duplicate files option, should you wish to disable this detection



In the Caching part:

Use caching in case of slow storages (tape etc.). HSM will cache the recently used files to speed up the retrieving process.

If Enable caching is checked, HSM will copy all retrieved files to an HSM internal cache. To set the Cache directory (which should be a local hard disk), use the Browse button next to the respective text box. If you have a cluster, the HSM will know that each installation has its own path.

Set the Minimum cache size and Maximum cache size as well. The Minimum size should be about 80% of the cache size. If the cache is full, HSM will delete files (the oldest first) until the cache reaches the “minimum size”.

NOTE: To set which specific store should be cached, go to Stores tab. Then select the store and click Manage to edit its configuration.

The HSM stores temporary files created during duplication detection, compression etc. in temporary directory. Its location can be set in Temp directory text box. Usage of environment variables is allowed in this box (e.g. %TEMP% denotes the temp folder of the currently logged on user).


9.Now click on the Stores tab. You need to create a MediaStore and you need to specify a schema here.



To create a MediaStore, see the next part: “Creating a MediaStore”.

To specify a schema, see the part “Specifying a Schema”.

If you already have created a store, e.g. on a remote server, add it to the Stores list by clicking the downward arrow next to the New store button and selecting Attach.

NOTE: You must have at least 1 store and at least 1 schema available in order to archive with Archive Manager. For each HSM store (MediaStore) assign a schema. Assigning more than one schema for the same HSM store where Archive Manager will be archiving files is also supported.

Self Service Tools
Knowledge Base
Notifications & Alerts
Product Support
Software Downloads
Technical Documentation
User Forums
Video Tutorials
RSS Feed
Contact Us
Licensing Assistance
Technical Support
View All
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating