1. Home
  2. Tools
  3. FSA Migrator
  4. FSA Migrator Configuration and Administration
  1. Home
  2. Tools
  3. FSA Migrator Configuration and Administration

FSA Migrator Configuration and Administration

This article explains how to configure, administer, and monitor Quadrotech’s FSA Migrator on an existing Enterprise Vault environment.

It describes:

  • Configuration of FSA Migrator
  • Monitoring FSA Migrator

Prerequisites

It’s essential to have a working knowledge of:

  • Microsoft Windows Operating Systems used in the deployment
  • Enterprise Vault
  • How Enterprise Vault is deployed in the environment
  • An overview of to where you’ll restore data
  • The networking infrastructure between the systems in the environment
  • Information on how FSA Migrator is installed in the environment

Launching FSA Migrator

FSA Migrator can be launched from the Windows Start Menu.

The opening screen is used for monitoring the progress of the data migration. This will be covered later in this article.

Note: When you launch the application ensure that Run as administrator is selected.

Adding a Source and Target

FSA Migrator needs to be given source and target mappings. This can be one source to one target, many sources to one target, or even many sources to many targets. To configure this mapping of source to target click on the green ‘+’ sign, as shown below:

When the ‘+’ sign is selected, enter (or browse) to source and destinations, as shown in the following dialog:

Note: Normally FSA Migrator uses the file server and chosen share as the source of data migration; however, it is possible to choose an Enterprise Vault Directory Database as the source.

Once a source and target have been entered, along with any of the other additional configuration options which can be specified the main FSA Migrator screen will look like this:

Depending on the configuration of the schedules for FSA Migrator the location that has been added will be scanned shortly after it has been added.

Note: If scanning of the folder doesn’t take place shortly after it has been added, restart the FSA Migrator Service using the Windows Service Control Manager.

Monitoring Migration

Monitoring the progress of FSA Migrator is key to recording the progress of the file server migration. Progress can be seen from the main FSA Migrator screen, as shown below:

When FSA Migrator begins running progress can be seen in a number of panels, as outlined below.

Folder Scanning

When FSA Migrator is scanning a particular source for work items, the Scanning checkbox is enabled. This gives a visual indication that FSA Migrator is working on this entry in the work-queue:

Statistics

The statistics panel shows key information regarding the number of files and folders which have been identified for processing:

Error Statistics

Careful monitoring should be performed on the Error Statistics panel:

Clicking on the upper right hand corner of the panel will show a list of files that errored along with relevant information relating to the failure:

The following table describes each of the statistics shown in the user interface:

Error Statistic Description
Source A source error means that the source file is not accessible, perhaps due to special permissions on the file.
Enterprise Vault An Enterprise Vault error means that there was an issue obtaining the file from Enterprise Vault.
Destination A destination error typically means that the destination file exists, and the FSA Migrator overwrite settings were configured such that overwriting the destination file was not performed.  In other words this type of error may be normal depending on the configuration.
Corrupted A file was detected as corrupt following retrieval from Enterprise Vault.  The number of characters which are checked is configured in the FSA Migrator Settings, and it is also possible to turn this off for all files, or to exclude particular extensions from the corruption check.  When the check is performed, the raw bytes from the file are checked for null.
Deleted A deleted error indicates that after the folder/file scan took place using FSA Migrator that the source file has been removed.
Failed Corruption Check A count of the number of items where it was not possible to check for file level corruption.

The list of failed items can be exported to PDF, XLS, or CSV format.

Overall Progress

The overall progress of the migration can be observed in the panel at the top right hand side of the FSA Migrator window, and in the pie graph at the lower right hand corner:

Overall Statistics

The overall statistics for the migration are also visible as numerical values on the right hand side of the FSA Migrator window:

There is a refresh button and alongside there is a button which will display detailed information relating to the progress over time of the migration:

The information on the details page can be exported to PDF, XLS or CSV format.

Current Throughput

The throughput currently being observed by FSA Migrator can be seen in the following panel:

Configuring a Schedule

FSA Migrator performs a number of tasks on a schedule. The defaults for these schedules are shown below:

Schedule Default
Normal Files Migration Always
Archive Files Migration Always
Folder Scanning Always – 720 minutes between scans
Archiving (after migration) Never
Folder Creation Never
Database Scan Never

These schedules can be changed, as required.

Modifying the Throughput

