Chat now with support
Chat mit Support

Archive Shuttle 11.0 - Administration Guide

Introduction Configuring Archive Shuttle Using HOTS Using the Archive Shuttle user interface Dashboards Manage Configuration Advanced configuration Monitoring Logging Reporting Journal Transformation migration PowerShell guide Troubleshooting

Workflow commands

Below is a list of workflow commands that can be applied to workflow policies.

Name

Description

SyncEVEnvironment

Synchronize Enterprise Vault Environments vault stores and associated metadata

TransferArchiveForVaultStore

Collect archives of specified EV Vault Store

CollectItemsForArchive

Collect items of Enterprise Vault archive

CollectShortcutsFromMailbox

Collect Enterprise Vault shortcuts from Exchange On-Prem mailbox attached to Enterprise Vault archive

TransferEVContainerInfo

Collect statistics of Enterprise Vault archive

TransferDeletedItems

Collect deleted Enterprise Vault items of specified Vault Store, mark them in Item Database as deleted (DeletedDateUtc) and remove from routings for migrations which did not start yet

CollectIFoldersForArchive

Collect Icon Folders for EV Archive

CollectJournalSenderRecipients

Collect sender, recipient(s) from EV Archive item(s)

CollectDACases

Collect cases from EV Discovery Accelerator

CollectDACaseItems

Collect items from EV Discovery Accelerator case

CloseDACase

Closes EV DA Case

ExportArchive

Export items from Enterprise Vault archive

GetStagingFreeSpace

Get information about free space on Staging Area

ImportArchive

Import items into Enterprise Vault archive

ImportJournalArchive

Import items into Enterprise Vault journal archive

CheckBackupMode

Check backup mode for EV Vault Store (if BackupMode is enabled then ingest is put on hold)

CheckIndexComplete

Check index COMPLETE for EV Vault Store [SELECT COUNT_BIG(IndexCommited) FROM dbo.JournalArchive WITH (NOLOCK) WHERE dbo.JournalArchive.IndexCommited = 0]

EnableMailbox

Enable mailbox for Enterprise Vault archiving

DisableMailbox

Disable mailbox for Enterprise Vault archiving

ZapMailbox

Remove all Enterprise Vault customized archiving settings from the root of the mailbox and any folders within the mailbox

ZapArchivePermissions

Remove all Enterprise Vault archive permissions

CreateArchive

Create new Enterprise Vault archive

AssignArchive

Assign Enterprise Vault archive to mailbox by attaching archive to LegacyMailboxDN

RenameSourceArchive

Rename Enterprise Vault source archive (by default attach prefix/sufix to origin name or use custom name)

DeleteArchive

Delete Enterprise Vault source archive

RenameTargetArchive

Rename Enterprise Vault target archive (by default attach prefix/sufix to origin name or use custom name)

DisableOrphanedArchive

Set archive in Enterprise Vault system to status "Closed"

CopyPermissions

Copy Enterprise Vault Inrasite archive permissions

ResolveEVArchiveDefaultFolders

Resolve EV archive default folder icons

FixShortcuts

Fix Enterprise Vault shortcuts in the mailbox to point to the new Enterprise Vault archive

DeleteEVShortcut

Delete Enterprise Vault shortcuts from Exchange On-Prem mailbox

RevertPendingShortcuts

Revert "Pending" Enterprise Vault shortcuts back to the origin message class in the Exchange On-Prem mailbox

DeleteEVConfiguration

Remove hidden EV messages from Exchange On-Prem mailbox

RemoveVirtualVault

Remove EV Virtual Vault from Outloook for Exchange On-Prem mailbox

RemoveEVButtons

Remove (hide) buttons from Outlooks Enterprise Vault Add-In for Exchange On-Prem mailbox

RestoreEVForeignShortcuts

RestoreEVForeignShortcuts

Office365RestoreEVForeignShortcuts

Office365RestoreEVForeignShortcuts

EVRestoreEVForeignShortcuts

EVRestoreEVForeignShortcuts

RestoreSourceOneForeignShortcuts

Collects foreign SourceOne shortcuts information

ExchangeImportToArchiveMailbox

Import exported items into Exchange On-Prem secondary (archive) mailbox

ExchangeImportToPrimaryMailbox

Import exported items into Exchange On-Prem primary mailbox

ExchangeImportToJournalMailbox

Import exported items into Exchange On-Prem journal mailbox

TransferDomainList

Retrieve all available domains

TransferAllUsers

Retrieve all Active Directory users

TransferSingleUser

Retrieve single Active Directory user

TransferExcDBs

Retrieve Exchange databases

TransferExcServers

Retrieve Exchange servers

TransferExcDAGs

Retrieve Exchage Database Availability Groups (DAG)

TransferDeletedUsers

Retrieve deleted Active Directory users

-

Update modules via Archive Shuttle User interface

StopService

Stop Archive Shuttle service/module

StartService

Start Archive Shuttle service/module

Restart Service

Restart Archive Shuttle service/module

GetAzureCredentials

Retrieve Azure credentials stored in Credentials editor

GetPowerShellScriptCredentials

Retrieve PowershellScript credentials stored in Credentials editor

AutoRestartModule

Tries to restart unintentionally stopped module(s)

RecreateMapiProfile

Tries to re-create MAPI profile when current MAPI profile is not functioning

GetAmazonCredential

Retrieve Amazon credentials stored in Credentials editor

WaitForImportFinished

Wait until all routed items are imported

StagingAreaCleanup

Remove non-relevant or successfully imported items from the Staging area

SendEmailNotification

