Chat now with support
Chat with Support

Metalogix Archive Manager for Exchange 8.3 - Outlook Addin Installation Guide

Introduction

This document describes the Archive Manager Outlook Add-in (for Outlook 2013/2016/2019) setup installation modes. You can use Archive Manager Outlook Add-in Installers in express (normal – .exe setup) and advanced (custom, silent – .msi setups) mode. This document contains also information about required prerequisites and GPO installation steps.

There are several available setups:

·Metalogix Archive Manager Outlook Add-in Installer x86_[MajorVersion]_[MinorVersion]_[BuildVersion] -  for Outlook 2013, 2016 and 2019 32bit

·Metalogix Archive Manager Outlook Add-in Installer x64_[MajorVersion]_[MinorVersion] _[BuildVersion] - for Outlook 2013, 2016 and 2019 64bit

caution

CAUTION: MS Outlook Add-in should not be installed on a machine where Archive Manager for Exchange is installed.

Prerequisites

info

NOTE:

Express mode (launch Add-in Installer.exe) checks and installs the required prerequisites automatically at the beginning of the installation process.

Advanced mode (launch Add-in Installer.msi) installs only Outlook Add-in setup files, without any prerequisites checking. The prerequisites must be installed manually before the Outlook Add-in installation process.

The following prerequisites are required for Outlook Add-in setup:

·Windows Installer 3.1

The Microsoft® Windows® Installer is an application installation and configuration service. WindowsInstaller-KB893803-x86.exe is the redistributable package for installing or upgrading Windows Installer.

URL: http://www.microsoft.com/DownLoads/details.aspx?familyid=889482FC-5F56-4A38-B838-DE776FD4138C&displaylang=en

·.Net Framework 3.5 SP1

The Microsoft .NET Framework version 3.5 SP1 redistributable packages install the .NET Framework runtime and associated files required to run applications developed to target the .NET Framework v3.5.

URL: http://go.microsoft.com/fwlink/?linkid=118076

·.Net Framework 4.0 FULL

The Microsoft .NET Framework version 4.0 redistributable packages install the .NET Framework runtime and associated files required to run applications developed to target the .NET Framework v4.0.

URL: http://www.microsoft.com/en-us/download/details.aspx?id=17718

·VSTO runtime 2010 (x86 and x64)

The Microsoft Visual Studio 2010 Tools for Office (VSTO 2010 x64 and x86) redistributable package installs the Visual Studio Tools for Office runtime, which is required to run solutions built using VSTO 2010.

URL for VSTORRedistX86: http://go.microsoft.com/fwlink/?LinkId=158917

URL for VSTORRedistX64: http://go.microsoft.com/fwlink/?LinkId=158918

 

Archive Manager Outlook Addin Install Modes

Express mode

Express install mode is designed for single installations, per-machine installations. Express install mode is a self-extracting package, which extract files to the logged user’s temp folder. In this mode you can select and change the installation folder, specify the archive and the retrieve server name, but the specific Add-in properties (default registry values) are set to default.

Add-in Installer.exe automatically manages the following processes:

·Detects and installs the required prerequisites for the Add-in setup.

(Prerequisites Windows Installer 3.1, .Net Framework 3.5 and VSTO runtime 2010 are downloaded from the components vendor web site.)

·Installs Add-in setup.

info

NOTE: Express mode Add-in Installer.exe is required only at first install. For update, the Add-in Installer.msi is sufficient.

Advanced mode

Advanced mode is used for manual installations and installs only Add-in setup (Add-in Installer.msi) without any prerequisites checking. The prerequisites must be checked and installed manually before the Add-in setup is launched.

Advanced mode is designed for multi installations (e.g. installing by GPO), during updates and repair and at installing from command line. In advanced mode you can change almost every Add-in property (default registry values) and installation options using command line options. Command line options consist of:   Windows installer command line options and Add-in properties. Combining these two types of commands you can create your specific custom commands for Add-in installations.

Correct syntax:

msiexec /[option] [path Add-in Installer.msi file] PROPERTY=VALUE PROPERTY2=VALUE PROPERTY3=VALUE....

 

Property values that are literal strings must be enclosed in quotation marks. White spaces can be included in the string between the marks.

msiexec /[option] [path Add-in Installer.msi file] PROPERTY="Embedded White Space"

 

Incorrect syntax:

msiexec /[option] PROPERTY=VALUE [path Add-in Installer.msi file]

 

Windows Installer Command-line options

The command-line options in the following table are available with Windows Installer 3.0., with these commands it is possible to change the installation types (e.g. update, repair, silent, uninstall, logging).

Windows installer commands:

http://msdn.microsoft.com/en-us/library/aa367988(VS.85).aspx

ReinstallMode commands:

http://msdn.microsoft.com/en-us/library/aa371182(VS.85).aspx

AllUsers properties:

http://msdn.microsoft.com/en-us/library/aa367559(VS.85).aspx

