Installing the Outlook Add-In

Refer to Deploying the Outlook Add-In to determine deployment method before installing. This topic covers each of the possible methods.

For instructions for upgrading the Add-in, refer to Upgrading the Outlook Add-In.

For instructions for installing the Add-In on Terminal Server, refer to Installing the Outlook Add-In on Terminal Server.

The Outlook Add-In installer is available from the Mail Express Server administration Outlook Add-In Installer page and in the Mail Express Server installation folder (by default, C:\Program Files\Globalscape\Mail Express).

• Before installing the Outlook Add-In, be sure to review the system requirements.

• You need administrator privileges to install prerequisites; however, the Add-In installer does not require administrative privileges to run.

• If .NET is not installed before you install the Add-In, you should reboot after completing the .NET installation. If you do not reboot after installing .NET, the Mail Express Add-In may not load properly in Outlook.

• You should install and configure Mail Express Server before you install the Outlook Add-In.

• If you will be using Kerberos authentication, you must create a domain account for the Mail Express Server for authenticating with the Kerberos Key Distribution Center (typically Active Directory) and to allow a Service Principal Name (SPN) to be associated with the account. Why do I need an SPN? According to Microsoft Technet, "A service principal name (SPN) is the name by which a Kerberos client uniquely identifies an instance of a service for a given Kerberos target computer. If you install multiple instances of a service on computers throughout a forest, each instance must have its own SPN. A given service instance can have multiple SPNs if there are multiple names that clients might use for authentication. For example, an SPN always includes the name of the host computer on which the service instance is running, so a service instance might register an SPN for each name or alias of its host." (Refer to "To create the SPN" below.)

• Installers are provided in the Mail Express Server installation directory and, for access convenience, on the Outlook Add-In Installer page of the Admin portal. These installers are for "proof of concept" non-silent installations and are not intended to be deployed across the enterprise. (Refer to Deploying the Outlook Add-In for more information.)

• The bootstrapper installers in the "Prerequisite Installer Bundles" require Internet connectivity to download the Add-In prerequisites, and must be run by an account that has administrative privileges on the computer on which the Add-In is being installed.

• The bootstrapper installers are not designed to be installed through a deployment tool. They do not support installation in quiet/silent mode.

• If Silent mode is preferred, each prerequisite item that the Add-In requires can be downloaded from Microsoft’s website and each can be deployed and installed silently. "Silent mode" is the preferred method for deploying the Add-In’s prerequisites.

• The same MSI and bootstrapper used to deploy the 32-bit Outlook Add-In are used to deploy the 64-bit Outlook Add-In. (64-bit Outlook Add-in support available in v3.2 and later.)

To install the Outlook Add-In

1. Log in to the Mail Express Administration portal.

2. Before installing, review the Outlook Add-In's system requirements and ensure Outlook is updated with the latest service packs.

3. In the navigation pane, under System Information, click Add-In Installer. The Outlook Add-In Installer page appears from which you can download the applicable Add-In installer files or generate and download an installation script. (Or, you can copy the installation files from the Mail Express Server installation directory (by default, C:\Program Files\Globalscape\Mail Express).)

4. Download the applicable installation file(s) from the Outlook Add-In Installer page (using the Download links in the top section of the page).



• Mail Express Outlook Add-In Installer Only—(If the prerequisites are not yet installed, use one of the "Prerequisite Installer" bundles below instead of this installer.) Installs the Mail Express Outlook Add-In on workstations running Microsoft Office 2003, 2007, 2010, 2013 when the prerequisite software has been pre-installed. This installer will simply install the Add-In; it will not install the prerequisite items that it requires. This installer supports silent installation mode and does not require administrative privileges to install.

• Prerequisite Installer Bundle - Outlook 2003—(If the prerequisites are already installed, you do not need this bundle. Instead, use the "Mail Express Outlook Add-In Installer Only" above.) Zipped bundle containing the Mail Express Outlook Add-In and prerequisite software for installation on workstations running Microsoft Outlook 2003. This bundle can be used to install the prerequisite items that the Add-In requires plus the Add-In. Typically, you will run the bootstrapper installer in this bundle, which will install the Add-In prerequisites, and then afterwards it will run the Add-In Installer to install the Add-In.