Send Email Notification

Office365ImportToArchiveMaibox

Import exported items into Office 365secondary (archive) mailbox

Office365ImportToPrimaryMailbox

Import exported items into Office 365primary mailbox

Office365DeleteShortcuts

Delete Enterprise Vault shortcuts from Office 365 mailbox

Office365RevertPendingShortcuts

Revert "Pending" Enterprise Vault shortcuts back to the origin message class in the Office 365 mailbox

Office365DeleteEVConfiguration

Remove hidden EV messages from the Office 365 mailbox profile in Outlook

Office365CollectMailboxes

Collect all available primary Office 365 mailboxes

Office365CollectArchiveMailboxes

Collect all available secondary (archive) Office 365 mailboxes

Office365CollectShortcutsFromMailbox

Collect Enterprise Vault shortcuts from Office 365 mailbox attached to Enterprise Vault archive

Office365CollectLicenses

Collect all available Office 365licenses and its statistics

Office365CreateArchiveMailbox

Creates archive/secondary mailbox for Office 365

 

info

NOTE: The user must have an Office 365 mailbox prior to using this command.

 

Office365EnsureLicenseAssigned

Checks for licenses for a mailbox. The command will fail if there is no existing license.

 

info

NOTE: For pre-migration workflow policies only.

 

Office365RemoveLicense

Remove Office 365 license from the mailbox.

Office365ProvisionMailbox

Provision new Office 365 mailbox.

 

info

NOTE: For pre-migration workflow policies only.

Office365SetLegalHold

Set provisioned Office 365 mailbox on legal hold

Office365AssignLicense

Assign license to provisioned Office 365 mailbox

Office365GetMailboxInfo

Retrieve Office 365 mailbox details

Office365RemoveUser

Remove Office 365user (Stage2 command)

Office365CloudOnlyUserSync

Synchronize Office 365cloud-only users and shared mailboxes

Office365SyncSingleCloudOnlyUser

Synchronize specified Office 365cloud-only user

Office365CollectSingleMailbox

Synchronize specified primary Office 365 mailbox

Office365CollectSingleArchiveMailbox

Synchronize specified secondary (archive) Office 365 mailbox

Office365RemoveVirtualVault

Remove EV Virtual Vault from Outloook for Office 365 mailbox

Office365RemoveEVButtons

Remove (hide) buttons from Outlooks Enterprise Vault Add-In for Office 365 mailbox

Office365SwitchTarget

Switch the container from primary to secondary mailbox for Office 365 mappings

 

info

NOTE: Make sure that an archive mailbox is present in the database for the switch to be successful.

 

Office365SyncDeletedUsers

Remove deleted Office 365 users from database

Office365SyncRetentionTags

Synchronize Office 365 retention tags

NativeFormatImportToPst

Import exported items into PST file

NativeImportRename

Rename and move finished and closed Native import container

NativeImportClose

Close opened Native import container into which no more items are to be ingested

EasCollectArchives

Collect EAS archives

EasCollectItems

Collect items of EAS archive

EasExportItems

Export items from EAS archive

EasGetArchiveStatistics

Collect statistics of EAS archive

EasDeleteShortcuts

Delete EAS shortcuts from Exchange On-Prem mailbox

EasConvertToEvShortcuts

Convert EAS shortcuts into EV shortcuts (Create new EV shortcuts and remove matching EAS shortcuts from the mailbox)

EasDisableArchive

Disable EAS archive for archiving

EasOffice365DeleteShortcuts

Delete EAS shortcuts from Office 365 mailbox attached to EAS archive

EasCollectShortcuts

Collect EAS shortcuts from mailbox attached to EAS archive

EasGetServerInfo

Retrieve EAS server Id

ScanOfflineImport

Scan items within offline media location for import

ExportFailedItems

Move permanently failed items from the Staging Area to a location defined on the target link

ExportFailedItemsToFTP

Copy permanently failed items from the Staging Area to a FTP location

ProofPointImportUser

Import/Convert data to ProofPoint RawXML format

ProofPointImportJournal

Import/Convert journal data to ProofPoint RawXML format

S1ResolveFolders

Collect folders from mailbox attached to SourceOne archive

S1CollectArchives

Collect SourceOne archives

S1CollectItemsForArchive

Collect items of SourceOne archive

S1ExportArchive

Export items from SourceOne archive

S1ConvertToEvShortcuts

Convert SourceOne shortcuts into EV shortcuts (Create new EV shortcuts and remove matching SourceOne shortcuts from the mailbox)

S1DeleteShortcuts

Delete SourceOne shortcuts from Exchange On-Prem mailbox attached to SourceOne archive

S1Office365DeleteShortcuts

Delete SourceOne shortcuts from Office 365 mailbox attached to SourceOne archive

S1CollectOrganizations

Retrieve Exchange Organizations from SourceOne/EMX

S1SyncArchives

Collect statistics for SourceOne archives

S1SyncPstArchives

Collect owners for SourceOne Pst archives

DellArchiveManagerCollectArchives

Collect archives of Dell Archive Manager

DellArchiveManagerCollectItemsForArchive

Collect Items of Dell Archive Manager archive

DellArchiveManagerExportArchive

Export items from Dell Archive Manager archive

DellArchiveManagerDeleteShortcuts

Delete Dell Archive Manager shortcuts from Exchange On-Prem mailbox attached to archive

DellArchiveManagerConvertToEvShortcuts

Convert Dell Archive Manager shortcuts into EV shortcuts (Create new EV shortcuts and remove matching Dell Archive Manager shortcuts from the mailbox)

