To install DocIntegrate Outlook, download and run the following installer: DocIntegrate Outlook 1.2.23. After this, the below registry settings need to be applied.

Note: For DocIntegrate Outlook to run, the Microsoft "Visual Studio Tools for Office Runtime 2010" need to be installed. Also, .net 4.0 is required.

Important: You need to run the installer and apply the registry settings on each windows account that needs DocIntegrateOutlook. However, DocIntegrate Outlook can also be installed on machine level (see below sections "Installation for All Users beforehand"). The following installations options are alternatives and not to be applied both at the same time.

Installing the registry settings on a client system

In key "CASE_BROWSER_BASE_URL" and in key "CASE_BROWSER_BASE_URL_DIRECT" you need to replace <<dmshost>> and <<port>> with the DMS' hostname and port (generally 9080). The "CASE_BROWSER_BASE_URL" is the URL under which the casebrowser can be reached. To set the registry key copy contents below and save file as key.reg and run it to add these registry key to the system.

key.reg template
Windows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\SOFTWARE\DocIntegrate]
"CASE_BROWSER_BASE_URL"="http://<<dmshost>>:<<port>>/casebrowser"
"CASE_BROWSER_BASE_URL_DIRECT"="http://<<dmshost>>:<<port>>/casebrowser"

To enable the opening of case in Patricia (horse icon) you need to set Patricia Basic Configuration value 235 to the TRUE.

If your system is set up to use LDAP/Kerberos proxy authentication, you will need to change the registry key "CASE_BROWSER_BASE_URL_DIRECT" to be different from "CASE_BROWSER_BASE_URL":

The above registry key "CASE_BROWSER_BASE_URL" will then need to contain the URL that is used to access casebrowser through the authentication proxy (generally without a <<port>> defined). In contrast, the "CASE_BROWSER_BASE_URL_DIRECT" is the URL under which the casebrowser can be reached in the standard non-authenticated way.

Installation information for terminal servers:

  1. uninstall previous user-based DIO installation first
  2. double check registry for orphaned settings
  3. switch Windows as admin to terminal mode
  4. install for all users as described here

Installation for All Users of one machine beforehand - 64bit OS

Installation information for terminal servers:

  1. uninstall previous user-based DIO installation first
  2. double check registry for orphaned settings
  3. switch Windows as admin to terminal mode
  4. install for all users as described here

Installation for all users:

  1. Install the DocIntegrateOutlook as Admin User
  2. Move Installation folder from %AppData%\Roaming\DocIntegrateOutlook to C:\Program Files (x86)\

  3. To set the registry key copy contents below and save file as key.reg and run it to add these registry keys to the system. In key "CASE_BROWSER_BASE_URL" and in key "CASE_BROWSER_BASE_URL_DIRECT" you need to replace <<dmshost>> and <<port>> with the correct values (see also the above general section) and save the code block to the key.reg file.
    Note: In case of a 64bit Office & a 64bit OS, the registry paths need to be set as seen in the installation for 32bit OS further down. The registry paths can't point towards the Wow6432Node.

  4. key.reg template
    Windows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Office\Outlook\Addins\DocIntegrateOutlook]
"InstallFolder"=""
"Manifest"="file:///C:\\Program Files (x86)\\DocIntegrateOutlook\\DocIntegrateOutlook.vsto|vstolocal"
"LoadBehavior"=dword:00000003
"FriendlyName"="DocIntegrateOutlook"

[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Office\Outlook\FormRegions\IPM.Note]
"DocIntegrateOutlook.DocIntegrateRegion"="=DocIntegrateOutlook"
 
[HKEY_LOCAL_MACHINE\SOFTWARE\DocIntegrate]
"CASE_BROWSER_BASE_URL"="http://<<dmshost>>:<<port>>/casebrowser"

"CASE_BROWSER_BASE_URL_DIRECT"="http://<<dmshost>>:<<port>>/casebrowser"

  5. Delete the corresponding per user registry keys:

    Remove keys
    HKEY_CURRENT_USER\Software\Microsoft\Office\Outlook\Addins\DocIntegrateOutlook