• Prerequisite Installer Bundle - Outlook 2007—(If the prerequisites are already installed, you do not need this bundle. Instead, use "Mail Express Outlook Add-In Installer Only" above.) Zipped bundle containing the Mail Express Outlook Add-In and prerequisite software for installation on workstations running Microsoft Outlook 2007. This bundle can be used to install the prerequisite items that the Add-In requires plus the Add-In. Typically, you will run the bootstrapper installer in this bundle, which will install the Add-In prerequisites, and then afterwards it will run the Add-In Installer to install the Add-In.

• Prerequisite Installer Bundle - Outlook 2010—(If the prerequisites are already installed, you do not need this bundle. Instead, use the "Mail Express Outlook Add-In Installer Only" above.) Zipped bundle containing the Mail Express Outlook Add-In and prerequisite software for installation on workstations running Microsoft Outlook 2010. This bundle can be used to install the prerequisite items that the Add-In requires plus the Add-In. Typically, you will run the bootstrapper installer in this bundle, which will install the Add-In prerequisites, and then afterwards it will run the Add-In Installer to install the Add-In.

• Prerequisite Installer Bundle - Outlook 2013—(If the prerequisites are already installed, you do not need this bundle. Instead, use the "Mail Express Outlook Add-In Installer Only" above.) Zipped bundle containing the Mail Express Outlook Add-In and prerequisite software for installation on workstations running Microsoft Outlook 2013. This bundle can be used to install the prerequisite items that the Add-In requires plus the Add-In. Typically, you will run the bootstrapper installer in this bundle, which will install the Add-In prerequisites, and then afterwards it will run the Add-In Installer to install the Add-In. Note that this bootstrapper does not currently install the Microsoft Outlook 2013 PIA because Microsoft has not yet published its redistributable installer. By default the PIA will be installed when Microsoft Outlook is installed if .NET was installed beforehand. If needed the PIA can be installed via the Microsoft Office installer. Refer to the following KB article for more information: http://kb.globalscape.com/KnowledgebaseArticle11129.aspx.

5. In the Outlook Add-In Installation Script area:



1. For the Installation type options, specify whether the script is for a New/Upgrade or to Modify/Repair existing installation:

• Use the New/Upgrade option when installing the Add-In for the first time or when installing a new version of the Add-In for the first time (i.e. an upgrade).

• Use the Modify/Repair existing option when reinstalling the same version of the Add-In that is already on the computer either to repair it or to provide different values for the installation parameters.

If you choose the wrong option, the Add-In may not install at all.

2. In the Internal Mail Express server host box, specify the Mail Express Server hostname as recognized by internal workstations. (This may be different from the setting on the General Configuration page, which may be the host name of the fronting web server.)

3. In the Internal Mail Express server port box, specify the port through which the Mail Express Server connects, if different than the default. (It will default to 443.)

• For the Internal Mail Express server host and the Internal Mail Express server port, you should add a listening IP on the General Configuration page in the IP Port Bindings area, and set it for port 443.

4. For the Login type options, specify Manual or Single sign-on.

• If you click Single sign-on, in the Service Principal Name (SPN) box, specify the service context. (e.g., <service type >/< mail express instance server host name >:< port number >/< service name >). For example, HTTP/meserver. The SPN is a name by which the Add-In can uniquely identify the Mail Express Server Service.

• To create the SPNs, execute the following commands on the domain’s primary Active Directory server using the command console. In the commands below, substitute:

• <MailExpressServerHostName> with the host name of the Mail Express Server

• <MailExpressServerFullyQualifiedDomainName> with the fully qualified domain name of the Mail Express Server

• <PreAuthUsername> with the username of the pre auth user account. You will need to create a domain account for the Mail Express Server for participating in Kerberos authentication. This account is used by the Mail Express Server when authenticating with the Kerberos Key Distribution Center (typically Active Directory) and allows a Service Principal Name (SPN) to be associated with the account using the setspn command.

setspn –A HTTP/<MailExpressServerHostName> <PreAuthUsername>