DellArchiveManagerDisableArchive

Disable Dell Archive Manager archive for archiving

DellArchiveManagerOffice365DeleteShortcuts

Delete Dell Archive Manager shortcuts from the Office 365 mailbox  attached to archive

DellArchiveManagerCollectShortcutsForArchive

Collect Dell Archive Manager shortcuts from mailbox attached to archive

DellArchiveManagerSyncArchives

Collect statistics for Dell Archive Manager archives

PstExportScanDirectory

Scan specified directory for PST source files

PstExportScanPst

Collect items of PST file

PstExportExportItems

Export items from PST file

PSTExportReexportPst

Initiates reexporting of items for corrupted PSTs and removes the corrupted PST file.

PowerShellScriptExecutionRunScript

Execute custom powershell script

JournalExplosionCleanupImportedItems

Remove successfully imported Journal Explosion items from the Staging area

JournalExplosionCheckQuota

Check current usage of recoverable items quota for Journal Explosion

GetExistingFilesInOutputPath

Retrieve content of OutputPath area to check if PST files are still present (based on this information watermark statistics are updated)

UpdateModulesViaUpdater

Update Archive Shuttle modules via dedicated Updater module

StagingAreaUsedSpaceForLink

Starts command that returns the used space in bytes for staging area per link

MetalogixCollectArchives

Collect Metalogix archives

MetalogixCollectItems

Collect items of Metalogix archive

MetalogixExportArchive

Export items from Metalogix archive

MetalogixCollectShortcuts

Collect Metalogix shortcuts

MetalogixDeleteShortcuts

Delete Metalogix shortcuts

MetalogixConvertToEvShortcuts

Convert Metalogix shortcuts to EV

MetalogixDisableArchive

Disables Metalogix archive

MetalogixOffice365DeleteShortcuts

Metalogix Office 365Delete Shortcuts

StorageImportToUNC

Import items to UNC

StorageImportToAzure

Import items to Azure

StorageImportToAmazon

Import items to Amazon

StorageImportSpaceCheck

Check free/used space for Storage Import outputh path

StorageImportUNCSpaceCheck

Command for UNC space check

StorageImportAzureSpaceCheck

Command for Azure blob space check

StorageImportAmazonSpaceCheck

Command for Amazon bucket space check

Migration filters

Migration filters allow an administrator to construct filters that can narrow the data during migration.

The grid contains the following information.

·ID: The identification number associated with the policy.

·Policy Name: The title of the policy.

·Definitions Count: The number of filter conditions added to the policy.

Actions to be performed on the Migration filters page

·New Policy: Create a new policy to add migration filters to.

·New Filter Condition: Add a migration filter to the policy.

·Edit: Edit a migration filter in a policy.

·Delete: Delete a migration filter from a policy.

·Refresh: Refresh the current screen.

·Auto refresh: Choose time parameters to refresh the current screen automatically.

·Columns: Choose which columns to display in the grid.

·Reset: Reset the grid to its default state.

·Load: Load grid layout.

·Save: Save grid layout. Click the Shared box to share the layout to other users.

·Export: Export the grid in a .pdf, .xls, .xlsx or .csv format.

 

How to create a migration filter policy

1.Click New under the Policy section.

2.Enter a name for the migration filter policy.

3.On the newly created policy, select the checkbox, and click Edit under Filter Condition.

4.Select a policy from the drop down list.

5.Select a filter value to filter the data by.

6.Select an operator.

7.Input a value and select the data size from the drop down menu.

8.Click Save.

Filter policies

The Filter Policies page in the user interface allows an administrator to customize filters relating to the data migration and create new ones.

In order to filter by ‘Path’, the ‘Collect Extended Metadata’ must be enabled in System Configuration.

Filters should be given a name to easily identify them, and can be based on:

 

Field

Description

Source

ArchivedDate

The date the item was archived

EV

Path

The path to the archived item

All

RetentionCategory

The retention category of the archived item

EV

HasShortcut

The item has message properties implying it was archived

All

ItemDate

The date/time of the item itself.

All

ItemSize

The size of the archived item

All

HasLegalHold

Whether the items is on legal hold

EV

 

Filter conditions are logically ANDed together. For example, it is possible to migrate date from a particular path AND below a particular size.

info

NOTE: The HasShortcut filter should not be auto-enabled.

Example filters

The following section gives some examples of filters that can be created. Once they have been created in the Admin Interface, they can then be used when performing container mapping operations.

Only migrate items which have shortcuts.

Create New Filter

·Give the filter a name, e.g., “With Shortcut”

Add a filter condition

·Click “New” in the “Filter Condition” section.

·Choose the “Policy” which was created previously.

·Choose “HasShortcut” from the “Filter By” selection

·Choose “Yes” in the “Value” selection

·Click Add

Only migrate items which belong to a particular retention category

Create New Filter

·Give the filter a name, e.g., “3 Year Retention Category”

Add a filter condition

·Click on “New” in the “Filter Condition” section.

·Choose the “Policy” which was created previously.

·Choose “RetentionCategory” from the “Filter By” selection

·Select the appropriate retention category from the drop-down list of categories from the source environment

·Click Add

Only migrate data with ItemDate younger than 2011-12-31

Create New Filter

·Give the filter a name, e.g., “Newer than 2011”

Add a filter condition

·Click on “New” in the “Filter Condition” section.

·Choose the “Policy” which was created previously.

·Choose “ItemDate” from the “Filter By” selection

·Select the Operator “YoungerThan” from the Operator drop down