HKEY_CURRENT_USER\Software\Microsoft\Office\Outlook\FormRegions\IPM.Note
  6. In case you are using LDAP/Kerberos proxy authentication you need to add the "CASE_BROWSER_BASE_URL_DIRCET" key as well. Please consult the above general section for further details and apply analogously.
  7. To enable the opening of case in Patricia (horse icon) you need to set Patricia Basic Configuration value 235 to the TRUE.

Installation for All Users beforehand - 32bit OS

Installation information for terminal servers:

  1. uninstall previous user-based DIO installation first
  2. double check registry for orphaned settings
  3. switch Windows as admin to terminal mode
  4. install for all users as described here

Installation for all users:

  1. Install the DocIntegrateOutlook as Admin User 
  2. Move Installation folder from %AppData%\Roaming\DocIntegrateOutlook to C:\Program Files\

  3. To set the registry key copy contents below and save file as key.reg and run it to add these registry keys to the system. In key "CASE_BROWSER_BASE_URL" and in key "CASE_BROWSER_BASE_URL_DIRECT" you need to replace <<dmshost>> and <<port>> with the correct values (see also the above general section) and save the code block to the key.reg file. 

    key.reg template
    Windows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\DocIntegrateOutlook]
"InstallFolder"=""
"Manifest"="file:///C:\\Program Files\\DocIntegrateOutlook\\DocIntegrateOutlook.vsto|vstolocal"
"LoadBehavior"=dword:00000003
"FriendlyName"="DocIntegrateOutlook"

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\FormRegions\IPM.Note]
"DocIntegrateOutlook.DocIntegrateRegion"="=DocIntegrateOutlook"
 
[HKEY_LOCAL_MACHINE\SOFTWARE\DocIntegrate]
"CASE_BROWSER_BASE_URL"="http://<<dmshost>>:<<port>>/casebrowser"

"CASE_BROWSER_BASE_URL_DIRECT"="http://<<dmshost>>:<<port>>/casebrowser"

  4. Delete the corresponding per user registry keys:

    Remove keys
    HKEY_CURRENT_USER\Software\Microsoft\Office\Outlook\Addins\DocIntegrateOutlook
HKEY_CURRENT_USER\Software\Microsoft\Office\Outlook\FormRegions\IPM.Note
  5. In case you are using LDAP/Kerberos proxy authentication you need to add the "CASE_BROWSER_BASE_URL_DIRCET" key as well. Please consult the above general section for further details and apply analogously.
  6. To enable the opening of case in Patricia (horse icon) you need to set Patricia Basic Configuration value 235 to the TRUE.

Issue handling

If client experiences issues with the plugin, the error messages are not informative by default for VSTO addins, so we should ask for these additional actions:

  1. Set two environment variables to enable extended logging for the VSTO addins.

    1. VSTO_SUPPRESSDISPLAYALERTS=0

    2. VSTO_LOGALERTS=1

  2. Reproduce the issue again to make a screenshot of the error message (usually it changes after environment variables are set).
  3. Take a look to the event log if there are any error messages from Outlook (or Microsoft Office) in Application section.
  4. The whole message what causes the error. If it's not possible (because of privacy or any other reasons), ask at least for message id and case refs. 

This information should be enough to determine the code block where the issue is located.


In some cases the issue can be caused by the client's environment, in this case we should ask for the next info:

  1. Windows version.
  2. .NET version.
  3. Microsoft Office version (with service packs).
  4. Values of registry keys that should be set while installing the plugin (both manually and with installer).


In some cases, especially when there is a mixture of Microsoft Office 32Bit and 64Bit Versions installed
the resolution for making the Add-In Work can be to install both the registry for 32 Bit AND 64Bit Office (Outlook) as found above.

an explanation can be found here: https://docs.microsoft.com/en-us/visualstudio/vsto/registry-entries-for-vsto-add-ins?view=vs-2019

  • No labels