Naming policies
File Name Policy
The File Name Policies page in the Admin Interface allows an administrator to customize file name policies to be used in migrations where the target is PST. Tokens are used to construct the file name of the PST file when it is renamed/moved to the PST Output Path. The possible tokens can be seen below.
When creating or editing a policy a live example of a file name will be shown to help with the policy design.
|
Token |
Description |
|---|---|
|
*First Name* |
First name of the owning user |
|
*Last Name* |
Last name of the owning user |
|
*Full Name* |
Full name of the owning user |
|
*User Principal Name* |
User principal name of the owning user |
|
*Email* |
The primary SMTP address associated with the owner |
|
*User Name* |
The SAMAccountName associated with the owner |
|
*Archive Name* |
The name of the Enterprise Vault archive |
|
*Archive id* |
The ID of the Enterprise Vault archive |
|
*PST id* |
The sequential number of the PST file in Archive Shuttle |
|
*PST Number* |
The sequential number of the PST file in the associated migration mapping |
Folder Name Policy
The Folder Name Policies page in the Admin Interface allows an administrator to customize folder name policies to be used in a journal archive migration. Tokens are used to construct the folder name of the place in the mailbox where items are migrated to. The possible tokens are:
|
Token |
Description |
|---|---|
|
*Original SMTP address* |
The SMTP address of the original recipient |
|
*Mapped SMTP address* |
The SMTP address of the mailbox where data is being migrated to |
There is also a checkbox to indicate whether the purges folder should still be used as a root, and then the constructed folder name is used as a subfolder from that.
When creating or editing a policy a live example of a name will be shown to help with the policy design.
Archive Name Policy
The Archive Name Policies page in the Admin Interface allows an administrator to customize archive name policies to be used when the RenameSourceArchive command runs in the Stage 2 part of a migration. Tokens are used to construct the name of the archive. The possible tokens are:
|
Token |
Description |
|---|---|
|
*firstname* |
First name of the owning user |
|
*lastname* |
Last name of the owning user |
|
*fullname* |
Full name of the owning user |
|
*upn* |
User principal name of the owning user |
|
*SMTP address* |
The primary SMTP address associated with the owner |
|
*SAM Account Name* |
The SAM Account Name associated with the owner |
|
*Container Mapping ID* |
The Archive Shuttle container mapping ID |
|
*Archive Name* |
The name of the Enterprise Vault archive. |
When creating or editing a policy a live example of will be shown to help with the policy design.
The policy can be used when editing the RenameSourceArchive command as part of a Workflow Policy.
Considerations when migrating to the recoverable items folder
The default location for active mailboxes is the following folder location Recoverable Items\Purges\ this is a hidden folder from the end user.
|
|
NOTEs: ·Items in the Recoverable Items folder arent calculated toward the users mailbox quota. In Exchange Online, the Recoverable Items folder has its own quota ·Recoverable Items\Purges folder has its own quota soft limit 20GB, hard limit 30GB. If litigation hold is enabled the quota is automatically increased from 30GB to 100GB for the primary mailbox and unlimited for the EOA (auto expanding feature is required) ·Currently you can only ingest into the Primary Mailbox |
The default location for leaver mailboxes is the folder Journal Items.
Changing the target folder
If you are planning to ingest into another folder, that is different from the default system policy Recoverable Items\Purges & Journal Items folder. A Folder Name Policy will be required.
Navigate to Configuration, then Naming Policies then Folder Name Policy.
Workflow policies
The Workflow Policies page in the Admin Interface allows an administrator to customize Workflows and create new ones. These can either be new, original workflows or copies of existing workflows with some amendments. You can create either a Stage 2 policy, or a Pre-migration policy.
Creating a new policy
A new policy can be created by clicking on New the Actions Bar, choosing either a Stage 2 or Pre-migration policy, and entering a name for the policy.
New policies can contain any of the commands list on the right hand side of the Workflow Policies screen.
When creating a new policy it is required to indicate the types of mapping that can use this particular workflow by selecting the check boxes at the top right of the Workflow Policies screen.
For information on the detail relating to each command, see below.
|
|
NOTE: Remember to save before leaving the screen in order to commit the changes to the Workflow Policy to the Archive Shuttle database. |
Copying a policy
When a policy is being viewed it is sometimes desirable to copy the policy and then make some small alterations to it. This is achieved by using the Copy button in the Actions Bar. Once a copy of the policy has been made, it can be given a new name, and saved to the Archive Shuttle database.
Editing a policy
A policy can be edited by clicking on Edit in the Actions Bar, and selecting an existing policy from the list. If appropriate, the types of mapping that the policy can be used with can be adjusted. All changes are only committed to the Archive Shuttle database when the Save button is clicked.
Adding a new command
A new command can be added to the bottom of the list of current commands in the Workflow by single clicking on it in the list on the right hand side of the page.
Moving a command
A command can be moved from its current position in the list by clicking on the grey title area and dragging it to a new position in the list:
Editing the Details of a Command
The details behind a command such as the number and frequency of retries can be edited by clicking on the hyper link relating to the command, as shown below:
Recommendations
·Built-in workflows should be left as-is, and copies can be made if required.
·Existing policies should be reviewed before creating new ones.
·New policies should contain the command-pair CollectItemsForArchive and WaitForImportFinished, as these perform the last-sync of the container.
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
| ||
|
Office365EnsureLicenseAssigned |
Checks for licenses for a mailbox. The command will fail if there is no existing license.
| ||
|
Office365RemoveLicense |
Remove Office 365 license from the mailbox. | ||
|
Office365ProvisionMailbox |
Provision new Office 365 mailbox.
| ||
|
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
| ||
|
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 output path | ||
|
StorageImportUNCSpaceCheck |
Command for UNC space check | ||
|
StorageImportAzureSpaceCheck |
Command for Azure blob space check | ||
|
StorageImportAmazonSpaceCheck |
Command for Amazon bucket space check |