·Select the date 31st December 2011 from the date picker

·Click Add

System configuration

The System Configuration page in the Archive Shuttle Admin Interface contains many settings that can be used to customize the migration and environment. Some of these settings will affect the workflow of the migration while others will affect throughput and performance.

Changing these configuration options should be done after careful analysis of the current workflow, environment and throughput.

Changes to system settings take place after a few minutes when the appropriate module checks in for new work items.

 

Schedule settings

On the System Configuration page different settings/configurations can be applied according to a schedule.

When you first enter the System Configuration, the default schedule is shown. Configuring specific schedules consists of the following three steps:

1. Create and name a new schedule.

2. Make the required configuration changes for this schedule, above, or below the default schedule.

3. Select the times of day, or days of week that this schedule applies.

Date/Time is based on the date and time of the Core.

 

Example: More export parallelism on Saturday/Sunday

In this example, you will configure higher Enterprise Vault export parallelism for Saturday and Sunday. The steps to follow are:

1. Navigate to the System Configuration page.

2. Review the current configuration, this is the default configuration when no other configuration is set.

3. Via the button on the toolbar, add a new schedule. Give the schedule a name (e.g. Weekend) and choose a color from the available list.

4. Change the EV Export module parallelism settings to the new, higher values that you wish to use. When changes are made the entry will become bold, and a checkbox will appear underneath Custom.

5. Click on Save, in the toolbar, to commit those changes.

6. From the toolbar click on Time Assignment in order to review the current scheduled configurations.

7. Click on the new schedule on the right hand side, and then highlight all of Saturday and all of Sunday.

8. Click on Save on the schedule view in order to commit those changes.

 

General settings

This section contains general settings relating to Archive Shuttle:

Item

Description

General


Do not re-export on File Not Found

Normally if an import module files that a required file is not present on the staging area it will report this to the Archive ShuttleCore and the Core will instruct the export module to re-export the item. If this behavior is not required, select this checkbox

Turn off the post-processing of secondary archives

This will disable the post processing modules from performing actions against an Exchange (or Office 365) Personal Archive

Autoenable Stage 1

Automatically enable Stage 1 when Pre-migration is complete.

Stage 2 Default Priority

The normal priority which will be applied to users when they enter Stage 2.

Autoenable Stage 2

With this option enabled when a container gets to 100% exported and 100% imported, it will automatically move into Stage 2.

Without this option, set containers will remain in Stage 1 until Stage 2 is enabled for them manually.

Delete Shortcut Directly after Import

With this option selected, successfully ingested items in to Exchange, or Office 365 will have the shortcut removed from the target container straight away. Without this option selected, the shortcuts will only be deleted once the Stage 2 command is executed.

This option can greatly enhance the user experience when migrating data back to existing containers (e.g., primary mailbox)

Archive Migration Strategy

When a batch of users has been selected for migration and given a specific priority, within that, a migration strategy can be used to also govern the order that the migrations will take place. The options here are:

·Smallest archive first (based on archive size)

·Largest archive first (based on archive size)

·Oldest first (based on the archived date/time of items)

·Youngest first (based on the archived date/time of items)

The default strategy equates to a random selection within the batch that was chosen

Do not transmit non-essential Active Directory Data

Stops the Active Directory Collector module from returning metadata about users which is not required for the product to function.

Use HOTS format

Instructs the Core and Modules to expect and use HOTS format for items on the staging area.

Clear staging area files older than [hours]

When the staging area cleanup process runs it will only remove files older than this number of hours.

Disable automatic staging area cleanup

Stops the automatic cleanup of the staging area.

Enable Auto Restart of Modules

Causes modules to automatically restart.

Number of retries for Auto Restart of Modules

Specify the number of times modules attempt to restart.

Logging


Default Core Log Level

Allows the logging level for the Archive Shuttle Core to be changed.

Delete ItemRoutingErrorLogs after successful Export/Import

This option allows the system to remove any reference to issues/errors during export or import once an individual has been successfully exported or imported.

Clear Module Performance Logs

By default module performance logs will be kept for 30 days, but this can be changed in this setting.

Item Database


Default size [MiB]

Shows the size that new item databases will be created.

Default log file size [MiB]

Shows the default size of new item database log files.

Item database update retry timeout [hours]

Shows the number of hours that will elapse before upgrades of the item databases will be retried.

User Interface


Global Timezone

By default the system operates in UTC

My Timezone Override

Allows a user specific timezone to be specified

Item size scale

Can be used to control whether item sizes in the user interface are displayed as bytes, Mib, GiB, TiB, or displayed in automatic scale

Options ‘All’ on grids will be disabled when this threshold is exceeded

If a value is specified here it will stop Archive Shuttle giving the option to display ‘all’ values on a grid, when there are a large number of items to display.

Folder


Folder name for folder-less items

Specify a name to use for items which do not have a folder.

Treat all messages as folderless

If enabled this will ignore the folder which was obtained during the export of an item, and just ingest all items in to the folder specified as the ‘folderless items’ folder

Manage Folder Translations

Manage translation of default mailbox folders.

Chain of Custody


Re-export on Chain of Custody error

Instructs the import module to report a Chain of Custody error back to the Core, and for the Core to then queue work for the export module to re-export the item.

Enable Chain of Custody for Extraction

Causes the export modules to generate a hash of items (to be stored in the Item Databases) when items are exported

Enable Chain of Custody for Ingestion

Causes the import modules to validate the Chain of Custody information when items are ingested. If an item fails this check it will not be ingested.

Reliability


Allow import of messages with empty recipient e-mail