Examples:

First install: msiexec /i  [path Add-in Installer.msi file]

Update: msiexec /i  [path Add-in Installer.msi file]

Repair: msiexec /i [path Add-in Installer.msi file] REINSTALL=ALL REINSTALLMODE=vomus or just select repair  option in the maintenance dialog.

Uninstall: msiexec /x [path Add-in Installer.msi file]

Logging: msiexec /i  [path Add-in Installer.msi file] /l* [path Add-in InstallerLog.txt file]

Silent mode: msiexec /i [path Add-in Installer.msi file] /qn

Archive Manager Outlook Add-in Command-line options

When installing the Add-in from the command line it is possible to change the default registry key values and set your desired ones.  When installing the Add-in (Add-in Installer.msi) without the Add-in command line options, registry keys are created with default values, except in silent mode installation (see examples below), where the retrieve and archive server name must be specified in the command line.

The Add-in Installer.msi setup creates default keys on the following path, depending on Windows version:

HKEY_LOCAL_MACHINE\SOFTWARE\Metalogix\PAM4Exchange Outlook Add-in

or

HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Metalogix\PAM4Exchange Outlook Add-in

 

Archive Manager Outlook Add-in registry keys, default values and commands:

Name

Type

Default Values

Cmd prompts

Description

XServerName, RetrieveServer, ArchiveServer

REG_SZ


EXPAMSERVER

Archive Server name (NETBIOS name)

RETRIEVESERVER

REG_SZ


RETRIEVESERVER

Retrieve Server name (NETBIOS name)

ARCHIVESERVER

REG_SZ


ARCHIVESERVER

Archive Server name (NETBIOS name)

AUTOPUBLISHPERSONALFORMS

REG_DWORD

0

APUBLISHPFORMS

Force publishing of forms on startup

CACHELIMIT

REG_DWORD

2048

CACHELIMIT

Offline folder limit in KB

DisableAdd-in

REG_DWORD

0

DISABLEAdd-in

The user manages this disable state (using the Info menu).

EnableServerDetection

REG_DWORD

0

ENABLESERVERDETECTION

Enable server connection detection

EXPLICITOFFLINESETTINGS

REG_DWORD

1

EXPLOFFSET

Switch between the Outlook and custom offline folder settings

OFTAutoSynchronize

REG_DWORD

0

OFTASYNCH

Start synchronization at Outlook start

OFTAutoSynchronizeEnd

REG_DWORD

0

OFTASYNCHEND

Start synchronization at Outlook shutdown

PROTOCOL

REG_SZ

http

PROTOCOL


PUBLISHVISIBLE

REG_DWORD

0

PUBLISHVISIBLE

Enable the Publish button on the Add-in options form

REFRESHOFFLINEFOLDERSATSTARTUP


0

ROFFLFSTARTUP


TOOLBARENABLED

REG_DWORD

1

TOOLBARENABLED

Disable toolbar on admin level

TotalDisableAdd-in

REG_DWORD

0

TOTALDISABLEAdd-in

Disable Add-in on admin level

UseProxy

REG_DWORD

0

USEPROXY


ExPamInstallPath

REG_SZ

c:\Program Files\Metalogix\Archive Manager Outlook Add-in\

TARGETDIR

Installation path of the Add-in

DebugLevel

REG_DWORD

0

DEBUGLEVEL

Writes more information into debug.

Examples:

Changing default registry values:

Msiexec /i [path Add-in Installer.msi file] TOTALDISABLEAdd-in="1" TOOLBARENABLED="1" APUBLISHPFORMS="0" PUBLISHVISIBLE="0" USEPROXY="1"

 

Silent mode – with the same server name for archive and retrieve server:

Msiexec /i [path Add-in Installer.msi file] EXPAMSERVER="<Archive_Server_Name>" /qn

 

Silent mode – with different archive and retrieve server:

Msiexec /i [path Add-in Installer.msi file] ARCHIVESERVER="<Archive_Server>" RETRIEVESERVER="<Retrieve_Server>" /qn

 

Silent mode – with different installation path:

Msiexec /i [path Add-in Installer.msi file] EXPAMSERVER="<Archive_Server_Name>" TARGETDIR=“C:\\Testfolder\“ /qn

Installing the Add-in for All Users

The Archive Manager Outlook Add-in is available to install for all users on the client machine. This means that Add-in needs to be installed on client computer with a user who has elevated privileges (such as local administrators) and the Add-in will be loaded during outlook start for every logged user.

Outlook 2013-2019 x64 and x86

Outlook 2013-2019 supports reading Archive Manager Outlook Add-in from HKEY_LOCAL_MACHINE. Archive Manager Outlook Add-in is deployed to all users on a machine by registering it under HKLM\Software\WOW6432Node\Microsoft\Office\Outlook\Add-ins, which means that Archive Manager Outlook Add-in will be loaded during startup of every Office application.

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