Search <book_title>...

Enterprise Vault™ Setting up Exchange Server Archiving

Last Published: 2018-03-29

Product(s): Enterprise Vault (12.3)

Deploying the Enterprise Vault Office Mail App for multiple users

The following example PowerShell script shows how to deploy the Enterprise Vault Office Mail App for multiple users. All the users must be within a single organizational unit.

A script of this type may take some time to complete for a large number of users. The speed at which the script enables users will vary from system to system, depending on the particular environment in which it is run.

Note:

You must log in to the Exchange server using an account that is assigned the management role User Options. By default, members of the "Organization Management" role group are assigned this role.

The backtick character (') is the PowerShell line-continuation character.

Add-Type -AssemblyName System.Web
function EVDeploy([string]$evserver, [string]$ou) {
Get-Mailbox -OrganizationalUnit $ou |
  ForEach-Object {
    If (New-App -mailbox $_.LegacyExchangeDN -ErrorAction:Ignore -Url '
        ("http://" + $evserver + 
"/EnterpriseVault/OfficeMailAppManifest.aspx?LegacyMbxDn=" + 
[System.Web.HttpUtility]::UrlEncode($_.LegacyExchangeDN))) {
      Write-host ("Deployed to: " + $_.DisplayName);
    } Else {
      If (Get-App -mailbox $_.LegacyExchangeDN '
                  -Identity 0cc6d075-e610-4b8a-90c6-1460e6d4d710 '
                  -ErrorAction:Ignore) {
        Write-host ("Already deployed to: " + $_.DisplayName);
      } Else {
        Write-host ("Could not deploy to: " + $_.DisplayName);
      };
    };
  };
};

EVDeploy "EV_server" "org_unit"

Where:

EV_server is the name of any Enterprise Vault server in your site. This Enterprise Vault server is not necessarily the one that is used to load the Office Mail App. The Enterprise Vault server that is used to load the Office Mail App is the server where the archive for the specified mailbox is located. The name of the correct Enterprise Vault server for the specified mailbox is returned within the manifest file.
org_unit is the organizational unit that contains the users for whom you want to deploy the Office Mail App.

Note:

EV_server and org_unit in the final line of this script are the only variables that you need to replace.

The GUID identifies the Enterprise Vault Office Mail App, and does not change.