If a message is found without recipient information it will normally fail the ingestion process. This can be overridden with this option

Allow import of corrupt messages

Items which fail the MSG file specification may not be ingested into the target container. Some of these failures can be overridden with this option checked.

Enable item level watermarks

Archive Shuttle will stamp items that get imported with a Watermark, specifying details about the Item like Source Environment, Source Id, Archive Shuttle Version, ItemRoutingId, LinkId.

Fix Missing Timestamps

If the message delivery time is missing on a message the messaging library will generate it, from other properties already present on the message

Missing timestamp date fallback

The date to be used in case of a missing timestamp

 

FTP/SMTP settings

This section contains settings relating to the FTP/SMTP configuration (for sending out reports):

Item

Description

SMTP Server

The FQDN of an SMTP server which can be used to send emails

SMTP Port

The port to be used when connecting to the SMTP server

Use SSL

A flag to indicate that SSL should be used to connect

Use Authentication

A flag to indicate whether the SMTP server supports anonymous connections, or requires authentication

SMTP Username

The username to be used for authentication

SMTP Password

The password to be used for authentication

SMTP From Email Address

The ‘from’ address to be used in the outbound mail

SMTP From Name

The display name to be used in the outbound mail

 

FTP/SFTP settings

This section contains settings relating to the FTP or SFTP configuration:

Item

Description

URL

The URL or IP address to used to connect to the server

Username

The username to be used when connecting to the server

Password

The password to be used when connecting to the server

Use SFTP

If ticked, Archive Shuttle will connect and use SFTP. Otherwise, Archive Shuttle will use FTP

 

Journal Transformation settings

This section contains settings relating to journal transformations.

Item

Description

Notes

Delete items from staging are after initial export

If enabled items are removed from the staging area after initial export.

It is recommended to enable this if there is a small subset of users to be migrated. It reduces the requirements on the size of the staging area.

Delete items without journal archive migration import routings

Items without journal archive migration import routings will be deleted from the staging area. It is recommended to enable this if all user mappings are already enabled for import.

It’s recommended to turn this on when all user mappings are enabled for import.

Time to expire inactive items (hours)

Set value to '0' to disable this setting. Can only be applied if setting 'Disable automatic staging area cleanup' is inactive.


Mailbox Quote Exceeded Threshold (%)

Ingest of items will stop once mailbox size has reached this quota. Ingesting will restart after quote is increased or size has decreased to below quota threshold.

Ingest will resume if the quota is increased, or the mailbox size is reduced.

Ingest users with most items first

Ingest users with higher amount of item counts first.


Skip items which do not belong to user mapping

Items which are older than the user will not be ingested into the target. This setting isn't applied for leavers, re-created users and manually mapped users.

This setting does not apply to leavers, re-created users and manually mapped users.

Export items for users enabled for ingestion only

Only sender recipients collected via EV index which are enabled for ingestion are exported. When this setting is disabled, all collected items are exported.


Enable collection of sender recipients on export

EV export module will start to collect sender recipient data during export of the journal archive. 'Export items for users enabled for ingestion only' setting has to be enabled per mapping to apply this setting.


Export items with permanently failed collection of sender recipients

EV export module will export item for which collection of sender recipients failed permanently.


Enable all SMTP addresses discovered upon exploding

All SMTP addresses discovered during explosion process will be automatically enabled for further processing. The setting is ignored if 'list of accepted domains' is specified.


List of accepted domains

All exploded SMTP addresses are stored in the Archive Shuttle system, however only addresses of domains listed here will be automatically enabled for further processing. All other addresses will be filtered out and not available for user interaction. This setting only applied during the explosion process, and not for already exploded addresses.

If this list is altered during a migration, it will only affect future explosion of items, not the existing items.

Enable automatic 'Merge by preview'

All leaver mapping(s) that are available for merging by preview will be automatically enabled.


Check mailbox quota only for importing users

The quota check command will be executed only for users that are actively importing.


 

EV Collector module

This section contains settings relating to the EV Collector Module:

Item

Description

Collector Parallelism

Defines how many archives will be collected in parallel

Collect Extended Metadata

Reads legal hold and path of items using the Enterprise Vault API for filtering purposes.

It is recommended that this is only enabled when filtering by folder

Use the BillingOwner on Archives which would be otherwise ownerless

This uses the owner set as “Billing Owner” in Enterprise Vault as the Owner of the archive instead of trying to use the entries in the Exchange Mailbox Entry table. This is useful where an Active Directory account relating to an archive has been deleted, for an employee who has left the company for example. This would normally show as Ownerless in Archive Shuttle, but with this switch enabled the Enterprise Vault Collector module will attempt to use the “Billing Owner”.

Ignore LegacyExchangeDN when matching EV users

With this option enabled the ownership detection for EV archives is modified so that the LegacyExchangeDN is not used.

Limit stored results

Stops the module trying to get more work, if there is a backlog of transmissions to be sent to the Core.

Threshold database limit

The number of items in the backlog before limiting takes place

 

EV export module

This section contains settings relating to the EV Export Module:

Item

Description

General


EV Export Archive Parallelism

Defines how many archives will be exported in parallel. Total thread count = EV Export Archive Parallelism multiplied by EV Export Item Parallelism.

EV Export Item Parallelism

Defines how many items should be exported in parallel per archive. Total thread count = EV Export Parallelism multiplied by EV Export Item Parallelism.

EV Export Storage