FSA Migrator obviously generates a performance load on the source file servers, source Enterprise Vault system, target file servers, target Enterprise Vault system (if archiving is configured to take place following migration) and SQL Servers in each of the environments. The defaults for the number of threads, and therefore the amount of work generated by each part of FSA Migrator is shown below.

Area Default Number of Threads
Folder Scanning NA
Archive Files 25
Normal Files 25
Folder Creation NA
Database Scan NA
Archiving Files after Migration 5

It should be remembered that during the migration of the data files the load is generated primarily on the Enterprise Vault server. The load on the source file server is minimal – FSA Migrator only needs to check the placeholder exists on the source.

Factors Affecting Choice of Thread Counts

The number of threads to use for each aspect of the migration is dependent on many environmental factors such as speed of systems involved, network connectivity between environments, existing user load and so on. It is not possible to recommend a particular value or set of values, however, the following will help in determining an optimal number for the environment being worked on.

When making changes to the number of threads away from the defaults that are supplied with FSA Migrator it is important to carefully monitor all of the source and target systems to ensure that they are performing well, and that end-user operations are not being impacted by any change which has been made.

If desired, use this table to determine the affects the changes have had on the environments.

The table should be modified to include each of the source and destination components. For example if there are three source file servers, and one target, then modify the table to show the data for three source file servers, rather than one in the example.

In order to judge the value to be recorded in the table, so that it can be compared when changes have been made, it is suggested that the average for 1 minute is used over the course of an hour. The values can be obtained by configuring Performance Monitor to capture the disk IO and CPU load at 1 minute intervals for a period of 1 hour.

For further assistance and guidance on the values to be used in a specific environment, or how to configure Performance Monitor to capture the required data contact Quadrotech Support as described at the start of this document.

Archiving Files after the Migration

FSA Migrator can ingest items in to a new, target Enterprise Vault environment during the migration. There are three aspects of this feature which need to be configured:

Configuring the Archive Files Schedule/Threads

The number of worker threads, and the schedule for when FSA Migrator will ingest items in to a new Enterprise Vault environment have been described in the previous section.

Configuring the Target API Server

FSA Migrator makes use of the Enterprise Vault 10.0.2 FSA API to ingest items. This means that the target environment must be running Enterprise Vault 10.0.2 or later, or this functionality will not be available. To configure the FSA API Server navigate to:

Settings > Archiving

In this dialog the FSA API Server must be specified using an FQDN. In addition the port number can be given, along with whether FSA Migrator needs to communicate to the FSA API Server using SSL or not.

Configuring Retention Category Mapping

The source and destination Enterprise Vault environments may have different retention categories and in order for FSA Migrator to ingest the items into a target environment a mapping of retention categories need to take place. In order to configure the mapping navigate to:

Settings > Archiving

This dialog will show a list of the mappings if any have already been configured. The retention categories from each environment can be loaded by clicking on the green ‘+’ button:

Once the retention categories have been loaded, the source categories can be mapped to destination ones.

Configuring General Settings

FSA Migrator has a number of additional general options governing its operations. These are accessible by navigating to:

Settings > General

The values which can be configured are:

Area Default Description
Retry Count 3 The number of attempts which will be made to migrate the file
Overwrite Handling Never What should happen if a file is encountered on the target with the same name
Copy Permissions True If this is selected the permissions will be copied from the source to the target.
Offline Corruption Check Selected By default FSA Migrator will check for corruption on any file which is retrieved from Enterprise Vault
Number of characters in each file to check 100 When checking for corruption, the first 100 characters are checked by default
Corruption Check Excluded File Extension Blank If particular file extensions are being reported as corrupt, they can be excluded from the corruption checking mechanisms by entering a list of file extensions here

Stopping and Starting the FSA Migrator Service

FSA Migrator has a service which runs the migration. This is shown below:

The service can be restarted from Server Manager or the Windows Service Control Manager.

Changing the UI Refresh Frequency

By default the FSA Migrator User Interface will refresh the data it is showing every 2 minutes. This can be changed if required, by following these steps:

  1. Open Windows Explorer and navigate to the folder where FSA Migrator is installed, for example: C:\Program Files (x86)\QUADROtech\FSA Migrator.
  2. Locate the file called FSAMigratorUI.exe.config.
  3. Edit the file with notepad.
  4. Change the value for FetchInterval to the required number of seconds.
  5. Save and close the file.

After making the change to the configuration file, close the FSA Migrator Console and re-open it.

Print Friendly, PDF & Email
Updated on May 2, 2019

Was this article helpful?

Related Articles