setspn –A HTTP/<MailExpressServerFullyQualifiedDomainName> <PreAuthUsername>

For example:

setspn –A HTTP/meserver mepreauthuser

setspn –A HTTP/meserver.globalscape.com mepreauthuser

These SPNs should work regardless of the account the Mail Express Server Service is running as.

To view the SPNs to verify that they were created successfully, run the following command, substituting <PreAuthUsername> with the username of the pre auth user account:

setspn –l <PreAuthUsername>

(Note: The switch is a lower-cased letter L, not the number one.)

For example:

setspn -l mepreauthuser

If the Outlook Add-In is installed silently, the SPN must be provided as an installation parameter. The installation parameter name is “SERVICEPRINCIPALNAME.”

1. Click Generate to create the installation script. The necessary script appears in the Installation script box.

2. Click Download to save the script.

6. Save the script and the installation files in the same directory, or ensure that the script can access the installer. The command line parameters in the script are imperative for the proper operation of the Outlook Add-In. Use one of the following methods to install the Add-In on users' desktops:

• Execute the script at each user's desktop to silently install the Add-In.

• Install the Add-In manually on a user’s desktop by double-clicking on the Add-In MSI installer. Or, send an email instructing users to install the Add-In themselves and provide a walkthrough or screenshots to guide them through the installation wizard screens.

• Deploy the Add-In across the enterprise using a deployment tool. For example, use a logon script to install the Add-In silently on workstations since the Add-In MSI does not require administrative privileges to install.

File/Configuration Locations

• The log files for the Add-In are (by default) stored in %userprofile%\Application Data\Globalscape\Mail Express Outlook Addin\Logs\.

• The default installation directory of the Add-In is %userprofile%\Application Data\Globalscape\Mail Express Outlook Addin.

• Connection-based settings and settings configured by the installer are stored in the registry under the following key: HKEY_CURRENT_USER\Software\Globalscape\Mail Express Outlook Addin\Settings.

• General settings are saved in an XML file named settings.config, which will reside under the installation folder of the Add-In.

Running the MSI Installer

To run the Outlook Add-In installer (msi) manually

1. Double-click the .msi file. The Welcome page appears.

   

2. Click Next. The Connection Settings page appears.

   • If prerequisites required to install the Add-In are not found on the system, an error message appears. Click OK to abort the installation, and install the prerequisites using the appropriate bootstrapper installer or download them from Microsoft’s website and installing them separately. Afterwards, restart the Add-In installation.

   

3. In the Mail Express Server Host box, provide the Host name or IP address of the Mail Express Server.

4. In the Port box, provide the port number used by Mail Express Server. (443 is the default.)

5. In the Login Type box, click the down arrow to specify Windows authentication (the default) or Manual authentication.

   • If you chose Windows Authentication, in the Mail Express Server Service Principal Name box, provide the SPN of the Mail Express Server service. (Refer to "To create the SPN" above.)

   • If you chose Manual Authentication, provide a valid username and password for an Internal Mail Express user.

6. Click Next. The Destination Folder page appears.

   

7. The folder defaults to %userprofile%\Application Data\Globalscape\Mail Express Outlook Addin\. To install to a different folder click Change and specify the location.

8. Click Next. The File Store Configuration appears.

   

9. The File Store location defaults to %userprofile%\Local Settings\Application Data\Globalscape\Mail Express Outlook Addin\. The Add-In will temporarily store attachments for emails that it is processing in this folder. To specify a different location, click Change and specify the location.

10. Click Next. The Ready to Install page appears.

    

11. Click Install to begin the installation. The Setup Wizard installs the application and the Completed page appears.

    

12. The Launch Outlook check box is selected by default. Clear it if you do not want to open Outlook. If Outlook is already open, you need to close it and then reopen it for the changes to take effect. If the computer has not yet been rebooted since the .NET Framework was installed, it is highly recommended that the computer is rebooted before trying to use the Add-In.

13. If you want to view the version history, select the Show version history check box.

14. Click Finish to close the wizard.

15. If Outlook appears, a message appears asking if you want to install the Add-In. Click Install.

16. You must first enable the Add-In in Outlook to use it; refer to The Mail Express User Interface for details.