If using Azure for the staging area storage (or you are migrating a journal archive for an older version of EV where Archive Shuttle is doing the envelope reconstruction) ensure this option is set to Memory, otherwise File System or Memory with File System Fallback can be selected. In either of the described situations if ‘File’ is chosen, an error will be reported in the export module log file and export will not proceed.

This setting can be adjusted if there are problems exporting very large items.

Export Provider Priority

Specifies the order in which EV export mechanisms will be tried.

Limit stored results

Stops the module trying to get more work, if there is a backlog of transmissions to be sent to the Core.

Threshold database limit

The number of items in the backlog before limiting takes place

Failures handling


Export Messages with invalid Message ID from Journal

When enabled it will mean that items from a journal that require envelope reconstruction will still be processed (and a P1 message generated) even if the Original Message ID attribute can not be found in the item that was retrieved from EV (meaning that an EV Index lookup can not be performed).

Note: This setting will have an impact in that it may mean BCC information is not added to the P1 envelope (since it can not be obtained from EV)

Prevent exporting of items if envelope reconstruction fails

This will prevent Archive Shuttle from providing an item from EV if the envelope reconstruction fails. With this setting disabled some items may be provided without an appropriate P1 (Envelope) message.

Fail items permanently on specified errors

Indicates whether Archive Shuttle should mark certain items as permanently failed, even on the first failure.

Error message(s) to permanently fail items on

A list of error messages which will cause items to be marked as permanently failed (if the previous setting is enabled)

Journal Transformation


Process messages without P1 header

Data for journal transformations are parsed from reconstructed P1 headers. BCC recipients are not available for the journal transformation user mappings.

 

EV import module

This section contains settings relating to the EV Import Module:

Item

Description

Offline Scan Parallelism

Indicates the number of threads that should be used when scanning offline media

EV Default Retention Category ID

When a non-Enterprise Vault source is used, and the target of the migration is an Enterprise Vault environment, indicate here the retention category ID to apply to the data which is ingested

EV Import Archive Parallelism

Defines how many archives will be imported in parallel.

Total thread count = EV Import Archive Parallelism multiplied by EV Import Item Parallelism.

EV Import Item Parallelism

Defines how many items should be imported in parallel per archive.

Total thread count = EV Import Parallelism multiplied by EV Import Item Parallelism.

Import Journal Archive Through Exchange

Imports a journal archive through Exchange instead of through the Enterprise Vault API. Elements from the staging area will be added to Exchange (for an appropriate Enterprise Vault task to process) rather than directly into Enterprise Vault.

Journal Mailbox Threshold

If using the ‘Import Journal Archive Through Exchange’ option then this setting can be used to limit when ingest will be stopped while the appropriate task processing the mailbox catches up.

Suspend imports while EV is archiving

Disables import module while Enterprise Vault is in its archiving schedule.

Ingest Provider Priority

Indicate the type of ingest provider to use.

Read file to memory

Allow reading of files to system memory before ingestion

Read file to memory threshold (bytes)

Items below this size will be read into memory (to speed up ingestion), whereas items above this size won’t be read into memory

Fail items permanently on specified errors

If enabled items which encounter one of the specified errors below will be marked as permanently failed, regardless of the failed item threshold.

Error message(s) to permanently fail items on

A list of errors

Limit stored results

Stops the module trying to get more work, if there is a backlog of transmissions to be sent to the Core.

Threshold database limit

The number of items in the backlog before limiting takes place

 

EV provisioning module

This section contains settings relating to the EV Provisioning Module:

Item

Description

Convert orphaned into shared archives

Enterprise Vault 11 onwards cannot handle Folder structures in shared archives. Only to use on advice of Quadrotech support.

Limit stored results

Stops the module trying to get more work, if there is a backlog of transmissions to be sent to the Core.

Threshold database limit

The number of items in the backlog before limiting takes place

EWS is the preferred method of shortcut processing and should be used wherever reasonable to support.

Shortcut process module

Item

Description

Shortcut Process Parallelism

Specifies how many mailboxes are post-processed at the same time.

Shortcut Process Item Parallelism

Specifies how many shortcuts per mailbox are processed in parallel.

Delete Shortcuts options

There are three options when deleting shortcuts:

·Shortcuts related to migrated items: shortcuts linked to migrated items will be deleted only. This setting is set by default.

·Shortcuts not related to migrated items: shortcuts with no association to migrated items will be deleted only.

info

NOTE: Eligible shortcuts are deleted regardless of the eligibility of the migration.

·All shortcuts: shortcuts are removed without an ownership check.

Delete messages with EV properties but without proper shortcut Message Class

Deletes messages which are not proper EV shortcuts, but have EV properties such as SavesetId or ArchiveId. (Setting ignored for migrations to PST).

Use EWS for Processing

Use EWS as access method for communication with Exchange/Office 365 system. For Office 365 and Exchange 2019 and above, this setting has to be enabled.

Shortcut deletion maximum batch count

Specifies maximum number of batches used for shortcut deletion in parallel.

Process shortcuts from primary and secondary mailbox

Collect and restore Shortcuts for both primary and secondary mailboxes. Hybrid scenarios are also supported.

Convert EV foreign shortcuts to regular items

Converts EV foreign shortcuts to regular messages on target mailbox. Conversion is done only when EV source archive for these shortcuts has not been found on the EV source server.

Limit stored results

Enables limit to store results in local database based on threshold value.

Threshold database limit

Defines maximum records stored in local data base when module stops asking for work items. This setting is applied only when setting 'limit stored results' is enabled.

Exchange import module

This section contains settings relating to the Exchange Import Module:

Item

Description

General


Use per server EWS Url for Exchange import

