Outlook Add-In Installation Guide Version 2015
Contents Types of Installer... 3 Outlook Add-in Architecture... 3 Key Facts... 3 Upgrading Previous Versions of the Outlook Add-in... 3 Manual installation using the MSI... 4 Chained packages... 4 Required Packages... 4 Add-in Installation... 5 Use Client Code Setup Step... 5 Union Square URL Setup Step... 6 Use SSL... 6 Union Square URL... 6 Group Policy Deployment... 7 Using a BAT file to automate installation... 7 Using Client Code... 7 Using SSL URL... 7 Using Non SSL URL... 7 As part of a logon script... 7 2016 Union Square Software Ltd Page 2 of 9
Types of Installer 32bit and 64bit versions of the Add-in are available. The one you should use is governed by the bit variant of your Microsoft Office installation and not the bit variant of your OS. It is not possible to install the wrong one as the bit variant of Outlook is checked when the installer starts. It is also not possible to install the Add-in if you do not have a supported version of Outlook installed. Outlook Add-in Architecture The Outlook Add-in comprises of 2 distinct parts; 1. The MSI, which is installed to the client PC The MSI sets the environment by ensuring that the software pre-requisites are met and adds the bare bones of our Outlook Add-in so that it is able to contact your Union Square server and retrieve the Module 2. The Module, which is downloaded from your Union Square server and installed to the client PC The Module contains everything needed to publish Emails into the Union Square server. Every time the Outlook Add-in starts, it checks Union Square for an updated module, if there is one it will download and implement it in the background without any user intervention, all new publishing features are deployed via the Module and not the MSI. You do not need to upgrade the MSI in order to for the most up-to-date and feature rich Module to be downloaded from your Union Square server. We release updates to the MSI in cases where we find a need to adjust the rules on applying the prerequisites or setting the environment. So, if the Outlook Add-in is working then you do not need to upgrade the MSI. If the Outlook Add-in is not working, or stops working then installing the latest version of the MSI is a sensible first step. Key Facts Any version of the MSI can retrieve any version of the Module, which is why you don't need to upgrade the MSI if the Outlook Add-in is already working You can only use Client Codes with MSI Version 2.0.5 or greater Version 2.0.0 or greater should not be installed when the Union Square server is less than 01-2014 (3573) Any version of the MSI can be installed if the Union Square server is greater than 01-2014 (3573) Upgrading Previous Versions of the Outlook Add-in The feature components of the Outlook Add-in are downloaded from the Union Square server. You do not need to upgrade the installed MSI in order to access new features 2016 Union Square Software Ltd Page 3 of 9
Manual installation using the MSI Double click to start installation. The installer requires that you are an administrator so UAC should prompt for elevation if you are not. Chained packages The following packages are included in the MSI and will be installed automatically if they are needed 1..NET Framework 4.0 2. VSTO 2010 Runtime 3. Hotfix for Office 2007 (KB976477) Required Packages If you are running Outlook 2007 then at minimum Office 2007 SP1 is required. If not present the Add-in will refuse to install until it has been added to your system. 2016 Union Square Software Ltd Page 4 of 9
Add-in Installation Only pages or screens that need explanation are detailed below Use Client Code Setup Step If you check this box then you are telling Outlook to contact Union Squares servers and retrieve the URL for your Union Square system from them. When you start Outlook you will be prompted to enter your client code (provided by your IT department) This is the recommended way of installing this Add-in 2016 Union Square Software Ltd Page 5 of 9
Union Square URL Setup Step The controls on this page will be disabled if you have elected to use the Client Code Use SSL Typically all union square installations since 2012 have SSL configured as we use it for our authentication so it s best to set this as it means that the Add-in will also work when people are out of the office. If your Union Square system cannot be accessed using the https prefix, then do not tick this option. Union Square URL Type your Union Square URL into the box and click the update button to enable the [Next >] button. If you have included the http:// or the trailing / then it will not validate and you will not be able to continue. What you set in this page will be persisted for future upgrades so you will not always have to retype it.!! Caution!! Do not enter unionsquare.yourdomain.com You need to enter your valid url for your site. e.g. unionsquare.companyabc.com FAILURE TO SET THIS PROPERLY WILL RESULT IN THE ADD-IN NOT WORKING CORRECTLY AND ABILITY TO PUBLISH EMAILS. 2016 Union Square Software Ltd Page 6 of 9
Group Policy Deployment Group Policy installations do not allow you to pass in parameters, in observation of this we have made the default no parameter command line install default to using client code. Deploy the Add-in as a per-machine installation, circulate your Client Code to your users and have them type it in when Outlook starts and prompts for it. Note: When using client code your users must be able to access https://us.unionsquaresoftware.com in order to retrieve the URL. Using a BAT file to automate installation It is possible to create a BAT file that passes in the correct parameters to the installation wizard. In the examples below red text needs to be updated as appropriate to your path, version and settings. The use of the /quiet flag means that no UI will be shown unless one or more pre-requisites is missing, these cannot be installed silently and will cause a window to be displayed to screen. Using Client Code "\\files\software\u2 Outlook Add-in\UniOutlookAddin_x32_2_0_x.msi" /quiet Using SSL URL "\\files\software\u2 Outlook Add-in\UniOutlookAddin_x32_2_0_x.msi" SSL_CHECKBOX=s UNIONSQUAREURL= unionsquare.yourdomain.com /quiet Using Non SSL URL "\\files\software\u2 Outlook Add-in\UniOutlookAddin_x32_2_0_x.msi" UNIONSQUAREURL= unionsquare.yourdomain.com /quiet As part of a logon script You could use any of the above command lines as part of a logon script as long as all of your users are Administrators of their own computers. 2016 Union Square Software Ltd Page 7 of 9
Copyright 2000-2016 Union Square Software Limited Microsoft and Windows are registered trademarks of Microsoft Corporation. Unauthorised copy, distribution or disclosure of this manual is strictly prohibited. This document contains confidential information belonging to Union Square Software Limited. Disclaimer The information in this document is subject to change without notice. Union Square Software Limited shall not be liable for technical or editorial errors or omissions contained herein; nor for incidental or consequential damages resulting from the performance or use of this material. Document Control Significant Dates Last Update Release Date Review Date 24-Oct-16 10-Oct-14 10-Apr-15 Control Actions Release Authorisation Blue Team Review Tony Burnett Authorised By Matt Mayhew Red Team Review Matt Mayhew Approved By Tony Burnett Associated Documents None Number of Pages 11 Portfolio Owner / Author Matt Mayhew (Union Square Software) 2016 Union Square Software Ltd Page 8 of 9