Outlook Add-in

  • Configuring the Outlook Add-in v2

    Once the installation of the Outlook Add-in has been completed on the client machine, the connection to the Inova application should then be configured. The following items are needed to complete the configuration:

    • The Outlook client must be up and running on the client machine.
    • The Inova application also running and accessible from the client machine.
    • The URL to the Inova application.
      Be sure the URL used does not have any additional context path information. For example, if the client browser’s bookmark has https://mycompany.partneringplace.com/inova-partner/ctx/auth/home.do, the URL to use would be https://mycompany.partneringplace.com/inova-partner.
    • The user name and password of the Inova application user.
      Note that the Inova user must have the appropriate rights within the application to use the Add-In. For more information, please contact your Inova Customer Success Manager or Inova Support.

    After gathering the required information, open Outlook on the client machine and complete the following steps:

    Settings.png

    1. Click on the "Inova" tab.
    2. Click on the "Settings" button.
    3. Choose the right connection setting:

    Connection_settings.png

    Connection settings

    To find out which connection setting to choose , just check your Inova application login page.
    If your login page looks like the one below, then you have to choose the "Standard" mode. Otherwise, choose the "Enterprise" mode.

    Inova_Login_Page.png

    Standard Mode

     Standard_Mode.png

    • Tick the "Standard authentification" box.
    • Enter the URL of your application, your login and your password.
    • Click on "Login".

    Enterprise Mode

    Enterprise_Mode.png

    • Tick the "Enterprise" box.
    • Enter the URL of your application.
    • Click on "Login".
    Note that the progress icon will change to a check mark within the circle once a successful connection to the Inova application is made:

    Check_mark.png

    Objects settings

    Select the boxes next to the objects this user will have access to via the Add-In :

    Objects_settings.png

    1. New contacts management : if you tick the box, the add-in will detect that one or more of the contacts linked to the email does not exist in the application and it will offer the option to create those contacts in the Inova application.
    2. Push emails on :
      • Manual email sending : the selected objects will have shortcuts visible in the user’s ribbon.
      • Objects linkable to a folder : the selected objects will be visible in a right-click menu allowing a folder sync to a given object.
    3. Click the "Save" button.
    4. Once configured, the "Inova" ribbon in Outlook will look similar to the following screenshot, depending on the objects the user has access to :

    Ribbon.png

    Please, read our articles to know how to use the Add-in :
    View Full Article
  • Outlook Add-in : Standard Installation
    A reboot of the client machine may be necessary to complete these installation tasks. The installer will download, if not already installed on the client, the Microsoft .NET Framework 4.6.2 (or higher), and the Microsoft Visual Studio 2010 Tools for Office Runtime.
    The user needs to be administrator of the computer to be able to perform the following steps. If it isn't the case the IT should grant administrator rights to the users for the time of the instalation. 
    Click here to download the latest version of the Outlook Add-in.

    Complete the following steps to install the Inova Outlook Add-In on a client machine :

    1. If running, stop Outlook. If needed, verify using the Task Manager that Outlook as stopped completely.
    2. If not already done, download and/or copy the installation executable to a temporary folder on the client machine (for example : C:\temp).
    3. Using Windows Explorer, navigate to the temporary folder containing the installation executable and double-click the file setup.exe.
    4. If Microsoft .NET Framework 4.6.2 or higher is not installed, a dialog box will be displayed. Read and Accept the License Terms.
    5. If the Microsoft Visual Studio 2010 Tools for Office Runtime is not already installed, the following dialog box will be displayed :

    1. Read and Accept the License Terms.
    2. If a reboot is required, a dialog box will be displayed. Shutdown any open applications and then click "Yes" to reboot the client machine.
    3. After the client machine has restarted, the installation will restart.
    If the installation does not automatically restart after the client machine has rebooted, restart the installation manually by double-clicking the installation executable found in the temporary folder.
    1. Click the "Install" button.
    2. Once the installation is complete, a dialog box will be displayed. Click the "Close" button to finish.
    3. To verify the installation has completed, start Outlook. There should now be an "Inova" tab above the ribbon. For example, the tabs should look something like this :

    After the installation is complete, see this article to finalize the configuration.
    View Full Article
  • Outlook Add-in : Centralized Installation (Experts Only)

    At a glance:

    1. Make sure that all pre requisite softwares below are already installed on the users computer
      • Microsoft .NET Framework 4.6.2 (or higher),
      • Microsoft Visual Studio 2010 Tools for Office Runtime.
    2. Click here to download the Outlook Add-in package.
    3. Unzip the package on a shared folder
    4. Create a GPO (Group Policy Object) in your active directory.
      • Deploy the Inova certificate
      • Execute the instalation
    If creating a GPO is not possible, as a workaround, you can use the Windows command-line tool named Certutil.exe to add the Inova certificate in the store:

    certutil.exe -addstore "TrustedPublisher" "\\PathToCertificate\Inova Software.cer"

    Membership in the local Administrators group, or equivalent, is the minimum required to complete this procedure.

     

    Introduction

    This page gives examples and instructions if the Inova Add-In is to be installed using a central deployment tool to push the Add-In to multiple users.

    When installed "normally", the Inova Outlook Add-In will update itself when a new version of the Add-In has been released by Inova. This is done when Outlook is started on the client PC. The Add-In will check the Inova site for the Add-In and compare the version installed with the version available. If the version installed is not the latest version, the available version will be downloaded and installed during Outlook startup. This process is generally not noticeable to the user.

    The advantage when an organization prefers to install the Inova Outlook Add-In from their own central repository, is that they are able to test the new version of the Add-In before it is installed on users' PCs. The organization can ask to be notified by email when a new version is available from Inova, download the new version and test it in their testing environment. 

    When the Inova Outlook Add-In is installed using these "advanced procedures", it is incumbent upon the client's internal Support/IT organization to be sure that the users' clients are updated with the latest version of the Add-In as soon as possible after it becomes available.

    There are two main sections on this page which detail the following :

    • The Settings Utility Tool. This section describes a tool developed by Inova to push out configurations of the Outlook Add-In to users' PCs.
    • Centralized Installation Instructions. This section details how to install the Add-In from a central repository such as a file or web server.

     

    The Settings Utility Tool

    This file can be found in the delivery directory, next to the setup.exe.

    Inova has developed a tool that can be used to configure certain elements on users’ clients. For example, as noted in the paragraph above, the user would need to enter the URL of the Inova Partner application in order to use the Add-In. The Settings Utility tool can be used to set the URL so that the user does not need to enter it in manually.

    The tool will read in an "ini" file which contains the configuration(s) desired to be set automatically. The tool will translate this file into a user.config file which will be stored in the default settings directory for the user’s Inova Add-In client. If a user.config file already exists in that location, the new configurations in the “ini” file will be merged into the existing user.config file, changing only those configurations contained in the “ini” file.

    Instructions for using the Settings Utility Tool

    1. Place the tool in a staging directory on the user’s PC.
    2. Create/Edit an "ini" file with the desired configurations, for example settings.ini.
      • Be sure the URL used does not have any additional context path information. For example, if the client browser’s bookmark has https://mycompany.partneringplace.com/inova-partner/ctx/auth/home.do, the URL to use in the Add-In configuration is simply https://mycompany.partneringplace.com/inova-partner.
      • Find an example of the "ini" file at the bottom of this page - the final "ini" file is to be provided by your Customer Success Manager.

    3. Run the tool from the command line, using the newly created “ini” file as input, for example:

      C:\<path-to-staging-directory>\SettingsUtility.exe settings.ini

    4. The tool should display the following output:

      Settings utility for Inova Partner Outlook Add-in
      Done...

    5. Once the tool is run, if not already existing, there will be a file named user.config in the default directory on the Inova Outlook Add-In (C:\Users\<user>\AppData\Local\Inova Software\PartnerPushAddIn\settings)
    6. If the user.config file exists before running the tool, the tool will merge updated configurations from the “ini” file into the existing user.config file, retaining the existing configurations not configured in the “ini” file.

      Some examples:

      • The setting file is stored in the current folder of the utility :

        SettingsUtility.exe settings.ini

      • The setting file is stored in mounted network drive :

        SettingsUtility.exe  DriveLetter:\*FOLDER*\settings.ini

      • The setting file is stored in the intranet :

        SettingsUtility.exe \\*IP*\settings.ini

    The utility can only be used with a local or intranet path. No http is allowed.

    File Path in Target computer

    C:\Users\username\AppData\Local\Inova Software\PartnerPushAddIn\settings\user.config

     

    Centralized Installation Instructions

    1. If not already installed, obtain and install on the client PC the following prerequisite software :
      • Microsoft .NET Framework 4.6.2 (or higher),
      • Microsoft Visual Studio 2010 Tools for Office Runtime.
    2. Once the prerequisite software has been installed reboot the client PC.
    3. Obtain from Inova the required certificate and push this certificate out to the client PCs where the Inova Add-In will be installed; for example, use Group Policy in Active Directory. The certificate should be placed in the client’s Trusted Publishers repository.
    4. Obtain and place on the PC or server the latest installation package (for example, OutlookAddin.zip) for the Inova Add-In and extract the package into a staging directory on the PC or server.

    Installation from the package:

    If the installation package for the Inova Add-In is in a local staging directory or on a network share.

    1. Obtain and place on the PC or server the latest installation package (for example, OutlookAddin.zip) for the Inova Add-In and extract the package into a staging directory on the PC or server.
    2. Use the VSTO Installer on the client PC to install the Inova Add-In. The VSTO Installer can normally be found here :

      C:\Program Files\Common Files\Microsoft Shared\VSTO\10.0\VSTOInstaller.exe

    3. Use the following command to install the Add-In :

      "C:\Program Files\Common Files\Microsoft Shared\VSTO\10.0\VSTOInstaller.exe" /i \\<Path_to_folder>\InovaPushAddin.vsto /s

    Please note the following points :
    • Replace <Path_to_folder> with the appropriate location.
    • The /s flag is used for a silent installation.

    Updates

    From time to time Inova will release updated versions of the Add-In.  The Add-In is designed to update itself automatically when a new update is available.

    When a user starts Outlook with the Add-In already installed, upon Outlook startup the Add-In will check to see if an update is available.  If an update is available, the Add-In will be updated to the latest version.

    If clients decide to use the instructions described on this page for installing the Add-In, Inova will advise the client when an update is available.  Inova will then deliver a "VSTO" update package, which the client's IT team can then test, if desired, before releasing to user client machines.  

    When the Add-In is installed from a local web server or file server, this location, that is, the URL of the local web server or file server location, is automatically configured into the Add-In as the location to check for updates.

    Template settings.ini file

    This template settings.ini (see attached file at the end of the article) is to be edited by your Inova Customer Success Manager (based on your specific configuration) and integrated to the package.

    The table below explains how to further configure this file.

    Fields used by the SettingsUtility.exe

    CONNECTION Params
    Description
    Values
    ConnectionType Indicates which kind of authentication the client is using

    0 – No option set

    1 – Standard : standard authentication (needs PartnerUserUrl and Credentials)

    2 – SSO : enterprise account (only needs PartnerUserUrl)

    PartnerUserUrl Set the plateform URL (if the client is synchronised, this step is not needed.)

    Example:

    https://yourcompany.partneringplace.com/inova-partner/

    ContactPushing Activate Contact Push True / False
    OBJECTS Params
    Description
    Values
    LinkObjects

    Set the shortcuts objects displayed in the Ribbon. These objects can also be sync with folders.

     

    ie : *LinkObjects= OOBOrganization;Company|ProductImpl;Product|*

    Values ( Object Class;Label ) :

    • OOBOrganization;Company|
    • ProductImpl;Asset|
    • InLicensingProjectImpl;In-Licensing Project|
    • OutLicensingDiscussionImpl;Out-Licensing Discussion|
    • InternalDevelopmentProjectImpl;R&D Collaboration|
    • AcquisitionImpl;Acquisition|
    • AgreementImpl;Agreement|
    FOLDERS Params
    Description
    Values
    SyncFoldersEnabled Activate Auto Sync of Folders True / False
    View Full Article
  • Troubleshooting

    Please check the Known Issues section of this document first, to determine if the issue attempting to troubleshoot is noted in that section.

    Installation

    During the installation of the Add-In the following pre-requisite packages are downloaded and installed, if they do not already exist on the PC :

    • Microsoft .NET Framework 4.5.x
    • Microsoft Visual Studio 2010 Tools for Office Runtime
    • Microsoft Visual C++ 2013 Redistributable

    If a firewall blocks the download of these Microsoft packages it may be necessary to reach out to the local IT/network staff for assistance in downloading and installing these packages manually.

    Add-in connection problems

    The Outlook Add-In uses the https protocol to connect to the web services of the Inova Partner application. If during the configuration of the Add-In the connection to the Inova Partner application is not working, check the following :

    • Verify that the URL, user name and password being used for the Add-In configuration, and that the Inova Partner application is available, by using the same information in a browser on the same client machine to log into the Inova Partner application;
    • Note that the user name and password are both case sensitive.
    • NOTE: When authentication via LDAP or Active Directory is being used, it is advised that the password be entered BEFORE The user name. By doing it in this order the chance that the user’s account will be disabled is diminished, if there is a setting in LDAP/AD that will disable the account after X number of login attempts with a bad password.
    • The Inova Partner application uses SSL (via https) by default; the security certificate must be valid and known to the client machine otherwise the Add-In will not be able to make the connection to the Partner application.
    • Check with the local network staff to see if the URL domain being used for the Add-In is added to any local white lists, as needed.
    • Check with an application administrator to be sure the user’s account within the application has the rights for Web Services enable.
    • If using a proxy, be sure the URL is configured in the proxy and proxy authentication, if needed.

    Logging

    The Inova Add-In for Outlook client has logging capabilities which can be configured if issues arise. The team at Inova can assist with logging configurations if they are needed.
    To access the logging configuration settings, from the Inova Add-In ribbon in Outlook, click on the “Settings” button. The Inova Add-In Configuration dialog box will be displayed. In the upper-right corner of the dialog box, click on the ‘note’ icon:
    The following dialog box will then be displayed:
    Both the “Standard log” and the “Detailed service log” can be enabled from this dialog box. Other options include log file location and name as well as the log level for standard logs. Configure accordingly as directed by Inova.

    Once logging configurations have been selected, click the “Save”’ button, and then click “Save” again on the Inova Add-In Configuration dialog box.
    To disable logging, navigate back to the Logs settings dialog box and uncheck the “Log enabled” box(es) and then click the “Save” buttons on each of the dialog boxes.

    Add-in disabled

    We have observed on occasion that Outlook add-ins can get disabled. This happens with any add-in and not only the Inova Add-In for Outlook. (If using Office/Outlook 2013 see the note at the end of this section.)
    If, when Outlook is opened, the “Inova” tab is no longer available above the ribbon, it’s probable that the Inova Add-In has been disabled. Re-enabling the Add-In can be accomplished by following these steps:

    • Click on the “File” tab;
    • Choose “Options” from the menu; the Outlook Options dialog box will be displayed;
    • From the left-side menu on the Outlook Options dialog box, click on “Add-Ins”;
    • In the list of Add-ins, look for the Add-In with the name “InovaPushAddIn”, as seen in the following screen shot:
    • If the Inova Add-In is not listed here, the Add-In is most likely disabled;
    • To re-enable, near the bottom of the dialog box, next to the word “Manage” select “COM Add-ins” from the drop-down menu and click the “Go…” button;
    • On the “COM Add-Ins” dialog box, find the “InovaPushAddIn” and select the box next to it so that it is checked, as follows:
    • Click the “OK” button; focus is reverted back to the Outlook client and the “Inova” tab should now be available.

    More information on this article.

    NOTE: If using Office/Outlook 2013 there is a workaround to prevent the Add-In from being disabled by Outlook upon startup. Administrators can override this behavior and force the Add-In to always be enabled by using the Office 2013 Group Policy Adminstrative Templates “List of managed add-ins” policy. For more details, and an example, see this article on Microsoft’s TechNet, specifically in the table “Managed Add-ins settings” the row with the setting name of “List of managed add-ins (Outlook)”.
    (https://technet.microsoft.com/en-us/library/cc178992%28v=office.15%29.aspx)

    Updating the add-in

    The Outlook Add-In will, upon Outlook starting up, check itself to determine if the version installed is the current version. If the version installed is not the current version the Add-In will update automatically by pulling the latest version from the Inova web server.
    If automatic updates are not desired, the initial installation of the Add-In should be done using the steps detailed in the Alternate Installation section. In this case, when the Add-In needs to be updated, obtain the new installation package from Inova and place in the same directory as the old one. Upon startup, Outlook will check this location to determine if the current version is installed and will then install the version that exists in this directory.

    View Full Article
  • Known Issues

    The following items have been identified by Inova software and should be taken into consideration when installing and using the Inova – Add-In for Outlook. Inova is working to correct these issues, and improvements will be seen in future releases.

    Proxy blocks installation

    During the installation of the Inova – Add-In for Outlook, the install program accesses an Inova web site to check that the current version of the Add-In is being installed. If the install program is not installing the latest version, it will download the latest version of the Add-In from the Inova web site.
    Inova has seen a few instances where a client’s proxy server blocks access to the Inova web site for the install program to perform this check and, consequently, the installation does not complete.
    There are three possible work-arounds to this issue:

    1. Add access to the following URL to allow access to the proxy server: http://inova-software.com/OutlookAddin/FINAL/InovaPushAddin.vsto.
    2. If installing on a laptop, perform the installation at a location other than while on the corporate network. For example, perform the installation while connected to the internet at the user’s home.
    3. See the section Alternative Installation for ‘offline’ installation instructions.

    In addition, the following pre-requisite packages are downloaded and installed, if they do not already exist on the PC:

    • Microsoft .NET Framework 4.5.x
    • Microsoft Visual Studio 2010 Tools for Office Runtime
    • Microsoft Visual C++ 2013 Redistributable

    If a firewall blocks the download of these Microsoft packages it may be necessary to reach out to the local IT/network staff for assistance in downloading and installing these packages manually.
    If the Microsoft packages are downloaded manually, the following are the minimum version numbers needed:

    • Microsoft .NET Framework 4.5.1 : 4.5.50938
    • Microsoft .NET Framework 4.5.2 : 4.5.51209
    • Microsoft Visual Studio 2010 Tools for Office Runtime (x64) : 10.0.50903
    • Microsoft Visual C++ 2010 Redistributable : 10.0.40219
    • Microsoft Visual C++ 2013 Redistributable : 12.0.305501

    User prompted to enable the add-in

    If the user sees a warning message from Outlook that the Add-In is disabled, the user should always choose to enable the Add-In by, for example, clicking the button labelled “Always enable this add-in”. The following screen shot is an example of the prompt seen by some users, along with the “Always enable…” button

    Error attempting to install

    If, when installing the Inova Add-In, a pop-up with the message "An error occurred attempting to install InovaPushAddIn" is shown, this could be due to a known issue with the VSTO installer on later Microsoft operating systems, for example, Windows 10.

    If this message appears, click on the Details button and note the details, especially the location of the installation log file. Open the installation log file and scroll to the bottom of the file.

    If the last messages in the file are the following, this is most likely due to a problem with the VSTO installer:

    URLDownloadToCacheFile failed with HRESULT '-2146697208'
    Error: An error occurred trying to download
    'http://inova-software.com/OutlookAddin/FINAL/InovaPushAddIn.vsto'.

    Following is a work-around which may help this issue:

    1. Open the folder “C:\Program Files\Common Files\Microsoft Shared\VSTO\10.0”
    2. Rename the file VSTOInstaller.config to VSTOInstaller.bak
    3. Execute the setup.exe file from Inova
    4. Rename the file VSTOInstaller.bak back to its original name of VSTOInstaller.config

    More information can be found on these web sites:

    Documents not pushed when the "create asset" option used

    Some users have noted that when using the Add-In to push an email to the application, if the “Create Asset” short cut is used, AND the email has documents attached to it, the documents are not always pushed to the new asset.
    Inova is working on a fix for this issue. In the interim, the work-around is to not use an email with documents attached to create an asset. For example, the user can first create the asset within the application’s UI, and then push the email with attached document to the new asset. Alternatively, the user can use the Add-In to create the asset with an email that does not have any documents attached to it.

    Special characters in user's password

    We have seen when a user has certain special characters in their password, the Add-In, though it is able to connect to the Inova Partner application, it does not allow the display of options to the user. Specifically we have seen this issue when the user has an ampersand (“&”) in the password.
    Inova is working on a fix for this problem in a future release. In the interim, the work-around is to change the user’s password so that the special character causing the problem is not in the password.

    Unable to package installer to deploy to multiple users

    Currently the installation package is not available in a form that can be used to ‘push out’ the install of the Add-In to multiple users automatically, for example, as an MSI package. Inova are working on correcting this.

    View Full Article