If this is enabled then the import module will use the EWS Url configured in Active Directory on the Exchange Server object rather than a general Url for all ingest requests

Import Root Folder

When ingesting data in to Exchange mailboxes or personal archives it is sometimes required to ingest the archived data into a top level subfolder (and then the archive folders beneath that). Specify the name of that top level folder here.

Ingest Provider Priority

Specifies the order of the ingestion providers that should be used e.g. AIP first, EWS Batch second etc.

Maximum Batch Size Bytes

The maximum size that a batch of items can be, which is then sent in one go to Exchange

Maximum Batch Size Items

Maximum number of items in a batch

Exchange Timeout Seconds

Timeout in seconds until Archive Shuttle aborts the ingest (i.e. upload/processing)

Disable reminders for appointments in the past

This will remove the MAPI properties relating to whether a reminder has been sent/fired or not as the item is ingested into the target. If this is not enabled reminders may appear for long overdue archived items.

Mark migrated items as read

If this is enabled all migrated will be marked-as-read by the import module

Disable migration on specified error(s)

If enabled items which encounter one of the specified errors below cause the mapping to be disabled.

Error message(s) to disable migration on

List of errors

Fail items permanently on specified errors

If enabled items which encounter one of the specified errors below will be marked as permanently failed, regardless of the failed item threshold.

Error message(s) to permanently fail items on

A list of errors

Limit stored results

Stops the module trying to get more work, if there is a backlog of transmissions to be sent to the Core.

Threshold database limit

The number of items in the backlog before limiting takes place

Threading/Parallelism


Offline Scan Parallelism

Number of threads that will be used for scanning offline media

Exchange Mailbox Parallelism

Defines how many Exchange mailbox imports will be ingested to in parallel.

Exchange Batch Parallelism

Defines how many batches will be ingested per mailbox in parallel

Exchange Item Parallelism

Defines how many items will be ingested per mailbox in parallel

Connectivity


Exchange Version

Specify the version of Exchange which is in use.

Disable Certificate check

Disable the certificate validity when connecting to Exchange

Exchange Connection URL

Specify an Autodiscover URL if the default one does not work

Use Service Credentials for Logon

Authenticate to Exchange with the credentials which the Exchange Import Module Server is running as.

 

Office 365 module

This section contains settings relating to the Office 365 Module:

Item

Description

General


Number of fastest servers to use

Determines how many servers from the list of fastest are used. They will be picked randomly by the module

Import Root Folder

When ingesting data in to Office 365 mailboxes or personal archives it is sometimes required to ingest the archived data into a top level subfolder (and then the archive folders beneath that). Specify the name of that top level folder here.

Ingest Provider Priority

Determines which ingestion methods will be used to ingest data into Office 365 and in which order

Office 365 Batch Size Bytes

The maximum size that a batch of items can be, which is then sent in one go to Office 365

Office 365 Batch Size Items

Maximum number of items in a batch

Office 365 Timeout Seconds

Timeout in seconds until Archive Shuttle aborts the ingest (i.e. upload/processing)

Check mailbox quota only for importing users

Mailbox quota only used for users that are actively being imported.

Mailbox Quota Exceeding Threshold (%)

Item ingest will be stopped once mailbox size has reached the defined threshold of the mailbox quota. The default value is set at 95%.

Disable reminders for appointments in the past

This will remove the MAPI properties relating to whether a reminder has been sent/fired or not as the item is ingested into the target. If this is not enabled reminders may appear for long overdue archived items.

Mark migrated items as read

If this is enabled all migrated will be marked-as-read by the import module

Convert journal messages to Office 365 journaling format

If this option is enabled information in the P1 envelope gets added to an attribute called GERP, and added to the message as it is ingested in to Office 365. This makes those items Office 365 journal-format messages. (See additional information here)

Allow synchronization of un-associated mailboxes

Mailboxes with no association to AD User present in AS database will be also synchronized and stored (matching is based on UPN/Email address)

Enable auto-recreate deleted Office 365 Users as Leavers

Deleted Office 365 Users which are marked as Enabled to Recreate will be recreated as Leavers once task ‘RecreateDeletedOffice 365Users’ will run

Allow synchronization of unassociated mailboxes

Allow synchronisation of mailboxes without an owner.

Collect retention tags

Collect retention tags from Office 365.

Disabled: No retention tags are collected.

Active tags and labels only: active labels and tags are collected.

All tags and labels: all tags and labels are collected.

Allow ingest of items without Office 365 retention mapping

If the collection of retention tags is active, but an explicit mapping of retention tags hasn’t been performed then some items may not ingest into the target. If this option is enabled, if a mapping doesn’t exist, the item will still be ingested.

Preferred domain for ambiguous user match

Specify a domain (with or without the @) to use when trying to match users with ambiguous names.

Disable migration on specified error(s)

If enabled items which encounter one of the specified errors below cause the mapping to be disabled.

Error message(s) to disable migration on

List of errors

Fail items permanently on specified errors

If enabled items which encounter one of the specified errors below will be marked as permanently failed, regardless of the failed item threshold.

Error message(s) to permanently fail items on

A list of errors.

Disable ingest account on specified error

If enabled items which encounter one of the specified errors below will result in the ingest account being disabled from further ingest requests.

Error message(s) to set ingest account as disabled

A list of errors.

Limit stored results

Stops the module trying to get more work, if there is a backlog of transmissions to be sent to the Core.

Threshold database limit

The number of items in the backlog before limiting takes place

Virtual Journal


Virtual Journal Item Count Limit

The maximum number of items in a virtual journal mapping before a new mapping will be created.

Virtual Journal Size Limit

The maximum size of a virtual journal mapping before a new mapping will be created.

Threading/Parallelism


Offline Scan Parallelism

Number of threads that will be used for scanning offline media

Office 365 Mailbox Parallelism

Defines how many items will be ingested per mailbox in parallel.

Office 365 Item Parallelism

Defines how many items will be ingested per mailbox in parallel.

Office 365 Batch Parallelism

Defines how many batches will be ingested per mailbox in parallel

Connectivity


Use fastest server (round-trip)

If enabled, from time to time the Office 365 module will get a list of servers responding to Office 365 ingest requests and use only those for ingestion.

Office 365 Exchange Version

Specify the Office 365 Exchange version

Disable certificate check

Disable the certificate validity check when connecting to Office 365

Use Multiple IP from DNS

When Office 365 returns multiple IP address entries for it’s ingestion service this setting will allow the ingest module to communicate to all of those IP addresses instead of just one. For this to work, the ‘Disable certificate check’ option must be enabled.

Exchange Connection URL

Specify an Autodiscover URL if the default one does not work.

OAuth concurrent batches

By default, Archive Shuttle use 5 batches in parallel. This value can be adjusted.

 

PST Export module

This section contains settings relating to the PST Export Module:

Item

Description

General


File Parallelism

The number of PST files to ingest from simultaneously

PST item collection file parallelism

The number of PST files to scan simultaneously

Limit stored results

When the module is working, should the number of items it is tracking and not sent the result to the Core be limited?

Threshold database limit

The number of items allowed to be stored locally, and not sent to the Core, before the module stops requesting more work.

Native Import module

This section contains settings relating to the Native Import Module:

Item

Description

Stamps a header to imported messages for ProofPoint to identify message source

When enabled a message-header is added to each item as it is added to a PST file. The header is called x-proofpoint-source-id and has the itemid/item routing id, as the value. For example:

x-proofpoint-source-id: 91016abe-51e3-bdd6-132f-fb6763ecc751/2865103

Native Import File Parallelism

Defines how many PST files will be imported to in parallel.

Native Import Item Parallelism

Defines how many items will be ingested in parallel per PST file.

Finalize finished PSTs in Stage 1

With this option enabled finished/full PST files will be moved to the output area whilst the mapping is still in Stage 1. This will only happen on PSTs which are complete, i.e. those that have split at the predefined threshold. For migrations lower than the threshold, which therefore have just a single PST, this PST will not be moved in Stage 1.

Verify closed PST file consistency

Every closed PST will be checked for its correct items count and if the file itself is not corrupted.

Mark PST as corrupted on specified errors

If checked, PST(s) which item(s) failed on specified error will be marked as corrupted and not processed anymore.

Error message(s) to mark PST as corrupted

Based on listed error messsage(s), PST(s) will be marked as corrupted immediately.

Fail items permanently on specified errors

If enabled items which encounter one of the specified errors below will be marked as permanently failed, regardless of the failed item threshold.

Error message(s) to permanently fail items on

A list of errors.

Limit stored results

Stops the module trying to get more work, if there is a backlog of transmissions to be sent to the Core.

Threshold database limit

The number of items in the backlog before limiting takes place

Re-create MAPI profile handling


Enable re-creation of MAPI profile

If enabled, MAPI profile can be recreated with manual action from Modules page, or automatically based on error messages listed in setting below.

Error messages to cause re-creation of MAPI profile

Based on listed error message(s), module will initiate re-creation of MAPI profile.

Time of module inactivity before re-creating MAPI profile

The time of inactivity of NFI module after which the MAPI profile will be re-created.

 

EAS Zantaz module

This section contains settings relating to the EAS Zantaz module:

Item

Description

EAS Archive Parallelism

The number of archives to process in parallel

EAS Item Parallelism

The number of items to process in parallel per archive

Limit stored results

Stops the module trying to get more work, if there is a backlog of transmissions to be sent to the Core.

Threshold database limit

The number of items in the backlog before limiting takes place

 

SourceOne module

This section contains settings relating to the SourceOne module:

Item

Description

SourceOne Container Parallelism

The number of archives to process in parallel

SourceOne Collect Items Container Parallelism

The number of items to process per archive in parallel

SourceOne Sync Archives Batch Size

Defines how many archives will be synced in one batch.

Ignore Missing Transport Headers

Ignores missing transport headings in case of export from Journal export.

Email address used in case ‘sender is null’ error

Specify an email address to be used if the module reports a ‘sender is null’ error

Export messages failing on 'SAFETY: Mismatched Attachment Counts from native message!' error.

Use this setting to export messages which fails on mismatched attachment count error.

Limit Stored Results

Select this option to limit stored results.

Threshold Database Limit

Limit of records in local database, when module stops asking for work items.

 

Dell Archive Manager module

This section contains settings relating to the Dell Archive Manager module:

Item

Description

Container Parallelism

Defines how many archives will be exported in parallel.

Collect Item Parallelism

Defines how many items should be collected in parallel per archive.

Limit Stored Results

Select this option to limit stored results.

Threshold Database Limit

Limit of records in local database, when module stops asking for work items.

Collect size of archives

If enabled the module will also collect the overall size of archives

 

PowerShell Script Execution module

This section contains settings relating to the PowerShell Script Execution module:

Item

Description

Limit stored results

If enabled helps protect the module from some failures where backlog of results can’t be sent to the Core.

Threshold database limit

The number of results that will stored locally before the module stops processing more work. (Combined with previous setting).

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen