Integration For Microsoft Outlook 2019 Onbase Foundation Ep4 Modu

Integration for Microsoft Outlook 2019
Reference Guide
Includes:
Installation Guide
Administration Guide
User Guide
Foundation EP4
Copyright
Information in this document is subject to change without notice. The software described in this document is
furnished only under a separate license agreement and may be used or copied only according to the terms of
such agreement. It is against the law to copy the software except as specifically allowed in the license
agreement. This document or accompanying materials contains certain information which is confidential
information of Hyland Software, Inc. and its affiliates, and which is subject to the confidentiality provisions
agreed to by you.
All data, names, and formats used in this document’s examples are fictitious unless noted otherwise.
Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under
copyright law, no part of this document may be reproduced, stored in or introduced into a retrieval system, or
transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or
for any purpose, without the express written permission of Hyland Software, Inc. or one of its affiliates.
Hyland ® and Hyland Software ®, as well as Hyland product names, are registered and/or unregistered
trademarks of Hyland Software, Inc. and its affiliates in the United States and other countries. All other
trademarks, service marks, trade names and products of other companies are the property of their respective
owners.
© 2020 Hyland Software, Inc. and its affiliates. All rights reserved.
Document Name ........................................................................ Integration for Microsoft Outlook 2019
Department/Group.......................................................................................................... Documentation
Revision Number ............................................................................................................Foundation EP4
© 2020 Hyland Software, Inc. and its affiliates ii

Table of Contents
OVERVIEW
Applications ...............................................................................................................................................1
Licensing .....................................................................................................................................................1
INSTALLATION GUIDE
INSTALLATION
Requirements ............................................................................................................................................3
General Requirements ......................................................................................................................................... 3
Third-Party Software ............................................................................................................................................ 3
Microsoft Office 64-Bit Support Statement........................................................................................................ 3
Hyland Software - Microsoft Service Pack Statement....................................................................................... 4
Licensing............................................................................................................................................................... 4
Upgrade Considerations .........................................................................................................................4
Pre-Installation .........................................................................................................................................4
Installation .................................................................................................................................................4
Integration for Microsoft Outlook 2019 Configuration File Settings ................................................................ 5
Command Line Switches and .ini Settings ...........................................................................................5
Backup/Recovery .....................................................................................................................................6
Backup .................................................................................................................................................................. 6
Registry Settings ........................................................................................................................................... 6
External Files ................................................................................................................................................. 6
Recovery ............................................................................................................................................................... 6
Registry Settings ........................................................................................................................................... 6
External Files ................................................................................................................................................. 6
Troubleshooting .......................................................................................................................................6
Common Questions ............................................................................................................................................. 6
Public Folders and Shared Folders Not Supported .................................................................................... 6
Shared Mailboxes Not Recommended ....................................................................................................... 7
Error When Opening Microsoft Office Documents ..................................................................................... 7
Releasing Concurrent Client and Named Client Licenses ......................................................................... 7
Releasing Workflow Licenses ...................................................................................................................... 7
When I Launch Outlook, the Integration with OnBase Tab is Gone ........................................................... 7
Configured Outlook Signatures are Not Displayed on Outgoing Messages ............................................. 8
The Imaging Options Do Not Display in the Integration with OnBase Tab ............................................... 8
Fatal Error is Displayed When Attempting to Reconnect ........................................................................... 8
HTML Custom Queries Do Not Perform a Search ...................................................................................... 8
Displaying Troubleshooting Information ............................................................................................................ 9
Requesting Profile Diagrams............................................................................................................................... 9
Error During Installation on Client Machines...................................................................................................... 9
Contacting Support ............................................................................................................................... 10
© 2020 Hyland Software, Inc. and its affiliates iii

Table of Contents
HYLAND OFFICE PRODUCTS INSTALLERS

Overview ................................................................................................................................................. 11
Deployment Options........................................................................................................................................... 12
Microsoft Office 2016 Support Statement ....................................................................................................... 13
Microsoft Office 2019 Support Statement ....................................................................................................... 14
Microsoft Office 365 Support Statement ......................................................................................................... 15
Microsoft Updates to Microsoft Outlook.......................................................................................................... 15
Requirements ......................................................................................................................................... 15
General Requirements ....................................................................................................................................... 16
User Permissions ............................................................................................................................................... 16
Client Machine.................................................................................................................................................... 16
Installation Using ClickOnce .............................................................................................................. 17
Overview ............................................................................................................................................................. 17
General Installation Options .............................................................................................................................. 19
Web Server Installation Steps ........................................................................................................................... 24
From a Shared Folder Installation Steps .......................................................................................................... 27
Manually Created Share Steps .......................................................................................................................... 31
Service Location and Deployment Configuration............................................................................................. 35
Package-Specific Installation Steps ................................................................................................................. 36
Template Builder ........................................................................................................................................ 36
Excel Add-In ................................................................................................................................................ 37
Office Add-In ........................................................................................................................................ 37
Report Services .................................................................................................................................... 37
Outlook Integration ..................................................................................................................................... 38
Integration for Microsoft Outlook 20XX ............................................................................................. 39
WorkView Integration for Outlook ...................................................................................................... 46
PowerPoint Add-In ...................................................................................................................................... 47
Word Add-In ................................................................................................................................................ 47
Deployment Signing ........................................................................................................................................... 47
Additional Installation ........................................................................................................................................ 50
Remove Installed Prerequisites ................................................................................................................. 52
Controlling the Installer from the Command Line .................................................................................... 53
Updating or Adding a Deployment Instance..................................................................................................... 53
Removing a Deployed Application .................................................................................................................... 54
Removing a Deployed Application Instance from Client Workstations .................................................. 54
Removing a Deployed Application Instance from the Deployment Server ............................................. 54
Completely Removing a Deployed Application ......................................................................................... 56
Installation Using the Standard (MSI) Installer .............................................................................. 56
Overview ............................................................................................................................................................. 56
Hyland Office 2016/2019 Integration Installers............................................................................................... 58
Hyland Office 2016 Integration Installer Modules ................................................................................... 59
Hyland Office 2019 Integration Installer Modules ................................................................................... 59
Installing the Hyland Office 2016/2019 Integration ................................................................................. 60
Changing the Language and Culture Settings.................................................................................................. 73
© 2020 Hyland Software, Inc. and its affiliates iv

Table of Contents
Change, Repair, or Remove an Installation ....................................................................................................... 74

Controlling the Installer from the Command Line............................................................................................ 75
Feature and Property Names ..................................................................................................................... 77
Feature Names .................................................................................................................................... 77
Installation Directory ..................................................................................................................... 78
Associated Properties ................................................................................................................... 78
Outlook Integration Associated Properties.................................................................................. 78
Property Names ................................................................................................................................... 79
SERVICE_LOCATION_DATA_SOURCE .......................................................................................... 79
SERVICE_LOCATION_DISPLAY_NAME ........................................................................................ 79
SERVICE_LOCATION_NT_AUTH ................................................................................................... 80
SERVICE_LOCATION_SERVICE_PATH ......................................................................................... 80
OUTLOOKINTEGRATION_ADMIN_CONFIGURATION_FILE ......................................................... 81
OUTLOOKINTEGRATION_CREATE_FORMS ................................................................................. 81
OUTLOOKINTEGRATION_ENABLE_UPLOAD_FROM_FILE .......................................................... 81
OUTLOOKINTEGRATION_HELP_BUTTON_OPTION .................................................................... 81
OUTLOOKINTEGRATION_IMPORT_BUTTON_OPTION................................................................ 81
OUTLOOKINTEGRATION_LAUNCH_CLIENT_OPTION................................................................. 82
OUTLOOKINTEGRATION_READING_GROUPS_BUTTON............................................................. 82
OUTLOOKINTEGRATION_RETRIEVAL_BUTTON_OPTION .......................................................... 82
OUTLOOKINTEGRATION_SHOW_IMAGING ................................................................................. 83
OUTLOOKINTEGRATION_WORKFLOW_BUTTON_OPTION......................................................... 83
OUTLOOKINTEGRATION_WORKFLOW_UPDATE_NOTIFICATION ............................................. 83
OUTLOOKINTEGRATION_UPDATE_CLIENT_DEFAULT_OPTION................................................ 83
OUTLOOKINTEGRATION_USER_FOLDER_CONFIGURATION_OPTION ...................................... 84
OUTLOOKINTEGRATION_USER_TOOLBAR_CONFIGURATION_OPTION ................................... 84
OUTLOOKINTEGRATION_AUTO_SELECT_ATTACHMENTS ....................................................... 84
OUTLOOKINTEGRATION_DOCUMENT_DATE_SENT_DATE........................................................ 84
OUTLOOKINTEGRATION_KEEP_MESSAGES ............................................................................... 85
OUTLOOKINTEGRATION_MOVE_MESSAGES.............................................................................. 85
OUTLOOKINTEGRATION_MOVE_MESSAGE_LOCATION ............................................................ 86
OUTLOOKINTEGRATION_REMOVE_MESSAGES ......................................................................... 86
OUTLOOKINTEGRATION_STORE_MESSAGE_MSG ..................................................................... 86
OUTLOOKINTEGRATION_STORE_MESSAGE_SEPARATELY ...................................................... 87
OUTLOOKINTEGRATION_CLIENT_EXE_FILE_PATH.................................................................... 87
OUTLOOKINTEGRATION_EXE_COMMANDLINE_SWITCHES ..................................................... 88
OFFICE INTEGRATION FEATURE MATRIX
ADMINISTRATION GUIDE
CONFIGURATION
Configuration ......................................................................................................................................... 93
Document Types ................................................................................................................................................ 93
© 2020 Hyland Software, Inc. and its affiliates v

Table of Contents
Keyword Types ................................................................................................................................................... 93

System Keyword Types .............................................................................................................................. 94
Illegal Attachment Name Characters ........................................................................................................ 96
Integration for Microsoft Outlook 2019 Configuration ............................................................... 96
Button Configuration.......................................................................................................................................... 97
Import Options ............................................................................................................................................ 99
Mail Message Options ........................................................................................................................ 99
Storage Options .................................................................................................................................101
Launch Client Options ..............................................................................................................................102
Workflow Options .....................................................................................................................................102
Imaging Options .......................................................................................................................................103
Integration Options ...................................................................................................................................104
Auto Import Folder Configuration ...................................................................................................................105
Accessing Folder Configuration Options ................................................................................................106
Creating an Outlook Folder to Configure as an Auto Import Folder ......................................................107
Configuring an Auto Import Folder from an Existing Outlook Folder ....................................................112
Configuring a Document Type for Archiving Messages and Attachments ..........................................116
Configuring Items Sent to a Scan Queue ................................................................................................121
Configuring Keyword Options ..................................................................................................................125
Keyword Options ...............................................................................................................................127
Mapped Keyword Value Options ................................................................................................128
Considerations for Time-Related Keyword Types ...........................................................................130
Using Multi-Instance Keyword Type Groups with Auto Import Folders .........................................130
General Usage..............................................................................................................................130
Data Entry Keyword Option .........................................................................................................130
Mapped Keyword Option.............................................................................................................130
Static and Folder Name Keyword Options .................................................................................130
Understanding the Configuration Merge Process..........................................................................................131
Example Configuration One .....................................................................................................................131
Example Configuration Two ....................................................................................................................131
OUTLOOK FOLDER CONFIGURATION UTILITY

Overview ............................................................................................................................................... 133
Usage ...................................................................................................................................................... 133
Creating an Auto Import Folder Configuration File ........................................................................................133
Deploying an Auto Import Folder Configuration ............................................................................................134
Installation ............................................................................................................................................ 136
INTEGRATION FOR MICROSOFT OUTLOOK 2019 BEST PRACTICES

Configuration ....................................................................................................................................... 138
Document Types ..............................................................................................................................................138
Keyword Types .................................................................................................................................................138
Import Options..................................................................................................................................................138
Auto Import Folder Configuration ...................................................................................................................138
© 2020 Hyland Software, Inc. and its affiliates vi

Table of Contents
Installation ............................................................................................................................................ 139

ClickOnce ..........................................................................................................................................................139
USER GUIDE
USAGE
Accessing the Integration for Microsoft Outlook 2019 ............................................................. 142
The Integration with OnBase Ribbon ..............................................................................................................143
Importing and Indexing with an Auto Import Folder ..............................................................................147
Importing and Indexing an Auto Import Folder with Existing Messages .......................................153
Importing and Indexing without an Auto Import Folder .........................................................................155
Importing Attachments Only ...........................................................................................................................160
Importing All Attachments from an Email Message ..............................................................................160
Importing a Single Attachment from an Email Message .......................................................................163
Attaching a File from OnBase to an Outlook Email Message .......................................................................165
Viewing Imported Email and Other Documents in Outlook ...........................................................................168
System Interaction .............................................................................................................................. 170
Application Enabler ..........................................................................................................................................170
Document Imaging...........................................................................................................................................170
Sending Messages to a Scan Queue .......................................................................................................170
Sending Only Attachments to a Scan Queue ..........................................................................................171
Accessing Batch Processing ...................................................................................................................173
Document Knowledge Transfer & Compliance ..............................................................................................174
Mailbox Importer ..............................................................................................................................................174
Reporting Dashboards .....................................................................................................................................174
Workflow...........................................................................................................................................................175
Email Notifications ...................................................................................................................................175
© 2020 Hyland Software, Inc. and its affiliates vii

O VERVIEW
Integration for Microsoft Outlook 2019 enables a Microsoft® Outlook® 2019 user to store
email messages and their attachments. It also allows users to retrieve and view documents in
OnBase, as well as participate in Workflow.
Email messages and their attachments can be imported by dragging the email to a pre-
configured OnBase Outlook folder. The folder can be configured to automatically index email
messages and their attachments, or allow the user to index email messages and their
attachments. OnBase can automatically add index information from the email’s metadata such
as To, From, Subject Line, Date Received, and Message ID.
Archived email messages and their attachments are immediately available for OnBase users to
view, and can be configured to participate in Workflow. The email messages can be archived in
the native Microsoft MSG format or in the format in which it was written; HTML, Plain Text, or
Rich Text. Attachments are stored in their native format in OnBase.
Applications
Organizations in manufacturing, insurance, financial services, health care, distribution and
many other industries can benefit from using OnBase in conjunction with the familiar email
program interface, reducing training costs. Email and attachments can be quickly and
conveniently archived. Not only will the email documents be available immediately to other
OnBase users, the documents can also be incorporated into Workflow activities for action and
follow up. The OnBase Workflow interface creates a smooth segue from email processing to
workflow processing.
Licensing
You must be licensed for Integration for Microsoft Outlook 2019. A valid Concurrent Client,
Workstation Client, or Named User Client license is also required.
Check your current licensing status by selecting Utils | Product Licenses from the
Configuration module.
© 2020 Hyland Software, Inc. and its affiliates 1

Installation Guide
Foundation EP4
I NSTALLATION
Requirements
The Integration for Microsoft Outlook 2019 connects to OnBase using the Unity Client.
Note: You do not need to install the Unity Client separately in order to use the Integration for
Microsoft Outlook 2019. Installing the Integration for Microsoft Outlook 2019 automatically
makes Unity Client functionality available to users.
The following sections outline requirement information specific to Integration for Microsoft
Outlook 2019 in OnBase Foundation EP4.
General Requirements
For general requirement information that applies to Integration for Microsoft Outlook 2019 and
other modules, see the sections on the following topics in the Installation Requirements
manual:
• Supported Desktop Operating Systems, see the Unity Client table column
• Unity Client Platform Hardware Requirements
• Unity Client Browser Requirements
• Microsoft .NET Framework Requirements
• Server C++ Requirements
• Databases Supported
• Database/File Servers
Third-Party Software
You must have Microsoft Outlook 2019 in order to use Integration for Microsoft Outlook 2019.
The latest service pack is also required.
Microsoft Office 64-Bit Support Statement

The OnBase suite of products is tested on 64-bit systems and is capable of being deployed on
64-bit systems using the Windows 32-bit on Windows 64-bit Emulator (WOW64) layer. While
OnBase modules that integrate with Microsoft Office applications can be used with the 64-bit
versions of these applications, the 32-bit versions of these Microsoft Office applications are
recommended for the OnBase integrations. Consult the Microsoft Office Support Statement for
your version of Microsoft Office in the Hyland Office Products Installers chapter of this module
reference guide for complete details on the limitations to using a 64-bit version of these
applications.

Installation
Supported database versions that are deployed on a 64-bit database server are also supported.
For more information, contact your solution provider.
Hyland Software - Microsoft Service Pack Statement

The developers of OnBase are dedicated to ensuring the monthly cumulative updates released
by Microsoft ® are compatible with OnBase. On the second Tuesday of each month, the Quality
Assurance Department of Hyland Software evaluates the cumulative fixes released and labeled
as Critical or Important by Microsoft. The details of the update provided by Microsoft are
reviewed for interaction with OnBase and installed when appropriate for testing its
compatibility with OnBase. If you have questions regarding a specific Microsoft cumulative
update and its compatibility with OnBase, please contact your support provider.
Licensing
See Licensing on page 1 for licensing requirements.
Note: Unity Client licensing is not required to use the Integration for Microsoft Outlook 2019.
Upgrade Considerations
There are no additional upgrade considerations for this module.
Pre-Installation
Microsoft Visual Studio 2010 Tools for Office Runtime must be installed on client machines
prior to deployment. Microsoft Visual Studio 2010 Tools for Office Runtime can be obtained
from the Microsoft Download Center at http://www.microsoft.com/downloads. The x86
version is required for 32-bit versions of Windows; the x64 version is required for 64-bit
versions of Windows.
Note: Microsoft Visual Studio 2010 Tools for Office Runtime can also be installed by the
Hyland Office Integration Dependencies installer for ClickOnce deployments, or by using
setup.exe to run the MSI installer for the Office Business Application module.
Installation
Integration for Microsoft Outlook 2019 is installed using the Hyland Office Products Installers.
For instructions on how to install Integration for Microsoft Outlook 2019, see Hyland Office
Products Installers on page 11.

Installation
If you would like to include a default Auto Import folder configuration with Integration for
Microsoft Outlook 2019 deployments, see Outlook Folder Configuration Utility on page 61
before running the installer.
Note: After installing the Integration for Microsoft Outlook 2019, you must register
dsoframer.ocx in order to open Microsoft Office documents from the Integration for Microsoft
Outlook 2019. This component cannot be registered by the Office Products Deployments
Installer.
Integration for Microsoft Outlook 2019 Configuration

File Settings
You can configure the Integration for Microsoft Outlook 2019 to open the Import Document
pane on the left-hand side of an email message by default.
To do so:
1. Navigate to the Integration for Microsoft Outlook 2019 configuration file
( Hyland.Office[year].OutlookIntegration.dll.config ). In a typical installation, this file is
located in C:\Program Files\Hyland\Office Integration\Office [year] .
2. Locate the <applicationSettings> node.
3. Modify the ShowUploadTaskPaneOnLeft setting, so that the value is True .
Note: Any changes a user makes to the pane's location through the Integration for Microsoft
Outlook 2019 interface will override this configuration file setting.
Caution: If you are running the Click-Once Installer, any custom changes to the *.config file for
the module must be made before clicking Next at the Deployment Signing dialog box. If you are
running the Click-Once Installer in Advanced Mode, you still have the option to edit files in the
deployment folder at the File Edit Notification dialog box that is displayed after the Deployment
Signing dialog box.
Command Line Switches and .ini Settings

There are no command line switches or .ini settings necessary for Integration for Microsoft
Outlook 2019.

Installation
Backup/Recovery
Backup
Registry Settings
Registry Settings for Integration for Microsoft Outlook 2019 are located under
HKEY_CURRENT_USER\Software\Microsoft\Office\Outlook\Addins\Hyland.Office.2016.Outloo
kIntegration.
External Files
You will need to backup Microsoft Exchange and Microsoft Outlook folders, specifically folders
configured for Integration for Microsoft Outlook 2019.
Recovery
Registry Settings
Registry Settings for Integration for Microsoft Outlook 2019 are located under
HKEY_CURRENT_USER\Software\Microsoft\Office\Outlook\Addins\Hyland.Office.2016.Outloo
kIntegration.
External Files
Restore Microsoft Exchange and Microsoft Outlook folders, specifically those folder configured
for Integration for Microsoft Outlook 2019.
Troubleshooting
The following sections describe specific issues and how to resolve them.
Common Questions
The following are common issues while using the Integration for Microsoft Outlook 2019.
Public Folders and Shared Folders Not Supported

Configuring a public folder or shared folder as an Auto Import folder is not supported.
Messages from a public or shared folder cannot be moved into an Auto Import folder to initiate
an upload into OnBase.
Messages in public and shared folders can only be manually imported by using the Import
button. For more information on manually importing messages, see Importing and Indexing
without an Auto Import Folder on page 155.

Installation
Shared Mailboxes Not Recommended

It is not recommended to use a shared mailbox with the Integration for Microsoft Outlook 2019
as this can result in unexpected behavior, including duplicate emails imported into OnBase.
Error When Opening Microsoft Office Documents

When opening Microsoft Office documents from the Integration for Microsoft Outlook 2019,
the following error is displayed: There was an error opening this file.
If you receive this error, ensure dsoframer.ocx is registered. This file must be registered in
order to open Microsoft Office documents from the Integration for Microsoft Outlook 2019.
Releasing Concurrent Client and Named Client Licenses

Licenses are released after closing Outlook or after a five-minute period of inactivity where you
are not performing integration with OnBase actions within Outlook. The system attempts to
automatically acquire a license after you perform an integration with OnBase action within
Outlook.
If there are no licenses available at this point, the following message is displayed: Your client
license was released due to inactivity and a license could not be acquired because all
licenses are currently in use. You may still continue working.
An attempt is made to acquire an unused license periodically, and this message is displayed
until a license is acquired.
Releasing Workflow Licenses

Workflow licenses are released after the Workflow layout is closed, the email message is
closed, or the Workflow ad hoc task is executed. If there are multiple conditions under which
the license is being consumed, the license is released after the last condition is closed. For
example, the Workflow layout and an email message containing the Workflow Task Pane
button are both open. Under these conditions, the Workflow license is only released after
closing both the Workflow layout and the email message.
Workflow licenses are also released after a five-minute period of inactivity where you are not
performing Workflow actions within Outlook. The system attempts to automatically acquire a
license after you perform a Workflow action within Outlook.
If there are no licenses available at this point, the following message is displayed: Your client
license was released due to inactivity and a license could not be acquired because all
licenses are currently in use. You may still continue working.
An attempt is made to acquire an unused license periodically, and this message is displayed
until a license is acquired.
When I Launch Outlook, the Integration with OnBase Tab is

Gone
If the integration with OnBase tab is not displayed when you launch Outlook, the Integration for
Microsoft Outlook 2019 has been disabled.

Installation
To enable the Integration for Microsoft Outlook 2019:

1. From the Outlook menu options, select File | Options .
2. From the Outlook Options dialog box, select Add-ins .
3. From the Manage drop-down list, select Disabled Items .
4. Click Go... .
5. From the Disabled Items dialog box, select the Integration for Microsoft Outlook 2019.
6. Click Enable .
Configured Outlook Signatures are Not Displayed on Outgoing

Messages
When using the integration with OnBase Mail Message dialog box, signatures are not available.
To display signatures, compose emails in Outlook.
The Imaging Options Do Not Display in the Integration with

OnBase Tab
If the integration with OnBase tab does not display the Imaging options ( Send to Scan Queue
and Batch Processing ) in the ribbon after installing with the MSI installer, the Hyland Office
Products Installer was not installed using administrator privileges.
To display the Imaging options, the Integration for Microsoft Outlook 2019 must be re-installed
and the Hyland Office Products Installer must be run with administrator privileges.
One way to execute the Hyland Office Products Installer setup.exe file using administrator
privileges is to right-click on the setup.exe file and select Run as administrator .
Fatal Error is Displayed When Attempting to Reconnect

When logged on to the Unity Client while using the Integration for Microsoft Outlook 2019, the
following error may be displayed: The reconnection service has encountered a fatal error.
Please save your work and restart the application.
Your Unity Client session may be interrupted and you are required to re-authenticate your
connection to OnBase. This can happen for several reasons, such as if you are required to reset
your password, or if the network connection is interrupted. If this error is displayed, you must
save your work in the current session and restart the Integration for Microsoft Outlook 2019 to
begin a new session.
HTML Custom Queries Do Not Perform a Search

When performing an HTML custom query in the Integration for Microsoft Outlook 2019, it is
possible the custom query cannot perform the search. If your HTML custom query e-form uses
CSS or JavaScript, then the e-form cannot be rendered in the Integration for Microsoft Outlook
2019 user interface as these languages are not supported for rendering. To fix this issue, you
must add the following element within the <head> tag of every e-form you want to use with the
Integration for Microsoft Outlook 2019:
<meta http-equiv="X-UA-Compatible" content="IE=edge">

Installation
Displaying Troubleshooting Information

The Troubleshooting layout from the Unity Client can be accessed from within Outlook.
Using this layout may be useful when in-depth information such as connection information,
troubleshooting messages, and memory usage information is needed.
To access the Troubleshooting layout:
1. Select File and the integration with OnBase option.
2. The Integration for Microsoft Outlook 2019 configuration layout is displayed.
3. Click Troubleshooting to open the Troubleshooting layout. If you have not already
logged into the Unity Client, you are prompted to do so.
Note: For additional information on the Troubleshooting layout, see the Unity Client module
reference guide.
Requesting Profile Diagrams

The Request Profile Diagram layout from the Unity Client can be accessed from within Outlook.
Using this layout may be useful when information on performance and web service requests is
needed.
To access the Request Profile Diagram layout:
1. Select File and the integration with OnBase option.
2. The Integration for Microsoft Outlook 2019 configuration layout is displayed.
3. Click Request Profile Diagram to open the Request Profile Diagram layout. If you have
not already logged into the Unity Client, you are prompted to do so.
Note: For additional information on the Request Profile Diagram layout, see the Unity Client
module reference guide.
Error During Installation on Client Machines

When attempting to install this module to a client machine using a ClickOnce deployment, the
Microsoft Office Customization Installer dialog box is displayed with the message: There was
an error during installation. After clicking Details , the following message is displayed: The
expected element "addIn" was not found in the XML.
This error occurs because the Microsoft Visual Studio 2010 Tools for Office Runtime (x86)
files are not installed on the client machine. To resolve this error, you must install the
Microsoft Visual Studio 2010 Tools for Office Runtime (x86) files on the client machine
before installing this module.
Note: Microsoft Visual Studio 2010 Tools for Office Runtime (x86) can be obtained from the
Microsoft Download Center at http://www.microsoft.com/downloads.

Installation
Contacting Support
When contacting your solution provider, please provide the following information:
• The OnBase module where the issue was encountered.
• The OnBase version and build.
• The type and version of the connected database, such as Microsoft SQL Server 2014
or Oracle 12c, and any Service Pack that has been installed.
• The operating system that the workstation is running on, such as Windows 10 or
Windows Server 2012 R2, and any Service Pack that has been installed. Check the
supported operating systems for this module to ensure that the operating system is
supported.
• The name and version of any application related to the issue.
• The version of Internet Explorer and any Service Pack that has been installed, if
applicable.
• A complete description of the problem, including actions leading up to the issue.
• Screenshots of any error messages.
Supplied with the above information, your solution provider can better assist you in correcting
the issue.

HYLAND OFFICE PRODUCTS I NSTALLERS
Overview
The Hyland Office Products installers are used to install the OnBase integration modules for
Microsoft Office.
The following functionality is included in the installers and can be installed independently of
each other:
• Office Add-In for Microsoft Word
• Office Add-In for Microsoft PowerPoint
• Office Add-In for Microsoft Excel
• Report Services Excel Add-In for Microsoft Office
• Integration for Microsoft Outlook
• WorkView Integration for Microsoft Outlook
• Template Builder
For complete details regarding the functionality and configuration of any of the modules
included in the Hyland Office Products Deployment installer, or for any additional installation
steps required to install and use the module on the client machine, refer to the module
reference guide for that module.
Note: If you would like to include a default Auto Import folder configuration with Microsoft
Outlook deployments, see Outlook Folder Configuration Utility on page 61 before running the
installer.

Hyland Office Products Installers
Deployment Options
The Hyland Office Products installer is distributed as a ClickOnce deployment installer or as a
standard executable installer (MSI). While either installer can be used to install the same
functionality, the following differences should be considered when deciding which installation
option is best for your organization:
ClickOnce installer Standard (MSI) installer
After running the Hyland Office Products Prerequisites are installed automatically as
Deployment installer you must run the separate long as the setup.exe executable is used for
Hyland Office Integration Dependencies installation.
installer on each workstation before the
packages are deployed to those workstations.
This installer installs the prerequisites required
to use the Office and Outlook integration
modules on the client workstations. These
prerequisites are not included in the deployment
packages and cannot be deployed using
ClickOnce.
Deployment packages can be installed on the The installer must always be run on the local
local workstation by any user with rights workstation by a user who is an Administrator
sufficient to access the deployment package on on that workstation.
the deployment server.
Deployment packages can be updated to a new In order to upgrade to a new version, the old
version without first uninstalling the module version must be uninstalled from each
from each workstation. The new version is workstation before the new version can be
automatically updated on each workstation the installed.
next time the module is accessed.
Microsoft Office documents opened using the Microsoft Office documents opened using the
Web Client cannot be revised using the Office Web Client can be revised using the Office
Business Application modules if those modules Business Application modules if those
were deployed using ClickOnce. modules were installed using the standard
(MSI) installer.
A new instance must be created for different Language and culture settings can be changed
language and culture settings, and those for each workstation installed to.
settings are applied to all users who access that
deployment instance.
Document Templates cannot be used in the Document Templates can only be used in the
Web Client with the Office Business Application Web Client with the Office Business
modules if those modules are installed using Application modules when those modules are
the ClickOnce installer. installed using the standard installer (MSI).

ClickOnce installer Standard (MSI) installer
The ClickOnce installer cannot be used to install The 64-bit versions of the Hyland Office add-
the 64-bit Hyland Office add-ins. ins for Microsoft Office can be installed using
the standard installer (MSI) for 64-bit
environments.
Note: You cannot install some components using ClickOnce and others using the standard
(MSI) installer. Once you have installed a component, that same deployment method must be
used to install additional components.
This chapter covers installation using either method:

• Installation Using ClickOnce on page 17
• Installation Using the Standard (MSI) Installer on page 56
Microsoft Office 2016 Support Statement

While OnBase supports the 32-bit and 64-bit versions of Microsoft Office 2016, Hyland
Software recommends that customers only install the 32-bit version of Microsoft Office 2016.
For most users, the 64-bit version of Microsoft Office 2016 does not provide additional
performance benefits.
Microsoft provides the following guide to assist with choosing the correct version of Microsoft
Office for your organization (http://support.office.com/en-us/article/Choose-the-32-bit-or-64-
bit-version-of-Office-2dee7807-8f95-4d0c-b5fe-6c6f49b8d261?CorrelationId=165c464e-6fb1-
4532-83ad-7537787fd680&ui=en-US&rs=en-US&ad=US).
Separate versions of the Office Business Application for 2016 and Integration for Microsoft
Outlook 2016 modules are available that support the 64-bit version of Microsoft Office 2016.
The 64-bit versions of these modules have limited functionality, though, due to some
components which are not 64-bit compatible.
The following are limitations when using the 64-bit versions of the Office Business Application
for 2016 and Integration for Microsoft Outlook 2016 modules:
• The ClickOnce installer is not supported.
• The embedded Unity Document Viewer cannot display Microsoft Office documents.
The Office Business Application for 2016 will be used to open all Microsoft Office
documents. The Office Business Application for 2016 is required to view Microsoft
Office documents from the Integration for Microsoft Outlook 2016.
• Topaz signature pad functionality, which is part of the Signature Pad Interface
module, is not available.
• Document scanning and acquisition is not available.
• The Document Composition preview window, which may be displayed after
composing a new document using the Document Composition module, is not
available.

• Send To | Mail Recipient functionality using the Novell GroupWise email client is not
available.
Caution: OnBase does not support mixed 32-bit and 64-bit Microsoft Office installations with
the Office Business Application for 2016 and Integration for Microsoft Outlook 2016 modules.

While OnBase supports the 32-bit and 64-bit versions of Microsoft Office 2019, Hyland
Software recommends that customers only install the 32-bit version of Microsoft Office 2019.
For most users, the 64-bit version of Microsoft Office 2019 does not provide additional
performance benefits.
Microsoft provides the following guide to assist with choosing the correct version of Microsoft
Office for your organization (http://support.office.com/en-us/article/Choose-the-32-bit-or-64-
bit-version-of-Office-2dee7807-8f95-4d0c-b5fe-6c6f49b8d261?CorrelationId=165c464e-6fb1-
4532-83ad-7537787fd680&ui=en-US&rs=en-US&ad=US).
Separate versions of the Office Business Application for 2019 and Integration for Microsoft
Outlook 2019 modules are available that support the 64-bit version of Microsoft Office 2019.
The 64-bit versions of these modules have limited functionality, though, due to some
components which are not 64-bit compatible.
The following are limitations when using the 64-bit versions of the Office Business Application
for 2019 and Integration for Microsoft Outlook 2019 modules:
• The ClickOnce installer is not supported.
• The embedded Unity Document Viewer cannot display Microsoft Office documents.
The Office Business Application for 2019 will be used to open all Microsoft Office
documents. The Office Business Application for 2019 is required to view Microsoft
Office documents from the Integration for Microsoft Outlook 2019.
• Topaz signature pad functionality, which is part of the Signature Pad Interface
module, is not available.
• Document scanning and acquisition is not available.
• The Document Composition preview window, which may be displayed after
composing a new document using the Document Composition module, is not
available.
• Send To | Mail Recipient functionality using the Novell GroupWise email client is not
available.
Caution: OnBase does not support mixed 32-bit and 64-bit Microsoft Office installations with
the Office Business Application for 2019 and Integration for Microsoft Outlook 2019 modules.


In order for the OnBase Office integrations to function in a Microsoft Office 365 environment,
the Office 365 subscription must include a desktop-based version of Microsoft Office that is
also supported by OnBase. OnBase does not have any integrations for Office Online.
Office 365 subscribers are automatically updated to the latest version of Office when it
becomes available. Before this update is applied, they must ensure that they are using a
version of OnBase that supports this latest version of Office. At the same time, it is
recommended that Office 365 subscribers contact their solution providers to discuss any
licensing updates that may be required to support their Integration for Microsoft Outlook,
Office Business Application, and WorkView Integration for Microsoft Outlook solutions on the
latest version of OnBase.
Microsoft Updates to Microsoft Outlook

After applying a Microsoft update to Microsoft Outlook 2013 or 2016, the Auto-Import Folder
Configuration information for the Integration for Microsoft Outlook can be lost. If this is the
case, the integration tool bar and ribbon are still displayed, and ad-hoc importing is successful,
but user-specific Auto-Import Folder Configuration options are missing.
This issue is caused by the installation of Outlook-specific updates from Microsoft. These
updates cause a new sub-directory to be created within the original installation directory (in a
ClickOnce deployment, this is the location of the deployed integration on the client machine,
not on the deployment server). After the update, Outlook uses this new sub-directory as the
location of the user.config file, which contains the user-specific Auto-Import Folder
Configuration information. However, the new sub-directory does not contain the original Auto-
Import Folder Configuration information for the user. Instead, a new default user.config file
that contains no customized settings is used in place of the original.
To resolve this issue, copy the original user.config file from the original installation directory
and paste it into the new sub-directory created by the Outlook update from Microsoft. After
replacing the new user.config file with the original, user-specific file and re-launching Outlook,
Auto-Import Folder Configuration should be restored.
In a ClickOnce deployment, where the Auto-Folder Configuration information is set in the
deployment package and cannot be changed by users, you could also create an updated
deployment package and redeploy the integration to the client machines.
Requirements
The Hyland Office Integrations installed require the OnBase Application Server. Before running
the Hyland Office Products installer, make sure that the OnBase Application Server is installed
(see the Application Server module reference guide for installation instructions).
The Hyland Office Products installer must be run on systems that support the Windows®
Installer 2.0 architecture.

The following sections outline requirement information specific to Integration for Microsoft
Outlook 2019 in OnBase Foundation EP4.
General Requirements
For general requirement information that applies to Integration for Microsoft Outlook 2019 and
other modules, see the sections on the following topics in the Installation Requirements
manual:
• Microsoft .NET Framework Requirements
• Server C++ Requirements
User Permissions
You must be logged on to the installation machine with administrator privileges in order to use
the Hyland Office Products installer.
Note: The Hyland Office Products installer must be run with elevated administrator privileges,
even if the user currently logged in is an administrator.
If you are installing a deployment package to be delivered to a client workstation using

ClickOnce, any user on the client workstation can install the deployed package as long as they
have sufficient rights to access the package on the deployment server.
Client Machine
Microsoft Visual Studio 2010 Tools for Office Runtime must be installed on client machines
prior to deployment. Microsoft Visual Studio 2010 Tools for Office Runtime can be obtained
from the Microsoft Download Center at http://www.microsoft.com/downloads. The x86
version is required for 32-bit versions of Windows; the x64 version is required for 64-bit
versions of Windows.
Note: Microsoft Visual Studio 2010 Tools for Office Runtime can also be installed by the
Hyland Office Integration Dependencies installer for ClickOnce deployments, or by using
setup.exe to run the MSI installer for the Office Business Application module.

Installation Using ClickOnce

The Hyland Office Products Deployment installer is used to install the ClickOnce deployment
packages for several modules on the deployment server (see Overview on page 11). The
deployment package is then accessed by client machines to install the module on the client
machine.
Note: After running the Hyland Office Products Deployment installer you must run the
separate Hyland Office Integration Dependencies installer on each workstation before the
Office integration packages are deployed to those workstations. This installer installs the
prerequisites required to use the Office and Outlook integration modules on the client
workstations. These prerequisites are not included in the deployment packages and cannot be
deployed using ClickOnce. See Additional Installation on page 50.
The Hyland Office Products Deployment installer can be run from an installation CD or a local
drive.
Note: You must be appropriately licensed for all modules and functionality installed. You can
install, but cannot use, modules for which you are not licensed.
Overview
Standard (EXE or MSI) Installers — There are two methods for running OnBase installers:
Interactive and silent. An interactive installation requires user interaction with dialog boxes
during the installation process. A silent installation does not require user interaction during the
installation process.
OnBase installers may consist of both an executable file (.exe ) and a Windows Installer
Package file ( .msi ). When performing an interactive installation, and both an executable file
and MSI are available, use the executable file to ensure a complete installation. The executable
validates that all prerequisites are met before proceeding with the installation. If any missing
prerequisites are identified, the installer alerts the user. Most missing prerequisites can be
installed directly from the installer before continuing the installation process.
Note: The Microsoft .NET Framework prerequisite must always be installed separately before
running either the EXE or MSI installer.
When performing a silent installation, and both an executable file and MSI are available, use the
MSI. Since the MSI package does not validate prerequisites, you must ensure that Windows
Installer 3.0 or greater is installed on each workstation and that all other prerequisites are met
before running the MSI. If any prerequisites are not met, a silent installation from the MSI will
fail without alerting the user.
For more information about configuring a silent installation, see https://docs.microsoft.com/
en-us/windows/win32/msi/command-line-options.

ClickOnce Installers — Some OnBase modules are installed for deployment using ClickOnce.
ClickOnce is a Microsoft technology that installs a deployment package to a central server.
This package can then be accessed by users to install the application on their local
workstations. The application is installed entirely under the user’s profile, ensuring that it
cannot interfere with other applications installed on the workstation.
ClickOnce deployments also have the following advantages:
• Previously installed versions of the module can be easily and automatically updated
to the latest version with little or no user interaction, as long as the deployment
server and deployment instance name are not changed.
• The module is installed on a per-user basis and does not require administrator
privileges for local installation.
• There can be multiple instances of the module deployed, allowing for different
versions of the module to be installed on a per-user basis, to match the version
requirements of the workstation it is being installed to.
For more information on Microsoft’s ClickOnce technology see https://docs.microsoft.com/en-
us/visualstudio/deployment/clickonce-security-and-deployment.
Note: ClickOnce-deployed applications are not supported by Microsoft within a Remote

Desktop environment.
OnBase modules that are deployed using ClickOnce should either take advantage of the
ClickOnce deployment method as an alternative to a Remote Desktop deployment, or the
module should be installed using a standard installer and deployed using the Remote Desktop
methodology.
Note: Not all OnBase modules that support ClickOnce have a standard installer available.
Contact your first line of support if you are unsure how to install and deploy a specific module.
User Account Control (UAC) — If Windows User Account Control (UAC) is enabled, the installer
must be run with elevated administrator privileges, even if an administrator is currently logged
on. This can be accomplished by right clicking on the installer executable and selecting Run as
Administrator from the right-click menu. MSI files cannot be run using the Run as
Administrator option. Instead, you must launch the MSI package using the command line. For
more information on installing files through the command line, refer to your Microsoft support
information or see https://docs.microsoft.com/en-us/windows/win32/msi/command-line-
options.
Silent Installation Using setup.exe — If you are running setup.exe silently from the command
line you must use the /q switch and the /CompleteCommandArgs switch, followed by the
required command-line arguments.
The q switch specifies quiet mode and is required to suppress the GUI. The
CompleteCommandArgs switch must be followed by the command-line parameters required to
configure and install the desired components.

The complete string of command-line parameters must be included in double quotes after the
CompleteCommandArgs switch. If a parameter in the string also requires double quotes, those
quotes must be escaped using \ . For example: setup.exe /q /CompleteCommandArgs
"INSTALL_PROPERTY=\"my value\" INSTALL_PROPERTY_2=\"my value 2\"" .
Note: You should check the return value of the setup.exe process. A return value of 0 (zero)
indicates success. Any other value returned may indicate that an error was encountered and
the installation failed.
General Installation Options

To run the Hyland Office Products Deployment Installer:
1. Execute setup.exe with administrator privileges. This can be done by right-clicking on
the file name and selecting Run as administrator . This executable is usually located in
the \ClickOnce\Office Products folder of your source installation files.
2. The Ready to Install dialog box is displayed. Click Install .

3. Click Launch or Finish , depending on the module being installed. The Welcome to the
Deployment Creation Wizard dialog is displayed.
Select Advanced Mode to enable the ability to update certain aspects of the installation
where the default values are populated by the installer. Not selecting this option
automatically uses the default values populated by the installer.
Caution: Any necessary changes to the files in the deployment folder or the contents of the
deployment folder, such as custom changes to the *.config file for the module, must be made
before clicking Next at the Deployment Signing dialog box. If you are in Advanced Mode, you
still have the option to edit files in the deployment folder at the File Edit Notification dialog box
that is displayed after the Deployment Signing dialog box.
Note: If your servers are configured to use an HTTPS binding, or you are going to enable Active
Directory or LDAP Authentication, you should enable Advanced Mode in order to be able to
configure these options in your deployment.

4. Click Next . The Instance Settings dialog box is displayed.
Note: If the Package Selection dialog box is displayed, select the package to deploy then click
Next to reach the Instance Settings dialog box.
5. Select the name of the application instance from the drop-down list under the Instance
Name section, or select it from the drop-down select list if you are updating an existing
instance. To create a new instance name:
a. Click the Add button to the right of the drop-down list. The Create New Instance
dialog box is displayed.
Note: If you create a new instance name for an existing deployment, the package must be
redeployed to client machines under the new instance name.

b. Enter a name for the new instance in the field provided. The name entered is used to
distinguish this deployment from other deployments, so it must be unique.
Note: The instance name cannot contain any of the following characters: [ ] < > , ; : + = " / \ | ?
*#'
c. Click OK .
6. The Deployment Version Number fields can be used to manually set a new version
number for this deployment. This number is used by client machines to determine if the
application installed needs to be updated.
The Deployment Version Number is incremented automatically by the deployment
wizard. The initial Deployment Version Number is 1.0.0.0 , and there is no need to
change this number.
Note: The Deployment Version Number is not available unless Advanced Mode is selected on
the Welcome to the Deployment Creation Wizard dialog. To enable the Deployment Version
Number , click Back and select Advanced Mode on the Welcome to the Deployment Creation
Wizard dialog.
7. Select the Require clients to upgrade to version check box to force client machines to
upgrade to the current instance. This option is selected by default.
8. Click Next . The Deployment Location dialog box is displayed.

9. Click Change beside the Deployment Folder field to select a different folder. The
Deployment Folder can be a local path or network location and is the folder to which the
application files are copied on the deployment server.
Note: If you are updating an existing deployment, you cannot change the Deployment Folder . If
you create a new instance with a different Deployment Folder, the old deployment is not
updated and the package must be redeployed to client machines with the new Deployment
Folder location.
Caution: Files in the Deployment Folder selected are overwritten.
10. Click Next . The How do you want to deploy...? dialog is displayed.
11. Click the Web Server icon to deploy the application to client workstations via a URL
(e.g., https://web-server/Application/DeployedApp.application ).
Note: If IIS is not installed, you cannot select Web Server and must deploy the application via a
UNC path.
Click the From a Shared Folder icon to deploy the application to client workstations via
a UNC path (e.g., \\machine-name\Application\DeployedApp.application ).
Note: The From a Shared Folder option is not available if deploying to a network location (e.g.,
\\MyServer\MyShare).
Select Skip this step to configure the deployment folder manually as a shared folder or
a virtual directory.

12. Click Next .

• For Web Server installations, go to the Web Server Installation Steps.
• For From a Shared Folder installations, go to the From a Shared Folder Installation
Steps.
• If Skip this step is selected, go to the Manually Created Share Steps.
Web Server Installation Steps

If you are installing the deployment package to a Web server, the Web server must be added to
the Local intranet zone in Microsoft Internet Explorer. Zones are configured in Internet Explorer
by selecting the Security tab of the Internet Options (available from the Tools menu). You
must also Enable the following Security settings:
• Automatic prompting for file downloads
• File download
• Font download
Tip: For complete details on adding and configuring sites in the Local Intranet Zone, see the
Microsoft Internet Explorer help files.
After selecting Web Server at the How do you want to deploy...? dialog box, the Configure
Virtual Directory dialog is displayed:

1. Select the Web Site to create the virtual directory under from the drop-down list.
Note: The application generated by the deployment wizard uses the security settings from the
Default Web Site in IIS.
2. Select a Protocol from the drop-down list. This allows you to configure the installed
application to use the https protocol if an HTTPS binding is available.
3. Enter the Host Name of the Web Site selected, or accept the default host name
presented. In some cases, such as with an HTTPS binding, the default value may need
to be changed to match the host name in the certificate.
To specify a port to use for this connection, include the port number in the host name:
<host name>:<port> (e.g., DEV-007832:82 ).
4. Enter a name for the Virtual Directory in the field provided. This is the name of the
virtual directory created under the Web server selected.
Note: If a virtual directory with the same name already exists, the existing virtual directory is
configured to point to the Deployment Folder configured. The following special characters
cannot be used in the Virtual Directory name: \ ? ; : @ & = + $ , | " < > * .
5. Click Next . The Package Extraction dialog is displayed, which displays the progress of
the installation.

6. Click Next when the extraction has completed. The General Settings dialog is
displayed.
Note: The General Settings dialog is not displayed for all modules, depending on the type of
application being deployed. For example, desktop shortcuts cannot be created for the
Microsoft Office add-ins so the General Settings dialog is not displayed.
Select Create Desktop Shortcuts to create a shortcut to the deployed application on the
client machine when the application is first installed on the client machine.
Note: This option is only available for new deployments.
7. Click Next .
Note: You do not need to complete the steps under From a Shared Folder Installation Steps or
Manually Created Share Steps . Proceed to the section after the Manually Created Share Steps
section.

From a Shared Folder Installation Steps

If you selected From a Shared Folder at the How do you want to deploy...? dialog, the
Configure Folder Share dialog is displayed:
Note: Read access on the shared folder is required for users to be able to install and upgrade
the deployed application. Shared folder permissions must be set outside of this installation for
deployments installed to a UNC location.
1. Enter a Share Name in the field provided. This is the name that the Deployment Folder
will be shared as to users.
Note: The Share Name must be unique. You cannot enter the name of an existing share.
2. Enter the External Name of the server hosting the Deployment Folder configured, or
accept the default value presented. This is the name users will use to access the server.
The default value is the machine name of the machine containing the shared folder.
Note: The External Name field is only available if Advanced Mode is selected on the Welcome
to the Deployment Creation Wizard dialog.

3. Click Next . The Folder Share Permissions dialog is displayed if you are installing the
deployment to a local drive (e.g., C: ):
This dialog allows you to add or remove the users and groups that have read access to
the Deployment Folder . By default, the local Everyone group is given read access.
Note: Read access is required for users to be able to install and upgrade the deployed
application.

4. Click Add to add additional users or groups, or select a user or group to remove and
click Remove to remove it. If the users and groups presented are acceptable, proceed to
the next step.
If you click Add , the Select Users and Groups dialog is displayed:
Select the Domain or Workspace to find users and groups under from the drop-down
list, then enter a User Group or Name to search for in the field provided, and click
Search . Leave the User or Group Name field empty to locate all available accounts.
Select the user or group to add from the Search Results , then click OK . Repeat as
necessary to configure your Folder Share Permissions .

the installation.

displayed.
7. Click Next .
Note: You do not need to complete the steps under Manually Created Share Steps . Proceed to
the section after the Manually Created Share Steps section.
Manually Created Share Steps

If you selected Skip this step at the How do you want to deploy...? dialog, you must manually
create the share that the deployment will be installed to.

If you are installing the deployment package to a Web server, the Web server must be added to
the Local intranet zone in Microsoft Internet Explorer. Zones are configured in Internet Explorer
by selecting the Security tab of the Internet Options (available from the Tools menu). You
must also Enable the following Security settings:
• Automatic prompting for file downloads
• File download
• Font download
Tip: For complete details on adding and configuring sites in the Local Intranet Zone, see the
Microsoft Internet Explorer help files.
If you are installing the deployment package to a network share, Read access on the shared
folder is required for users to be able to install and upgrade the deployed application. Shared
folder permissions must be set outside of this installation.
If you selected Skip this step at the How do you want to deploy...? dialog, the Web Deployment
URL dialog is displayed:
1. Select Configure Web URL to have the installer create the link to the deployment that
will be sent out to client machines for client installations of the deployed application.
This link is available to be copied at the end of the installation, if one is configured.
Tip: Do not select this option if the deployment Web site has not been configured for external
access.

2. In the field, enter the base URL of your deployment without the application name (for
example, https://web-server/virtual-directory ). The application name is automatically
appended to the URL at the end of the installation.
the installation.

displayed.
5. Click Next .

Service Location and Deployment Configuration

After clicking Next , the Service Location dialog is displayed.
1. Click Add .
2. Enter in the Display Name field the name of the service location.
3. Enter in the Service Path field the full URL to the OnBase application or Web server
service (for example, https://machinename/AppServer/Service.asmx or https://
machinename/AppNet/Service.asmx ).
Note: URLs that use the HTTPS binding must be correctly configured on the server for secure
connections.
4. In the Data Source field, enter the data source name for the appropriate data source.
5. Select Use NT / LDAP Authentication if your system uses Active Directory or LDAP
Authentication.
Note: In order to use Active Directory or LDAP authentication, the database against which
Integration for Microsoft Outlook 2019 runs must also be configured for Active Directory or
LDAP authentication. The installer configures Integration for Microsoft Outlook 2019 to match
the authentication scheme of the database.

6. Select Use ADFS if your system uses AD FS (Active Directory Federation Services)
authentication.
Note: Use ADFS is not the same Active Directory authentication scheme as Use NT/LDAP
Authentication . The Use ADFS option is not available for all modules. If this option is not
displayed, the module you are installing either does not support AD FS or must be manually
configured for AD FS authentication. You cannot enable both Use ADFS and Use NT/LDAP
Authentication . For more information about configuring OnBase to use AD FS, see the Legacy
Authentication Methods module reference guide.
Selecting Use ADFS causes the remainder of the deployment to be run in Advanced
Mode, even if Advanced Mode was not selected initially, because the configuration file
for the module must be updated before signing and finalizing the deployment.
Note: Depending on the module being updated or added, you may be required to complete
information in additional dialogs specific to the module. See the main installation steps above
for information on any additional dialogs or steps that must be completed before signing the
deployment.
Package-Specific Installation Steps

Some of the packages installed using the Hyland Office Products Installer require additional
configuration.
Template Builder
Template Builder has no additional configuration steps to install the deployment package. Go
to Deployment Signing.

Excel Add-In
After configuring the service location, the Modules dialog is displayed:
Note: The options available in this dialog are dependent on the licensing and rights of the user
who logged in to OnBase.
Select the integrations to install, then click Next and complete the steps in the corresponding
sections below.
Office Add-In
Select Office Add-In to install the Office Add-In for Excel deployment package. There are no
additional configuration steps to install the deployment package. Go to Deployment Signing on
page 47.
Note: To install the Office Add-Ins for PowerPoint and Word you must install those deployment
packages separately by selecting them at the Package Selection dialog.
Report Services
The Report Services Excel Add-In has no additional configuration steps to install the
deployment package. Go to Deployment Signing on page 47.

Outlook Integration
After configuring the service location, the Modules dialog is displayed:
Note: The options available in this dialog are dependent on the licensing and rights of the user
who logged in to OnBase.
Select the integrations to install, then click Next and complete the steps in the corresponding
sections below.

Integration for Microsoft Outlook 20XX

1. The Outlook Integration Toolbar Configuration dialog is displayed.
2. Select the options you would like to enable:
Note: Enabling options does not guarantee they are available in Outlook. Options may also
require specific User Group privileges, additional licensing, or both.
Option Description
Button Configuration
Enable Import Button If selected, the Import button is available on the Outlook
Integration toolbar. This function allows users to import
messages directly to OnBase from Outlook.
Enable Launch Client Button If selected, the Launch Client button is available on the
Outlook Integration toolbar. This function allows users
to launch the OnBase Client directly from Outlook.
Enable Retrieval Button If selected, the Retrieval button is available on the

to retrieve documents archived in OnBase directly from
Outlook.

Option Description
Enable Workflow Button If selected, the Workflow button is available on the

to launch the OnBase Workflow Client directly from
Outlook.
Enable Help Button If selected, the Help button is available on the Outlook
Integration toolbar. This provides users access to the
relevant OnBase help files.
Enable Reporting Dashboards Button If selected, the Dashboards button is available on the
to create a new dashboard directly from Outlook.
Enable Create Forms Button If selected, the Create Form button is available on the
to create a new form.
Enable Import From File Button If selected, the Import from File button is available on
the Outlook Integration toolbar. This function allows
users to open the Import from File window.
Enable Imaging Group If selected, the Imaging options are available on the
Outlook Integration toolbar. These options include the
Send to Scan Queue and Batch Processing buttons.
These functions allow you to route messages and
attachments into a Scan Queue or batch scan process.
Enable My Reading Groups Button If selected, the My Reading Groups button is available
on the Outlook Integration toolbar. This function allows
users to open the My Reading Groups interface.
Workflow Options
Update notification when task is Select to update Workflow email notifications after a
executed task is executed, to include specific information on the
ad hoc task that was executed.

3. Click Next . Depending on the options you selected, the Import Button Configuration
dialog box may be displayed.

4. Configure the following options:
Option Description
Mail Message Options
Keep Messages in Same Folder Email messages that are imported into OnBase are kept in
the same Outlook mail folder after being imported. This
option is selected by default when the Enable Import
Button option is selected.
Note: This option does not apply to email messages

imported into OnBase using an Auto Import Folder.
Remove Messages Email messages that are imported into OnBase are deleted
from the email server after being imported.

Move Messages To Email messages are moved to a different Outlook folder

after being imported into OnBase. Enter in the field
provided the folder for imported email messages to be
moved to.

Automatically select all Automatically selects all email attachments when

attachments for import importing email messages into OnBase.
Note: Users can still modify which email attachments are

actually included when importing email messages into
OnBase.
Set Document Date as Sent Date Use the date that an email was sent as the Document Date
for the message when it is imported into OnBase. If this
option is not selected, the date the email message was
imported into OnBase is used as the Document Date.
Note: If this option is selected and an email does not

have a Received Time value, the current date is used.
Storage Options

Option Description
Store messages in MSG Format Selected: Select this option to archive messages in
OnBase in their native Outlook format (*.msg ). When
messages stored in this format are retrieved, they are
displayed in the Outlook message viewer instead of the
OnBase document viewer. However, this allows you to
access all of the same Outlook functionality that is
available when you open a message in Outlook (e.g.,
forwarding a message, replying to a message, etc.).
Note: When this option is selected, users are unable to

view the message that is being imported by clicking the
envelope icon in the Import Mail Document dialog box.
This may prevent messages from being indexed
incorrectly.
Not selected: If this option is not selected, messages are

archived in the format in which the message was created
(e.g., plain or rich text, or HTML). When messages are
retrieved, they are displayed in the OnBase document
viewer. Attachments and messages are stored as separate
documents and are retrieved in their respective file
formats.
Store attachments separately Selected: If Store messages in MSG Format is selected,

select this option to store attachments as separate
Note: This option is only documents from the messages they are attached to.
available if Store messages in Attachments are stored and retrieved in their respective
MSG Format is selected. file formats and the Attachment(s) button is available in
the Import Mail Document dialog box, if the message has
attachments.
Not selected: If Store messages in MSG Format is
selected and this option is not selected, all attachments
are stored in the same *.msg file as the message they are
attached to and the Attachment(s) button is not available
in the Import Mail Document dialog box.
Tip: For a complete discussion of the Outlook Integration import functionality, see one of the
Integration for Microsoft Outlook module reference guides.

5. Click Next . Depending on the options you selected, the Client Executable Button
Configuration dialog may be displayed.
6. Enter the path to the OnBase Client executable in the Executable Path field, or click the
Browse button next to the field to browse to the location of your OnBase Client
executable.
7. Enter in the Executable Command Line Switches field any OnBase command line
switches to append to the OnBase Client when it is launched from Outlook.
Tip: For more information on command line switches, see the Command Line Switches section
in the System Administration module reference guide.

8. Click Next . Depending on the options you selected, the Folder Configuration dialog may
be displayed.
If you created a folder configuration file using the Folder Configuration Utility , enter the
full path to it in the field provided, or click Browse to navigate to the file and select it. If
you did not create a folder configuration file, leave the field empty.

9. Click Next . The Administrative Settings dialog is displayed.
10. Configure the following options:
Option Description
Allow User Toolbar Configuration If selected, users can change the default configuration
of their Outlook Integration toolbar.
Update the Client’s Default Settings If selected, the default settings of this deployment
instance override the settings of clients installed using
an earlier version of this deployment instance. For
example, this option must be selected to overwrite
previously configured command-line switches.
Note: This option is not available if Allow User Toolbar

Configuration is not selected.
Allow User Folder Configuration If selected, users can change the configuration of their
Outlook folders.
11. Go to Deployment Signing on page 47.
WorkView Integration for Outlook

The WorkView Integration has no additional configuration steps to install the deployment
package. Go to Deployment Signing on page 47.

PowerPoint Add-In
There are no additional configuration steps to install the PowerPoint Add-In deployment
packages. Go to Deployment Signing on page 47.
Word Add-In
There are no additional configuration steps to install the Word Add-In deployment packages.
Go to Deployment Signing on page 47.
Deployment Signing
before clicking Next at the Deployment Signing dialog box.
If you are in Advanced Mode, you still have the option to edit files in the deployment folder at
the File Edit Notification dialog box that is displayed after the Deployment Signing dialog box.
If you are not in advanced mode, you must access the files directly by navigating to the
deployment location before signing the deployment.

The Deployment Signing dialog box is displayed.
1. Select the appropriate signing method.

When Sign from Test Certificate is selected, a test certificate with the Common Name
localhost is used. This test certificate is packaged with all ClickOnce installers. For
security purposes, it is strongly recommended that this certificate remain un-trusted.
This does not mean the certificate cannot be used, simply that when users attempt to
launch the ClickOnce link, they are prompted with a message stating that the publisher
could not be verified.
When Sign from Certificate User Store is selected, certificates from the current user
store are listed under this option. If there are any certificates in the current user store,
they can be used for signing here. Only certificates purposed for code signing are valid.
When Sign from File is selected, the deployment is signed using the PFX file entered in
the corresponding field. Only certificates purposed for code signing are valid.
before clicking Next at the Deployment Signing dialog box. If you are not in advanced mode,
you must access the files directly by navigating to the deployment location before clicking Next
and signing the deployment.

2. Click Next . If you are in Advanced Mode , the File Edit Notification dialog box is
displayed.
From this dialog box you can open the deployment folder by clicking Open Deployment
Folder . At this time, any necessary changes to the files in the folder or the contents of
the folder must be made, such as custom changes to the *.config file for the module.
3. If you want to change the language and culture settings of the deployment, you must
click Open Deployment Folder and edit the corresponding *.exe.config or *.dll.config
file before signing the deployment (in other words, before clicking OK ). If these settings
are not changed, the default operating system language and culture settings are used
for the module.
Note: The Template Builder always uses the default operating system language and culture
settings.
To change the language and culture settings:

a. Open the deployment folder and open the corresponding *.exe.config or *.dll.config
file in a plain-text editor, such as Notepad. Do not use a binary-text editor, such as
Word, to edit this file.
b. Locate the <Hyland.Canvas> node.
c. Remove the comment tags (  ) from the <DisplayLanguage> node to enable
it and display the module in a language different from the default operating system
language. If this node remains commented, the default operating system language is
used for the module.
d. Replace the value of the <DisplayLanguage> node with the language name of the
language you want the module displayed in, such as de-DE for German or fr-FR for
French (for more information on language names, see http://msdn.microsoft.com/
en-us/library/ms533052(VS.85).aspx ). The default value of this node is en-US .
e. Remove the comment tags (  ) from the <Culture> node to enable it and
override the default Windows locale settings. If this node remains commented, the
module displays dates, times, currencies, and numeric values using the default
Windows locale settings configured in the Windows Regional and Language Options.
f. Replace the value of the <Culture> node with the culture name of the culture you
want the module to use, such as de-DE for German or fr-FR for French. For a
complete list of supported cultures, see the Web Server documentation. The default
value of this node is en-US .
g. Save and close the file.

4. Click OK on the File Edit Notification dialog box. Upon clicking OK , the folder is signed
and cannot be modified without updating the deployment instance.
5. If you signed the deployment from a file, and the certificate requires a password, you
will be prompted to enter the password for the certificate.
Tip: You can paste the password into the field to ensure accuracy.
6. The application is deployed and the Summary dialog is displayed upon completion.
Clicking the link provided under Success launches the application. This is the same as
the full path that external users must use to install and launch the application.
Click Copy Link To Clipboard to copy this link to the clipboard.
7. Click Finish .
Upon completing these steps, you have installed the Deployment Wizard and installed an
instance. You can add additional instances and access the Deployment Wizard by selecting
Start | All Programs | Hyland | Deployment | Deployment Wizard . You can also update existing
instances in the same way. See the Updating or Adding a Deployment Instance section for more
information.
Additional Installation
After running the Hyland Office Products Deployment installer you must run the separate
Hyland Office Integration Dependencies installer on each workstation before the Office
integration packages are deployed to those workstations. This installer installs the
prerequisites required to use the Office and Outlook integration modules on the client
workstations. These prerequisites are not included in the deployment packages and cannot be
deployed using ClickOnce.
The Hyland Office Integration Dependencies installer installs the following prerequisites on
the workstation:
• dsoframer.ocx
• wiaaut.dll
• Microsoft Visual Studio 2010 Tools for Office Runtime (x86) SP1 package

To run the Hyland Office Integration Dependencies installer, execute setup.exe by double-
clicking on the file name in or using Start | Run . This executable is usually located in the
\install\ClickOnce\Office Products\Dependencies\ folder of your source installation files.
1. Click Next at the Welcome dialog. The Destination Folder dialog is displayed.

2. To change the installation location of the installed components, click Change . The
Change destination folder dialog is displayed.
Enter a Folder name in the field provided or select it from the Look in drop-down list.
If the destination folder is not changed, components are installed to the following
default location: C:\Program Files\Hyland\Office Integration\Dependencies\ .
Note: Under 64-bit systems, use the Program Files (x86) folder.
3. Click Next . The Ready to install dialog is displayed.

4. Click Install .
5. Click Finish after the installation has completed.
Note: The Hyland Office Integration Dependencies installer only installs missing
prerequisites. If a prerequisite is already installed on the workstation it is not installed again by
the Hyland Office Integration Dependencies installer.
Remove Installed Prerequisites

After initial installation, the setup program can be used to remove components from a previous
installation. After launching setup.exe the Change, repair, or remove installation dialog is
displayed. The only option able for the Hyland Office Integration Dependencies installer is
Remove .

Click Remove to remove prerequisites installed by the Hyland Office Integration Dependencies
installer.
Note: The Hyland Office Integration Dependencies installer will only removed installed
prerequisites if they are not being used any other applications.
Controlling the Installer from the Command Line

This section describes the feature and property names that can be applied to the command line
to install and configure components contained in the Hyland Office Integration Dependencies
installer.
Features define the components that are installed. Properties define the configuration settings
for the components that are installed.
The feature and property names for the components in the Hyland Office Integration
Dependencies installer are:
• Feature name: Hyland_Office_Dependencies
• Property name: OFFICEDEPENDENCIES_FILES
Note: Feature and property names are case sensitive and must be added to the command line
exactly as they appear in this manual.
The OFFICEDEPENDENCIES_FILES property is optional and is used to define the location that
the installed components are installed to. If this property is not included the components are
installed to: C:\Program Files\Hyland\Office Integration\Dependencies\ .
Note: Under 64-bit systems, use the Program Files (x86) folder.
To install the components from the command line use the ADDLOCAL property. The
ADDLOCAL property is appended to the end of the install command line, as shown here in the
following example. This example also installs the prerequisites to the C:\MyCustomFolder\
directory:
msiexec /i "Office Integration Dependencies.msi" ADDLOCAL=Hyland_Office_Dependencies
OFFICEDEPENDENCIES_FILES="C:\MyCustomFolder\"
Updating or Adding a Deployment Instance

When a change is necessary for a deployment instance, it can be updated or a new instance
can be created.
To update an existing instance or create a new instance, do not launch the Hyland Office
Products Deployment installer. Instead, select Start | All Programs | Hyland | Deployment |
Deployment Wizard on the deployment server. This launches the Deployment Wizard and the
Welcome to the Deployment Wizard Creation Wizard dialog is displayed.

After launching the Deployment Wizard, see General Installation Options on page 19 and go to
the Welcome to the Deployment Wizard Creation Wizard dialog step, then continue with the
procedure to complete updating or adding an instance. The steps to update or add an instance
are the same as they were when the Hyland Office Products Deployment installer was originally
run, with the exception of how to launch the Deployment Wizard.
Removing a Deployed Application

Deployed applications are installed to both client workstations and the deployment server. This
section describes how to remove a deployed application instance from both the client
workstations and deployment server, or completely removing the deployed application and all
installed instances.
Removing a Deployed Application Instance from Client

Workstations
To remove a deployed application instance from a client workstation:
1. Access the Windows Control Panel by selecting Start | Control Panel on the Windows
desktop.
2. Double click Add or Remove Programs . The Add or Remove Programs dialog is
displayed.
3. Locate the installed application in the list of programs (e.g., Hyland Integration for
Microsoft Outlook 2019 [Instance Name] ).
4. Select the program and click Change/Remove . The deployed application Maintenance
dialog is displayed.
5. Select Remove the application from this computer .
6. Click OK .
The installed application is removed from the workstation.
Note: Removing the application instance from client workstations does not remove the
application instance from the deployment server. Users can re-install a removed application
instance by following the original link to the instance. To completely remove a deployed
application instance, see Removing a Deployed Application Instance from the Deployment
Server or Completely Removing a Deployed Application below.
Removing a Deployed Application Instance from the

Deployment Server
If a deployed application instance is removed from all client workstations, it can be re-installed
by users who follow the link to the deployed application instance, unless the instance is also
removed from the deployment server.

To remove an instance of a deployed application in order to reset the version and/or re-use an
instance name:
1. Access the Windows Registry (enter regedit in the Windows Start | Run dialog). The
Registry Editor dialog is displayed.
Caution: Modify the registry at your own risk. Incorrectly editing the Windows registry can
cause serious problems that may require you to reinstall your operating system. Be sure to
back up the registry before making any changes to it. For more registry information, see the
following Microsoft articles: http://support.microsoft.com/kb/256986 and http://
technet.microsoft.com/en-us/library/cc725612.aspx
2. Expand the following registry key:

HKEY_LOCAL_MACHINE\SOFTWARE\Hyland\Deployment
Under 64-bit systems this key may be located at:
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Hyland\Deployment
3. Expand the subkey that corresponds to the deployed application you want to remove the
instance from (for example, ApplicationEnabler or ReportServices ).
4. Right click the subkey that corresponds to the instance name you want to remove.
5. Select Delete .
6. Click Yes at the confirmation prompt. The deleted instance is no longer available in the
Deployment Wizard.
7. Locate the files for the instance to remove on the deployment server.
The location of the files depends on the location selected during installation. In a
default, 32-bit installation, the files are located at C:\Program
Files\Hyland\[ApplicationName]\[InstanceName]\ (for example, C:\Program
Files\Hyland\ApplicationEnabler\MyAppEnablerInstance\ ).
8. Delete all of the files and folders contained in the instance folder, or delete the entire
instance folder. The application is no longer available for installation.
Caution: Take care to delete only the folder for the instance you are removing. Deleting the
application folder will remove all instances of the deployed application.
Note: If the instance files are not removed from the deployment server, the application
instance can still be installed by users who follow the link to the deployed application.
9. Follow the steps above to remove the installed instance from all client workstations
(see, Removing a Deployed Application Instance from Client Workstations).
Note: Until the instance is removed from client workstations, the application instance can still
be used by client workstations, even if it is removed from the deployment server.

Completely Removing a Deployed Application

To completely remove a deployed application:
1. Follow the steps above to remove all instances of the deployed application from the
deployment server (see, Removing a Deployed Application Instance from the
Deployment Server).
2. Access the Windows Control Panel by selecting Start | Control Panel on the Windows
desktop.
3. Double click Add or Remove Programs . The Add or Remove Programs dialog is
displayed.
4. Locate the installed application in the list of programs (e.g., Hyland Integration for
Microsoft Outlook 2019 or Hyland Integration for Microsoft Outlook 2019
Deployment ).
5. Select the application and click Change/Remove . The application and deployment
package is removed.
Note: Removing the last deployed application from the deployment server also removes the
Deployment Wizard from the deployment server.
6. Follow the steps above to remove all instances of the deployed application from all
client workstations (see, Removing a Deployed Application Instance from Client
Workstations).
Note: Until all instances of the application are removed from client workstations, the
application can still be used by client workstations, even if it is removed from the deployment
server.
Installation Using the Standard (MSI) Installer

The Hyland Office 20XX Integration installers are used to install the selected modules to the
workstation on which it is run (see Overview on page 11).
The Hyland Office Integration installers can be run from an installation CD or a local drive.
Note: You must be appropriately licensed for all modules and functionality installed. You can
install, but cannot use, modules for which you are not licensed.
Overview


methodology.

options.
Tip: For complete details on running the installer from the command line, see Controlling the
Installer from the Command Line on page 75.
Hyland Office 2016/2019 Integration Installers

The Hyland Office integration installers can install multiple Microsoft Office modules
depending on your Microsoft Office configuration. Each version of Microsoft Office has its own
integration installer.
See the following sections for information on the integration installer modules and instructions
on running the integration installer:
• Hyland Office 2016 Integration Installer Modules on page 59
• Hyland Office 2019 Integration Installer Modules on page 59
• Installing the Hyland Office 2016/2019 Integration on page 60

Hyland Office 2016 Integration Installer Modules

The Hyland Office 2016 Integration installers are used to install the 32- or 64-bit version of the
following modules:
Component Module
Word 2016 Add-In Installs the Office Add-In for Microsoft Word
2016 .
PowerPoint 2016 Add-In Installs the Office Add-In for Microsoft

PowerPoint 2016 .
Excel 2016 Add-In | Office Add-In Installs the Office Add-In for Microsoft Excel
2016 .
Excel Report Services Add-In Installs the Report Services Excel Add-In for
Microsoft Excel 2016 .
Outlook 2016 Integration | Outlook Installs the Integration for Microsoft Outlook
Integration 2016 .
WorkView Integration for Outlook Installs the WorkView Integration for Microsoft
Outlook 2016.
Template Builder 2016 Installs Template Builder 2016 , which is the

Document Composition configuration component.
Hyland Office 2019 Integration Installer Modules

The Hyland Office 2019 Integration installers are used to install the 32- or 64-bit version of the
following modules:
Component Module
Word 2019 Add-In Installs the Office Add-In for Microsoft Word
2019 .
PowerPoint 2019 Add-In Installs the Office Add-In for Microsoft

PowerPoint 2019 .
Excel 2019 Add-In | Office Add-In Installs the Office Add-In for Microsoft Excel
2019 .
Excel Report Services Add-In Installs the Report Services Excel Add-In for
Microsoft Excel 2019 .
Outlook 2019 Integration | Outlook Installs the Integration for Microsoft Outlook
Integration 2019 .

Component Module
WorkView Integration for Outlook Installs the WorkView Integration for Microsoft
Outlook 2019 .
Template Builder 2019 Installs Template Builder 2019 , which is the

Document Composition configuration component.
Installing the Hyland Office 2016/2019 Integration

To run the Hyland Office 2016/2019 Integration installer:
1. Execute setup.exe with administrator privileges. This can be done by right-clicking on
the file name and selecting Run as administrator . The welcome page is displayed.
This executable is usually located in the folder of your source installation files that
corresponds to the version of the integration you are installing.
Note: If the installer is copied from the source location to be run from a different location, the
entire folder and its contents must be copied to the new location.
The following are the default folder locations for the 32-bit and 64-bit executable files,
where XX is the year of the integration:
• Integration for Microsoft Office 20XX (32-bit): \Office Integration\Office 20XX
• Integration for Microsoft Office 20XX (64-bit): \x64\Office Integration\Office 20XX
Note: You must use the installer that matches your version of Microsoft Office. For example, if
you have a 64-bit version of Microsoft Office, then the 64-bit Hyland Office Products Installer
must be used.

2. Click Next . The Custom Setup page is displayed.
Note: The screen shots used in the following sections are for illustrative purposes only and
reflect the Hyland Office 2016 Integration installer. The versions of the add-ins and the
components available to install will match the version of the installer you launched.
3. Click the drop-down list beside the name of a component to display the installation
options:
Option Description
Will be installed on local hard Installs the selected feature and does not install any
drive dependent, optional functionality. To view optional
functionality, click the + icon next to the feature to expand the
sub-feature list.
Entire feature will be installed Installs the selected feature and any dependent functionality.
on local hard drive To view the dependent functionality, click the + icon next to
the feature to expand the sub-feature list.

Option Description
Entire feature will be Select this option to remove a feature from the list of features
unavailable to install.
4. Select Will be installed on local hard drive for each component you want to install.
To install all components, select Entire feature will be installed on local hard drive
from the drop-down list beside Office 20XX Add-In .
5. To determine the amount of space available for installation of the selected
components, click Disk Usage . The Disk Space Requirements dialog box is displayed,
with information on the space required for the selected components and the space
available on the drives accessible by the installation workstation.

6. To change the installation location of the installed components, select Office 20XX
Add-In and click Browse . The Change destination folder page is displayed.
Enter the name of the destination folder in the Folder name field or select it from the
Look in drop-down list.
If the destination folder is not changed, components are installed to the following
default locations:
• Office 20XX (32-bit): C:\Program Files\Hyland\Office Integration\Office 20XX\
• Office 20XX (64-bit): C:\Program Files (x86)\Hyland\Office Integration\Office
20XX\
Note: In these example default locations, XX designates the year of the integration you have
installed.
7. Click OK .

8. From the Custom Setup page, click Next . The IdP Server URL page is displayed.
9. Select Enable IdP Support if your system uses the Hyland Identity Provider (IdP) server
for authentication, then enter the URL to the endpoint of the Hyland IdP server with the
tenant in the IdP URL field. This value is case sensitive.
For example, if the Hyland IdP server is at my.domain/identityprovider , the tenant name
is MyTenant , and the environment is configured for secure connections, then the value
is https://my.domain/identityprovider/MyTenant .
Note: Enabling IdP support in the installer does not work if your environment is not already
configured for IdP. Additional configuration is required to enable IdP support for the Hyland
Office Products Installers. For more information, see the Identity and Access Management
Services module reference guide.

10. Click Next . The Service Location page is displayed.
11. In the Display Name field, enter the name of the service location. This should be a user
friendly name for the service location.
12. In the Service Path field, enter the full URL to the OnBase Application Server service
page or Web Server address.
An Application Server URL should use the following format: http://machinename/
AppServer/Service.asmx
A Web Server URL should use the following format: http://machinename/AppNet/
Service.asmx
Note: Only Application Server and Web Server URLs ending in .asmx and using SOAP can be
used with the Office integrations. For example, a remote service path ending in .rem is not
valid.
13. In the Data Source field, enter the data source name for the appropriate data source.
14. From the Use NT / LDAP Authentication drop-down list, select one of the following
options:
• Select Yes if your system uses NT or LDAP Authentication to use NT/LDAP with the
components installed
Note: To use NT or LDAP authentication, the Data Source entered must also be configured for
NT or LDAP authentication.
• Select No if your system does not use NT or LDAP Authentication

15. Click Next . If you are installing the Outlook or WorkView integrations, the Outlook
Integration Toolbar Configuration page is displayed.
16. Select Yes to enable an option of the integration or No to disable the option.
Note: Enabling options does not guarantee they are available in Outlook. Options may also
require specific User Group privileges, additional licensing, or both.
The following are the available button configurations:
Option Description
Enable Import Button If selected, the Import button is available on the

integration with OnBase ribbon. This function allows
users to import messages directly to OnBase from
Outlook.
Enable Launch Client Button If selected, the Launch Client button is available on the
users to launch the OnBase Client directly from Outlook.
Enable Retrieval Button If selected, the Retrieval button is available on the

users to retrieve documents archived in OnBase directly
from Outlook.

Option Description
Enable Workflow Button If selected, the Workflow button is available on the

users to launch a Workflow client directly from Outlook.
Enable Help Button If selected, the Help button is available on the

users access to the relevant OnBase help files.
Enable Create Forms Button If selected, the Forms button is available on the
users to create E-Forms or Unity Forms from Outlook.
Enable Import From File Button If selected, the Import from File button is available on
the integration with OnBase ribbon. This function allows
users to import selected documents to OnBase.
Enable Imaging Group If selected, the Imaging options are available on the
integration with OnBase ribbon. These options include
the Send to Scan Queue and Batch Processing
buttons. These functions allow users to route messages
and attachments into a scan queue or batch scan
process.
Enable My Reading Groups Button If selected, the My Reading Groups button is available
on the integration with OnBase ribbon. This function
allows users to open the My Reading Groups interface.

17. Click Next to continue configuring Outlook or WorkView integration options.
18. Select Yes to enable an option of the integration or No to disable the option. The
following configuration options are available:
Admin Configuration Description

Option
Allow User Toolbar If selected, users can change the default configuration of their
Configuration integration with OnBase ribbon.
Update the Client’s If selected, the default settings of this deployment instance override
Default Settings the settings of clients installed using an earlier version of this
deployment instance.
Note: This option is not available if Allow User Toolbar

Configuration is not selected.
Allow User Folder If selected, users can change the configuration of their Outlook folders.
Configuration

Workflow Configuration Description

Option
Update Notification when Select to update Workflow email notifications after a task is executed.
Task is Executed When selected, email notifications include specific information on the
ad hoc task that was executed.
19. Click Next . Depending on the options you selected on the Outlook Integration Toolbar
Configuration page, the Import Button Configuration page may be displayed.

20. Select Yes to enable an option of the integration or No to disable the option. The
following options are available:
Button Configuration Option Description
Keep Messages in Same Folder If Yes is selected, email messages that are imported
into OnBase are kept in the same Outlook mail folder
after being imported. This option is selected by default
when the Enable Import Button option is selected.

Remove Messages If Yes is selected, email messages that are imported

into OnBase are deleted from the email server after
being imported.

Move Messages To If Yes is selected, email messages are moved to a

different Outlook folder after being imported into
OnBase.
In the field provided, enter the folder to move the
imported email messages to.

Automatically select attachments for If Yes is selected, all email attachments are
import automatically selected when importing email messages
into OnBase.
Note: Users can still modify which email attachments

are actually included when importing email messages
into OnBase. See the sections on importing attachments
in the Integration for Microsoft Outlook module
reference guide.
Set Document Date as Sent Date If Yes is selected, the date that an email was sent is
used as the Document Date for the message when it is
imported into OnBase. If this option is not selected, the
date the email message was imported into OnBase is
used as the Document Date.
Note: If this option is selected and an email does not

have a Received Time value, the current date is used.

Storage Option Description
Store messages in MSG Format If Yes is selected, messages are archived in OnBase in
their native Outlook format (*.msg ). When messages
stored in this format are retrieved, they are displayed in
the Outlook message viewer instead of the OnBase
document viewer. This allows you to access all of the
same Outlook functionality that is available when you
open a message in Outlook. For example, forwarding a
message, replying to a message, etc.
If No is selected, messages are archived in the format in
which the message was created (for example, plain or
rich text, or HTML). When messages are retrieved, they
are displayed in the OnBase document viewer.
Attachments and messages are stored as separate
documents and are retrieved in their respective file
formats.
Store attachments separately

Note: This option is only available if Store messages in
MSG Format is selected.
If Yes is selected, email attachments are stored as

separate documents from the messages they are
attached to. Attachments are stored and retrieved in
their respective file formats and the Attachment button
is available in the Import Document dialog box, if the
message has attachments.
If Yes is selected for the Store messages in MSG

Format option and No is selected for the Store
attachments separately option, all attachments are
stored in the same *.msg file as the message they are
attached to and the Attachment button is not available in
the Import Document dialog box.
Tip: For a complete description of the Outlook Integration import functionality, see the Usage
chapter in one of the Integration for Microsoft Outlook module reference guides.

21. Click Next . Depending on the options you selected on the Outlook Integration Toolbar
Configuration page, the Client Executable Button Configuration page may be
displayed.
22. Enter the path to the OnBase Client executable in the Executable Path field, or click the
Browse button next to the field to browse to the location of your OnBase Client
executable.
23. Enter any OnBase command line switches to append to the OnBase Client when it is
launched from Outlook in the Executable Command Line Switches field.
Tip: For more information on command line switches, see the Command Line Switches module
reference guide.

24. Click Next . The Folder Configuration (Optional) page is displayed.
25. If you created a folder configuration file using the Folder Configuration Utility, enter the
full path to it in the Folder Configuration File field, or click Change to navigate to the file
and select it. If you did not create a folder configuration file, leave the Folder
Configuration File field empty.
Note: See Outlook Folder Configuration Utility on page 61 for details on using the Folder
Configuration Utility.
26. Click Next . The Ready to install page is displayed.

27. Click Install .
Changing the Language and Culture Settings

If you want to change the language and culture settings of the modules installed, you must edit
the corresponding *.exe.config or *.dll.config file in the installation location of the module. If
these settings are not changed, the default operating system language and culture settings are
Note: Template Builder always uses the default operating system language and culture
settings.

To change the language and culture settings:

1. Locate the installation location of the module and open the corresponding *.exe.config
or *.dll.config file in a plain-text editor, such as Notepad. Do not use a binary-text editor,
such as Word, to edit this file.
2. Locate the <Hyland.Canvas> node.
3. Remove the comment tags (  ) from the <DisplayLanguage> node to enable it
and display the module in a language different from the default operating system
language. If this node remains commented, the default operating system language is
4. Replace the value of the <DisplayLanguage> node with the language name of the
language you want the module displayed in, such as de-DE for German or fr-FR for
French (for more information on language names, see http://msdn.microsoft.com/en-
us/library/ms533052(VS.85).aspx ). The default value of this node is en-US .
5. Remove the comment tags (  ) from the <Culture> node to enable it and
override the default Windows locale settings. If this node remains commented, the
module displays dates, times, currencies, and numeric values using the default
Windows locale settings configured in the Windows Regional and Language Options.
6. Replace the value of the <Culture> node with the culture name of the culture you want
the module to use, such as de-DE for German or fr-FR for French. For a complete list of
supported cultures, see the Web Server documentation. The default value of this node
is en-US .
7. Save and close the file.
Change, Repair, or Remove an Installation

After initial installation, the setup program can be used to change, repair, or remove
components from a previous installation. After launching setup.exe or the *.msi installation
package, and clicking Next at the welcome dialog, the Change, repair, or remove installation
dialog box is displayed.
Select the option for the actions you wish to perform:
Option Description
Change Add or remove components using the Custom Setup dialog.
Note: This option is not available if the installer has no independently

selectable features.
The steps for adding selected components are the same as those under the
Component Selection section of the installation instructions, if applicable to
the installer.
Note: Change does not allow you to alter configuration options originally set
during a previous installation of components contained in the installer.

Option Description
Repair Repair errors in the most recent installation of the component, such as
missing and corrupt files, shortcuts, and registry entries.
Note: This option is not available from all installers. Repair does not include
errors made in the configuration options set by the user during installation.
For specific troubleshooting information regarding an installed component,
see the module reference guide for that component.
Remove Removes all previously installed components.
Controlling the Installer from the Command Line

The Hyland Office Integration installers can be run from an installation CD or a local drive.



methodology.
options.

Feature and Property Names

The following sections describe the feature and property names that can be applied to the
command line to install and configure components contained in the Hyland Office Integration
installers.
Features define the components that are installed. Properties define the configuration settings
for the components that are installed.
Note: Property values passed through the command line are case-sensitive. For example, a
property value is listed as true in one of the following sections. To use this property value,
ensure you enter true with all lowercase letters.
Note: Due to customizable installation settings, command line scripts vary greatly and depend
upon system configuration. Many command line properties have dependencies upon other
properties, which, when absent from the script, may cause the installation to fail. For this
reason, sample scripts are not included in these instructions. For assistance with creating a
personalized command line script, contact your first line of support.
Feature Names
You can control the installation of components from the command line using the ADDLOCAL
property. To install a component, pass its feature name to the installer using the ADDLOCAL
property. The table below lists the feature names for each component in the Hyland Office
Integration installers.
The ADDLOCAL property is appended to the end of the install command line, as shown here for
the Office 2016 Integration installer: msiexec /i "Office 2016 Integration x86.msi"
ADDLOCAL=Word_AddIn, Excel_OfficeAddIn_Module
This example installs the Microsoft Word and Excel add-ins. It also installs any components
required by the features selected.
Note: Feature names are case sensitive and must be added to the command line exactly as
they appear in this table. The associated properties listed may also have to be included on the
command line in order to configure the installed component. For details on the associated
properties see, Property Names on page 79.
Component Feature Name
Word 20XX Add-In Word_AddIn
PowerPoint 20XX Add-In Powerpoint_AddIn
Excel 20XX Add-In Excel_OfficeAddIn_Module
Excel Report Services Add-In Excel_ReportServices_Module

Component Feature Name
Outlook 20XX Integration Outlook_Integration_Module
WorkView Integration for Outlook Outlook_WorkviewIntegration_Module
Template Builder 20XX Template_Builder
Installation Directory
All components are installed to the same directory. The following default locations are used:
• Office 20XX (32-bit) : C:\Program Files\Hyland\Office Integration\Office 20XX\
• Office 20XX (64-bit) : C:\Program Files (x86)\Hyland Office Integration\Office 20XX\
Note: In these example default locations, XX designates the year of the integration you have
installed.
The default locations can be changed by using the following properties:

• Office 2016 (32- or 64-bit): OFFICE2016_FILES
• Office 2019 (32- or 64-bit): OFFICE2019_FILES
For example, to change the default location of the Office 2016 files, add the following to the
command line: OFFICE2016_FILES="C:\MyInstall\Office2016\"
Associated Properties
The following properties are associated with all of the features:
• SERVICE_LOCATION_DATA_SOURCE
• SERVICE_LOCATION_DISPLAY_NAME
• SERVICE_LOCATION_NT_AUTH
• SERVICE_LOCATION_SERVICE_PATH
• SERVICE_LOCATION_IDP_PATH_201X (where X designates the year of the
integration installed)
Note: Additional configuration is required to enable IdP support for the Hyland Office Products
Installers. For more information, see the Identity and Access Management Services module
reference guide.
Outlook Integration Associated Properties

The following properties are associated with the Outlook Integration and WorkView
Integration for Outlook features:
• OUTLOOKINTEGRATION_ADMIN_CONFIGURATION_FILE
• OUTLOOKINTEGRATION_AUTO_SELECT_ATTACHMENTS
• OUTLOOKINTEGRATION_CLIENT_EXE_FILE_PATH
• OUTLOOKINTEGRATION_CREATE_FORMS

• OUTLOOKINTEGRATION_DOCUMENT_DATE_SENT_DATE
• OUTLOOKINTEGRATION_ENABLE_UPLOAD_FROM_FILE
• OUTLOOKINTEGRATION_EXE_COMMANDLINE_SWITCHES
• OUTLOOKINTEGRATION_HELP_BUTTON_OPTION
• OUTLOOKINTEGRATION_IMPORT_BUTTON_OPTION
• OUTLOOKINTEGRATION_KEEP_MESSAGES
• OUTLOOKINTEGRATION_LAUNCH_CLIENT_OPTION
• OUTLOOKINTEGRATION_MOVE_MESSAGES
• OUTLOOKINTEGRATION_MOVE_MESSAGE_LOCATION
• OUTLOOKINTEGRATION_READING_GROUPS_BUTTON
• OUTLOOKINTEGRATION_REMOVE_MESSAGES
• OUTLOOKINTEGRATION_RETRIEVAL_BUTTON_OPTION
• OUTLOOKINTEGRATION_SHOW_IMAGING
• OUTLOOKINTEGRATION_STORE_MESSAGE_MSG
• OUTLOOKINTEGRATION_STORE_MESSAGE_SEPARATELY
• OUTLOOKINTEGRATION_UPDATE_CLIENT_DEFAULT_OPTION
• OUTLOOKINTEGRATION_USER_FOLDER_CONFIGURATION_OPTION
• OUTLOOKINTEGRATION_USER_TOOLBAR_CONFIGURATION_OPTION
• OUTLOOKINTEGRATION_WORKFLOW_BUTTON_OPTION
• OUTLOOKINTEGRATION_WORKFLOW_UPDATE_NOTIFICATION
Property Names
When controlling the installation of components from the command line you must also
configure the settings for each component you are installing by using the properties listed in
the following sections. The sections below list the property names available and the
corresponding features that use them.
SERVICE_LOCATION_DATA_SOURCE
The data source name for the appropriate data source.
For example: SERVICE_LOCATION_DATA_SOURCE="Data Source Name"
Required when adding:
• Word_AddIn
• Powerpoint_AddIn
• Excel_OfficeAddIn_Module
• Excel_ReportServices_Module
• Outlook_Integration_Module
• Outlook_WorkviewIntegration_Module
• Template_Builder
SERVICE_LOCATION_DISPLAY_NAME
The user friendly name of the service location.

For example: SERVICE_LOCATION_DISPLAY_NAME="My Service Location"

• Word_AddIn
SERVICE_LOCATION_NT_AUTH
Set to true to use NT/LDAP with the components installed. If this property is not included the
default value of false is set and NT/LDAP authentication is not used.
Note: In order to use NT or LDAP authentication, the Data Source configured must also be
configured for NT or LDAP authentication.
For example: SERVICE_LOCATION_NT_AUTH="true"

Optional when adding:
• Word_AddIn
SERVICE_LOCATION_SERVICE_PATH
The full URL to the OnBase Application Server service page or Web Server address.
An Application Server URL should use the following format: http://machinename/AppServer/
Service.asmx
A Web Server URL should use the following format: http://machinename/AppNet/
Service.asmx
Note: Only Application Server and Web Server URLs ending in .asmx and using SOAP can be
used with the Office integrations. For example, a remote service path ending in .rem is not
valid.

• Word_AddIn

OUTLOOKINTEGRATION_ADMIN_CONFIGURATION_FILE
The full path to the folder configuration file created using the Folder Configuration Utility .
For example:
OUTLOOKINTEGRATION_ADMIN_CONFIGURATION_FILE="C:\MyFiles\MyOutlook.confg"
If you did not create a folder configuration file, do not include this property.
Note: See Outlook Folder Configuration Utility on page 61 for details on using the Folder
Configuration Utility.
OUTLOOKINTEGRATION_CREATE_FORMS
Set to true to make the Forms button available on the Outlook Integration toolbar. This function
allows users to create E-Forms or Unity Forms from Outlook. If this property is not included, the
default value of false is set and the users cannot create E-Forms or Unity Forms from Outlook.
OUTLOOKINTEGRATION_ENABLE_UPLOAD_FROM_FILE
Set to true to make the Import from File button available on the Outlook Integration toolbar.
This function allows users to import selected documents into OnBase. If this property is not
included, the default value of false is set and users cannot import selected documents to
OnBase from Outlook.
OUTLOOKINTEGRATION_HELP_BUTTON_OPTION
Set to true to make the Help button available on the Outlook Integration toolbar. This function
provides users access to the relevant OnBase help files. If this property is not included the
default value of false is set and the help files are not available to users from the Outlook
Integration toolbar.
For example: OUTLOOKINTEGRATION_HELP_BUTTON_OPTION="true"
OUTLOOKINTEGRATION_IMPORT_BUTTON_OPTION
Set to true to make the Import button available on the Outlook Integration toolbar. This
function allows users to import messages directly to OnBase from Outlook. If this property is
not included the default value of false is set and users cannot directly import email messages
to OnBase from Outlook.

For example: OUTLOOKINTEGRATION_IMPORT_BUTTON_OPTION="true"

If this property is set to true one of the following related properties must also be set to true :
• OUTLOOKINTEGRATION_KEEP_MESSAGES
• OUTLOOKINTEGRATION_REMOVE_MESSAGES
If this property is set to true the following related properties are optional:
• OUTLOOKINTEGRATION_AUTO_SELECT_ATTACHMENTS
• OUTLOOKINTEGRATION_DOCUMENT_DATE_SENT_DATE
OUTLOOKINTEGRATION_LAUNCH_CLIENT_OPTION
Set to true to make the Launch Client button is available on the Outlook Integration toolbar.
This function allows users to launch the OnBase Client directly from Outlook. If this property is
not included the default value of false is set and users cannot launch the OnBase Client directly
from Outlook.
For example: OUTLOOKINTEGRATION_LAUNCH_CLIENT_OPTION="true"
If this property is set to true the following related property is required:
• OUTLOOKINTEGRATION_CLIENT_EXE_FILE_PATH
If this property is set to true the following related property is optional:
• OUTLOOKINTEGRATION_EXE_COMMANDLINE_SWITCHES
OUTLOOKINTEGRATION_READING_GROUPS_BUTTON
Set to true to make the My Reading Groups button available on the Outlook Integration toolbar.
This function allows users to open the My Reading Groups interface. This property is not
included, the default value of false is set and users cannot display the My Reading Groups
interface from Outlook.
OUTLOOKINTEGRATION_RETRIEVAL_BUTTON_OPTION
Set to true to make the Retrieval button available on the Outlook Integration toolbar. This
function allows users to retrieve documents archived in OnBase directly from Outlook. If this
property is not included the default value of false is set and users cannot retrieve documents
archived in OnBase directly from Outlook.
For example: OUTLOOKINTEGRATION_RETRIEVAL_BUTTON_OPTION="true"


OUTLOOKINTEGRATION_SHOW_IMAGING
Set to true to make the Imaging ribbon group, which includes the Send to Scan Queue and
Batch Processing buttons, available on the Outlook Integration toolbar. These functions allow
users to route messages and attachments into a scan queue or batch process. If this property
is not included, the default value of false is set and users cannot access these functions from
Outlook.
OUTLOOKINTEGRATION_WORKFLOW_BUTTON_OPTION
Set to true to make the Workflow button available on the Outlook Integration toolbar. This
function allows users to launch the OnBase Workflow Client directly from Outlook. If this
property is not included the default value of false is set and users cannot launch the OnBase
Workflow Client directly from Outlook.
For example: OUTLOOKINTEGRATION_WORKFLOW_BUTTON_OPTION="true"
OUTLOOKINTEGRATION_WORKFLOW_UPDATE_NOTIFICATION
Set to true to update Workflow email notifications after a task is executed, to include specific
information on the ad hoc task that was executed. If this property is not included the default
value of false is set and Workflow email notifications are not updated.
For example: OUTLOOKINTEGRATION_WORKFLOW_UPDATE_NOTIFICATION="true"
OUTLOOKINTEGRATION_UPDATE_CLIENT_DEFAULT_OPTION
If set to true , the default settings of this deployment instance override the settings of clients
installed using an earlier version of this deployment instance. For example, this option must be
set to true to overwrite previously configured command-line switches. If this property is not
included the default value of false is set and the settings of clients using an earlier version of
the deployment instance can be used.
For example: OUTLOOKINTEGRATION_UPDATE_CLIENT_DEFAULT_OPTION="true"
If this property is set to true the following related property must also be set to true :
• OUTLOOKINTEGRATION_USER_TOOLBAR_CONFIGURATION_OPTION

OUTLOOKINTEGRATION_USER_FOLDER_CONFIGURATION_OPTION
Set to true to allow users to change the configuration of their Outlook folders. If this property is
not included the default value of false is set and users cannot change the configuration of their
Outlook folders.
For example: OUTLOOKINTEGRATION_USER_FOLDER_CONFIGURATION_OPTION= "true"
OUTLOOKINTEGRATION_USER_TOOLBAR_CONFIGURATION_OPTION
Set to true to allow users to change the default configuration of the Outlook Integration
toolbar. If this property is not included the default value of false is set and users cannot change
the default configuration of the Outlook Integration toolbar.
For example: OUTLOOKINTEGRATION_USER_TOOLBAR_CONFIGURATION_OPTION= "true"
OUTLOOKINTEGRATION_AUTO_SELECT_ATTACHMENTS
Set to true to automatically select all email attachments when importing email messages into
OnBase. If this property is not included the default value of false is set and email attachments
are not automatically selected when importing email messages into OnBase.
Note: With either setting, users can still modify which email attachments are actually included
before the message is imported into OnBase.
For example: OUTLOOKINTEGRATION_AUTO_SELECT_ATTACHMENTS="true"

Expected when the following property is set to true :
OUTLOOKINTEGRATION_DOCUMENT_DATE_SENT_DATE
Set to true to use the date that an email was sent as the Document Date for the message when
it is imported into OnBase. If this property is not included the default value of false is set and
the date the email message was imported into OnBase is used as the Document Date .
Note: If this property is set to true and an email does not have a Received Time value, the
current date is used.
For example: OUTLOOKINTEGRATION_DOCUMENT_DATE_SENT_DATE="true"


Expected when the following property is set to true :
OUTLOOKINTEGRATION_KEEP_MESSAGES
Set to true to keep email messages that are imported into OnBase in the same Outlook folder
after being imported.
If this property is not included the default value of false is set and either
OUTLOOKINTEGRATION_MOVE_MESSAGES or OUTLOOKINTEGRATION_REMOVE_MESSAGES
must be set to true .
Note: This setting does not apply to email messages imported into OnBase using an Auto
Import Folder.
For example: OUTLOOKINTEGRATION_KEEP_MESSAGES="true"

Required when the following property is set to true :
OUTLOOKINTEGRATION_MOVE_MESSAGES
Set to true to move email messages that are imported into OnBase to a different Outlook folder
after being imported.
OUTLOOKINTEGRATION_KEEP_MESSAGES or OUTLOOKINTEGRATION_REMOVE_MESSAGES
Import Folder.
For example: OUTLOOKINTEGRATION_MOVE_MESSAGES="true"


OUTLOOKINTEGRATION_MOVE_MESSAGE_LOCATION
The Outlook folder to move imported email messages to if
OUTLOOKINTEGRATION_MOVE_MESSAGES is set to true .
Import Folder.
For example: OUTLOOKINTEGRATION_MOVE_MESSAGE_LOCATION="Imported Messages"

OUTLOOKINTEGRATION_REMOVE_MESSAGES
Set to true to delete email messages after they are imported into OnBase.
OUTLOOKINTEGRATION_KEEP_MESSAGES or OUTLOOKINTEGRATION_MOVE_MESSAGES
Import Folder.
For example: OUTLOOKINTEGRATION_REMOVE_MESSAGES="true"

OUTLOOKINTEGRATION_STORE_MESSAGE_MSG
Set to true to archive messages in OnBase in their native Outlook format (*.msg). When
messages stored in this format are retrieved, they are displayed in the Outlook message viewer
instead of the OnBase document viewer. However, this allows users to access all of the same
Outlook functionality that is available when the message is opened in Outlook (e.g., forwarding,
replying, etc.).

Set to false to archive messages in the format in which the message was created (e.g., plain
text, rich text, or HTML). When messages are retrieved, they are displayed in the OnBase
document viewer. Attachments and messages are stored as separate documents and are
retrieved in their respective file formats.
Note: When this option is set to true , users are unable to view the message that is being
imported by clicking the envelope icon in the Import Mail Document dialog box. This may
prevent messages from being indexed incorrectly.
For example: OUTLOOKINTEGRATION_STORE_MESSAGE_MSG="true"

OUTLOOKINTEGRATION_STORE_MESSAGE_SEPARATELY
Set to true to store attachments as separate documents from the messages they are attached
to when OUTLOOKINTEGRATION_STORE_MESSAGE_MSG is also set to true . Attachments are
stored and retrieved in their respective file formats and the Attachment(s) button is available in
the Import Mail Document dialog box, if the message has attachments.
Set to false to store all attachments in the same *.msg file as the message they are attached to
when OUTLOOKINTEGRATION_STORE_MESSAGE_MSG is also set to true . The Attachment(s)
button is not available in the Import Mail Document dialog box.
Note: This property does not need to be set if

OUTLOOKINTEGRATION_STORE_MESSAGE_MSG is set to false . If this property is not included
it is set to the default value of false .
For example: OUTLOOKINTEGRATION_STORE_MESSAGE_SEPARATELY="false"

Optional when the following related property is set to true :
OUTLOOKINTEGRATION_CLIENT_EXE_FILE_PATH
The full path to the OnBase Client executable.
For example: OUTLOOKINTEGRATION_CLIENT_EXE_FILE_PATH="C:\Program
Files\Hyland\Client\"


Required when the following related property is set to true :
OUTLOOKINTEGRATION_EXE_COMMANDLINE_SWITCHES
Any OnBase command line switches to append to the OnBase Client when it is launched from
Outlook.
Tip: For more information on command line switches, see the Command Line Switches section
in the System Administration module reference guide.
For example: OUTLOOKINTEGRATION_EXE_COMMANDLINE_SWITCHES="-SCHED"

Optional when the following related property is set to true :

O FFICE I NTEGRATION FEATURE M ATRIX
The Office Integration Feature Matrix lists options and features available through the following OnBase modules:
• Integration for Microsoft Outlook 2016 and 2019
• Office Business Application for 2016 and 2019
The features that are available through these OnBase modules are identical to the features available through the OnBase Unity Client.
Note: The Firefox web browser is not supported to open documents into the Office Business Application modules from DocPop links.
Feature Integration for Microsoft Outlook 2016/ Office Business Application for 2016/2019
2019
Import native files (emails, attachments, X X

Office documents)
Drag/Drop Import X
(via Outlook folder)
Import from File System X X

(Browse to File or Ad Hoc Scanning)
Attach from OnBase X
Custom Queries X X
Document Retrieval X X
File Cabinets X

Office Integration Feature Matrix
2019
Envelopes X X
Retrieve by Document Handle X X
Open the OnBase Client or Unity Client X
Open the Unity Workflow interface X X
Execute Workflow tasks without opening X X

the Unity Workflow interface
Open WorkView X
Create a New E-Form X X
Create a New Unity Form X X
Add/Modify Keywords X X
Add/View Notes X X
View/Open Cross-References X X
Document-level Discussions X X
(Collaboration)
Revisions/Renditions X X
Document History X X
Document Properties X X
Re-Index X X

Office Integration Feature Matrix
2019
External Email X X
Create new documents based on document X

templates
User Options X X

Administration Guide
Foundation EP4
C ONFIGURATION
Configuration
When configuring Document Types and Keyword Types for Integration for Microsoft Outlook
2019, carefully consider the information in the following sections.
Document Types
Documents are automatically imported into the Document Type assigned to the Outlook folder.
The default file format of the Document Type can be changed if OnBase can recognize the
extension of the document and assign it to the corresponding file format. Only when OnBase
cannot dynamically assign the file format is when the Document Type default file format is
used.
You can also set up more than one Outlook folder with different Keyword Types to import into
the same Document Type.
Keyword Types
System Keyword Types are already configured to pull specific values into the Keyword Type.
Once System Keyword Types are assigned to a folder, they do not need any further
configuration to automatically index email messages upon import. For more information on
System Keyword Types, see System Keyword Types on page 94.
You can map non-System Keyword Types to any Outlook field.

Configuration
System Keyword Types

Integration for Microsoft Outlook 2019 can use the following System Keyword Types to index
your documents.
Note: If the Use Local Time for Mail Date Keywords Global Client Setting is not selected, time
and date keywords are stored in UTC (Coordinated Universal Time) format.
System Keyword Type Description
MAIL Attachment Count The number of email attachments.
MAIL Attachment Name The value contained in the name of the email attachment or file.
Note: Illegal characters in attachment names are replaced with

acceptable alternatives. For more information, see Illegal
Attachment Name Characters on page 96.
Each value in the field is stored as an individual instance of the

System Keyword Type.
Note: If the MAIL Attachment Name Keyword Type is assigned

to the Document Type used for email messages, each email
message is indexed with each attachment name as a separate
Keyword Value. If the MAIL Attachment Name Keyword Type is
assigned to the Document Type used for attachments, each
attachment is indexed with its own attachment name.
MAIL Bcc The value of the email Blind Carbon Copy field.
MAIL Cc The value stored in the email Carbon Copy field. This value
represents the Cc field as it is displayed to the user.
MAIL Cc Address The value of the email Carbon Copy field. This value represents the
Cc field’s email addresses.
MAIL Certified This System Keyword Type is not supported by the Integration for
Microsoft Outlook 2019. A blank value is always stored for this
MAIL Date The date the email was sent.
MAIL Date Time The date and time the email was sent.

Configuration
System Keyword Type Description
MAIL From The value stored in the email From field. This value represents the
From field as it is displayed to the user.
MAIL From Address The email address from which the message was sent. This value
represents the From field’s email address.
MAIL MessageID A value created by the email server when an item is accepted into
the mail system. This is a unique identifier for the item.
MAIL Return Path This System Keyword Type is not supported by the Integration for
MAIL State This System Keyword Type is not supported by the Integration for
MAIL Status The value specifying the current state of the email. The status value
of the email is set to one of the following:
• ARCHIVED : The email is archived.
• PENDING : The email is pending send.
• SUCCESS : The email is sent successfully.
• ERROR : The email failed to send.
MAIL Subject The value contained in the email Subject field.
MAIL To The value stored in the email To field. This value represents the To
field as it is displayed to the user.
MAIL To Address The value stored in the email To field. This value represents the To
field’s email address.
Caution: System Keyword Types should not be included in Multi-Instance Keyword Type
Groups. Doing so can cause documents to be improperly indexed. Additionally, the MAIL To ,
MAIL To Address , MAIL Cc , MAIL Cc Address , MAIL Bcc , and MAIL Attachment Name
Keyword Types should not be included in Keyword Type Groups because only the last value is
indexed.

Configuration
Illegal Attachment Name Characters

Some characters in attachment names cannot be used with Integration for Microsoft Outlook
2019. If a message has an attachment with an attachment name that contains illegal
characters, the illegal characters are replaced with alternative characters when the message is
imported into OnBase. When illegal characters are removed and the attachment name is
imported into OnBase, the name of the attachment is stored as a MAIL Attachment Name
Keyword Value.
See the following illegal characters and their replacements:
Illegal Character Replacement Character
\ -
/ -
: ;
* +
? !
" ’
< [
> ]
| !

Configuration
The Integration for Microsoft Outlook 2019 allows you to configure options for displaying
ribbon buttons, how email messages are imported and stored, Unity Client settings, and more.

Configuration
To access the Outlook Integration Configuration layout, select File | OnBase . The Outlook
Integration Configuration layout is displayed.
Button Configuration
The Button Configuration section allows you to select which buttons are available in the
ribbon. The following button options are available.

Configuration
Button Configuration Description
Enable Import Button Select to enable the Import ribbon button.

For more information, see Import Options on page 42.
Note: This option does not apply to the Import from File
button.
Enable Launch Client Button Select to enable the Client ribbon button.
For more information, see Launch Client Options on page 45.
Enable Retrieval Button Select to enable the Custom Queries , Retrieval , and
Retrieve by Document Handle ribbon buttons.
Enable Workflow Button

Note: This option is only available if you are licensed for the
Workflow module and have the appropriate user rights to
configure this setting.
Select to enable the Workflow ribbon button. For more

information on Workflow, see the Workflow documentation.
Enable Forms Button

E-Forms or the Unity Forms module and have the appropriate
user rights to configure this setting.
Select to enable the Forms ribbon button.

For more information on E-Forms, see the E-Forms
documentation. For more information on Unity Forms, see
the Unity Forms documentation.
Enable Import from File Button Select to enable the Import from File ribbon button.
For more information, see Import Options on page 42.
Enable My Reading Groups

Button Note: This option is only available if you are licensed for the
Document Knowledge Transfer & Compliance module and
have the appropriate user rights to configure this setting.
Select to enable the My Reading Groups ribbon button.

For more information on Reading Groups, see the Document
Knowledge Transfer & Compliance documentation.

Configuration
Button Configuration Description
Enable Imaging Group

Document Imaging module and have the appropriate user
rights to configure this setting.
Select to enable the Imaging ribbon group, which includes

the Send to Scan Queue and Batch Processing buttons.
For more information on Document Imaging, see the
Document Imaging documentation.
Enable Help Button Select to enable the Help ribbon button.
Tip: Deselect all the options in the Button Configuration section to hide the integration with
OnBase tab completely.
After making changes in the Button Configuration section, click the Save button to save your
changes.
Note: If you are not logged on to the OnBase Client, the logon splash screen is displayed when
you click Save . You must be logged on to the OnBase Client to save your changes.
Import Options
Import options control what happens to an email message and how it is stored after it is
imported into OnBase using the Import button. The Enable Import Button option must be
selected from the Button Configuration section in order to use any of the following import
options.
Mail Message Options

Mail message options control what happens to an email message after it is imported into
OnBase. To import email messages into OnBase, one of the following mail message options
must be selected:
• Keep Messages In Same Folder
• Remove Messages
• Move Messages To

Configuration
See the following email message options:
Option Description
Keep Messages in Same Folder Email messages are kept in the same Outlook folder after
they are imported into OnBase. This option is selected by
default when the Enable Import Button option is selected.

imported into OnBase using an Auto Import folder or the
Import button on the Message tab.
Remove Messages Email messages are moved to the Microsoft Outlook Deleted
Items folder after being imported into OnBase.

Move Messages To Email messages are moved to a different Microsoft Outlook

folder. Click Browse to select a folder for imported email
messages to be moved to.

Automatically select all Select all email attachments automatically when importing
attachments for import email messages. Users can modify which email attachments
are included when importing email messages into OnBase.
Set Document Date as Sent Date Use the date that an email was sent as the Document Date. If
this option is not selected, the date the email message was
imported is used as the Document Date.
Note: If this option is selected and an email does not have a

Received Time value, the current date is used.

Configuration
Storage Options
The following options control how messages and attachments imported into OnBase are
stored:
Storage Options Behavior
Store messages in MSG format Store and retrieve messages in their native Outlook format.
When this option is selected, the Store attachments
separately option is available.
If this option is not selected, attachments and messages are
stored as separate documents and in the format in which the
message was created (for example, Plain/Rich Text or
HTML). Messages open in the OnBase Document Viewer.
Attachments are stored and retrieved in their respective file
formats.
Store attachments separately

Note: This option is only available when the Store
messages in MSG format option is selected.
Store attachments as separate documents from the

messages they are attached to.
If this option is selected, attachments are stored and
retrieved in their respective file formats. The Attachment
button is available in the Import Document pane if the
message has attachments.
If this option is not selected, attachments are stored in the

same .msg file as the message they are attached to. The
Attachment button is not available in the Import Document
pane.
After making changes in the Import Options section, click Save .

Configuration
Launch Client Options

The OnBase Client can be launched directly from the Integration for Microsoft Outlook 2019.
To configure the path to the OnBase Client executable:
1. Select the Enable Launch Client Button option in the Button Configuration section in
the Outlook Integration Configuration layout. The Launch Client Options section is
displayed.
2. Enter the path to the OnBase Client executable in the Executable Path field, or click
Browse to browse to the location of your OnBase Client executable.
Note: When using an instance of the OnBase Client that has been installed using a ClickOnce
deployment, the deployment link can be entered instead of the executable path.
3. Enter any OnBase command line switches to be applied to the OnBase Client executable
in the Executable Command Line Switches field.
For example, using the following switch automatically logs you on to the OnBase Client
module when you click the Client button:
-AL UN="USER NAME" PW="PASSWORD"
For more information on command line switches, see the Command Line Switches
module reference guide.
4. Click Save .
Workflow Options
Select Update notification when task is executed to update Workflow email notifications after
a task is executed to include information on the ad hoc task that was executed.
Updates are made in the following format:
Task '[name of task]' was executed on '[Auto-Name string]' from '[Workflow
queue]' at [date/time].

Configuration
If the executed task causes the item to transition out of the Workflow queue, the update is
made in the following format:
Task '[name of task]' was executed on '[Auto-Name string]' from '[Workflow
queue]' at [date/time] and has transitioned out of this queue.
After making changes in the Workflow Options section, click the Save button to save your
changes.
Imaging Options
The following options determine how scan queues and batch processing function within the
Integration for Microsoft Outlook 2019.
Option Description
Send Images Only to Scan Sends only images to a scan queue.

Queue
Note: For more information on scan queues, see the Document
Imaging documentation.
Show Batch Processing Opens the Batch Processing window after a message is sent to a
Layout after Scan Queue selected scan queue.
has been assigned
Note: For more information on batch processing, see the
Document Imaging documentation.
After making changes in the Imaging Options section, click the Save button to save your
changes.

Configuration
Integration Options
The following options can display troubleshooting messages and performance issues or
configure user options and Auto Import folders. These options are located on the right side of
the Outlook Integration Configuration layout.
Option Description
User Options Configure Unity Client user options. See the Unity Client
documentation for more information on Unity Client user
options.
The following user options are not respected in the Integration for
Microsoft Outlook 2019:
• Clear Document Keywords After Import : When this option is
selected, Keyword Values remain in the Keywords section of
the Import pane.
• Automatically open if search returns a single result : When
this option is selected, a returned single search result is
always displayed in the Search Results pane.
Troubleshooting Opens the Troubleshooting layout from the Unity Client. Using this
layout may be useful when in-depth information such as Connection
Information, Troubleshooting Messages, and Memory Usage
information is needed.
See the Unity Client documentation for more information on the
Troubleshooting layout.
Request Profile Diagram Opens the Request Profile Diagram layout from the Unity Client.
Using this layout may be useful when information on performance
and web service requests is needed.
See the Unity Client documentation for more information on the
Request Profile Diagram layout.
Folder Configuration Opens the Outlook Folder Configuration window to configure Auto
Import folders. See Auto Import Folder Configuration on page 48 for
more information about configuring an Auto Import folder.
About Opens the About OnBase dialog box which displays the version of
OnBase and the Application Server connection information.

Configuration
After making changes in the Integration Options section, click the Save button to save your
changes.
Auto Import Folder Configuration

The Integration for Microsoft Outlook 2019 provides the ability to configure Auto Import folders
from your Outlook Inbox using the Outlook Folder Configuration window. Auto Import folders
allow you to automatically import emails and attachments from your Outlook Inbox into
OnBase.
Auto Import folders allow you to map a standard email field value to a Keyword Type and then
use these field values to automatically index email messages and attachments when importing
to OnBase.
Each Auto Import folder is configured to archive email messages using Document Type
attributes for both the email message and any email attachments.
Note the following considerations for configuring Auto Import folders:
• Auto Import folders configured in Integration for Microsoft Outlook 2019 can be used
in other versions of Outlook as long as the same OnBase credentials are used within
the integrations.
• Outlook Search Folders cannot be configured to be Auto Import folders for
This section contains the following topics:
• Accessing Folder Configuration Options on page 106
• Creating an Outlook Folder to Configure as an Auto Import Folder on page 107
• Configuring an Auto Import Folder from an Existing Outlook Folder on page 112
• Configuring a Document Type for Archiving Messages and Attachments on page 116
• Configuring Items Sent to a Scan Queue on page 121
• Configuring Keyword Options on page 125
• Using Multi-Instance Keyword Type Groups with Auto Import Folders on page 130

Configuration
Accessing Folder Configuration Options

The Outlook Folder Configuration window allows you to configure new Auto Import folders and
manage existing Auto Import folders. The following are available options for Auto Import
folders on the Folder tab of the Outlook Folder Configuration window.
Options Description
Create Folder Create and configure a new Auto Import folder. For more information on
creating and configuring an Auto Import folder, see Creating an Outlook
Folder to Configure as an Auto Import Folder on page 107.
Configure Configure rules and actions for the selected Auto Import folder. For
more information on configuring an Auto Import folder, see Creating an
Outlook Folder to Configure as an Auto Import Folder on page 107.
Copy Copy the selected Auto Import folder and its configurations to another
parent folder.
Rename Rename the selected Auto Import folder. Folder names are limited to
127 characters.
Move Move the selected Auto Import folder to another parent folder.
Delete Delete the selected Auto Import folder.

Configuration
Options Description
Save Save all configured Auto Import folders to an external file that can be
used during deployment.
Note: This option is only available in the Microsoft Outlook

Configuration utility. For more information on this utility, see the
Outlook Folder Configuration Utility chapter of the Integration for
Microsoft Outlook 2019 documentation.
Load Load an existing Auto Import folder configuration file.
Note: This option is only available in the Microsoft Outlook

Configuration utility. For more information on this utility, see the
Outlook Folder Configuration Utility chapter of the Integration for
Microsoft Outlook 2019 documentation.
Creating an Outlook Folder to Configure as an Auto Import

Folder
You can create a new folder in your Outlook Inbox to configure as an Auto Import folder.
Configuring an Auto Import folder allows you to automatically import email messages and
attachments into OnBase.
To create an Outlook folder to configure as an Auto Import folder:
1. From the Integration with OnBase tab, click Folder Configuration .
The Outlook Folder Configuration window is displayed.

Configuration
2. On the Folder tab of the Outlook Folder Configuration window, click Create Folder .
The Select Folder dialog box is displayed.

Configuration
3. From the Select Folder dialog box, click New... to create a new folder in your Outlook
Inbox. The Create New Folder dialog box is displayed.
4. In the Name field, enter the name of the new folder.
Tip: Name the folder to reflect its function. For example, if you are using it to import resumes,
you might name it Resumes .
5. From the Folder contains drop-down list, select the types of items this folder receives.
6. From the Select where to place the folder field, select a location for the new folder.
7. Click OK . The Auto Import configurations are saved with the path to the folder and the
folder name. This makes it possible to delete a folder you configured, then later add the
folder, with all its configuration settings, back into the same place and name.
8. From the Select Folder dialog box, select the new folder from the list to use as the Auto
Import folder.

Configuration
9. Click OK . The Folder Rules dialog box is displayed.

Configuration
10. Select a combination of the following options:
Folder Actions Description
Archive Message Archives email messages.
Note: If you want to delete the Auto Import folder, you must deselect
the Archive Message option and the Archive Attachments option
before deleting the folder. Deleting the folder with these options
selected automatically re-creates the Auto Import folder.
For more information on configuring the Document Type for the Archive
Message option, see Configuring a Document Type for Archiving
Messages and Attachments on page 116.
Archive Attachments Archives email attachments.

When an Auto Import folder is configured to import only attachments
(by selecting Archive Attachments and deselecting Archive
Message ), you are not able to move messages without attachments
into the Auto Import folder. An error is displayed if you attempt to move
a message without an attachment into the Auto Import folder.
Attachments option, see Configuring a Document Type for Archiving
Send Message to Sends email messages directly to a configured scan queue.

Scan Queue For more information on configuring the scan queue for the Send
Message to Scan Queue option, see Configuring Items Sent to a Scan
Queue on page 121.
Send Attachments to Sends email attachments directly to a configured scan queue.

Attachments to Scan Queue option, see Configuring Items Sent to a
Scan Queue on page 121.
Keep Messages in Leaves messages that are archived or sent to a scan queue in the Auto
Same Folder Import folder.
Remove Messages Removes messages that are archived or sent to a scan queue from the
Auto Import folder and moves them to the Deleted Items folder.
Move Messages to Moves messages that are archived or sent to a scan queue from the
Folder Auto Import folder to a different folder. When this option is selected, the
folder location can be configured by selecting the Folder hyperlink in
the Rules section of the Folder Rules dialog box.

Configuration
Exclude Embedded Only archives attachments to email messages that are not embedded.
Attachments
Set Document Date as Sets the Document Date Keyword Type to be the same as the MAIL
Sent Date Date System Keyword Type.
11. Click Save .
Configuring an Auto Import Folder from an Existing Outlook

Folder
Configuring an Auto Import folder from an existing Outlook folder allows you to automatically
import email messages and attachments into OnBase.
To configure an Auto Import folder from an existing Outlook folder:
1. From the Integration with OnBase tab, click Folder Configuration .
The Outlook Folder Configuration window is displayed.
Tip: To quickly configure one folder without accessing the Outlook Folder Configuration
window, right-click on an Outlook folder in your Inbox and select Configure Folder .

Configuration
2. Select the Folder tab and click Create Folder .
The Select Folder dialog box is displayed.

Configuration
3. Select the Outlook folder from the list to configure as an Auto Import folder and click
OK . The Folder Rules dialog box is displayed.
4. Select a combination of the following options:
Archive Message Archives email messages.
Message option, see Configuring a Document Type for Archiving

Configuration
Archive Attachments Archives email attachments.

When an Auto Import folder is configured to import only attachments
(by selecting Archive Attachments and deselecting Archive
Message ), you are not able to move messages without attachments
into the Auto Import folder. An error is displayed if you attempt to move
a message without an attachment into the Auto Import folder.
Attachments option, see Configuring a Document Type for Archiving
Send Message to Sends email messages directly to a configured scan queue.

Message to Scan Queue option, see Configuring Items Sent to a Scan
Queue on page 121.
Send Attachments to Sends email attachments directly to a configured scan queue.

Attachments to Scan Queue option, see Configuring Items Sent to a
Scan Queue on page 121.
Keep Messages in Leaves messages that are archived or sent to a scan queue in the Auto
Same Folder Import folder.
Remove Messages Removes messages that are archived or sent to a scan queue from the
Auto Import folder and moves them to the Deleted Items folder.
Move Messages to Moves messages that are archived or sent to a scan queue from the
Folder Auto Import folder to a different folder. When this option is selected, the
folder location can be configured by selecting the Folder hyperlink in
the Rules section of the Folder Rules dialog box.
Exclude Embedded Only archives attachments to email messages that are not embedded.
Attachments
Set Document Date as Sets the Document Date Keyword Type to be the same as the MAIL
Sent Date Date System Keyword Type.
5. Click Save .

Configuration
Configuring a Document Type for Archiving Messages and

Attachments
Auto Import folders can be configured to archive email messages and attachments using a
configured Document Type. When configuring an Auto Import folder, you can select the Archive
Message option, the Archive Attachments option, or both. When these options are selected,
you must configure a Document Type for the messages and attachments to be archived.
To configure a Document Type for the Archive Message and Archive Attachments options:
1. From the integration with OnBase tab, click Folder Configuration . The Outlook Folder
Configuration window is displayed.
2. Click the Folder tab. The Folder ribbon is displayed.

3. From the Configured Folders section, select a folder from the list.

Configuration
4. From the Folder ribbon, click Configure . The Folder Rules dialog box is displayed.
5. From the Actions section, select Archive Message .

Configuration
6. From the Rules section, select the Document Type hyperlink.
The Keyword Mappings dialog box is displayed.

Configuration
7. From the Document Type Group drop-down list, select a Document Type Group to filter
the available Document Types.
8. From the Document Type drop-down list, select the Document Type to assign to all
items placed into this folder.
Note: Ensure users who are receiving this folder configuration have rights to the Document
Types you select during configuration.

Configuration
9. The Keyword Types for the selected Document Type are displayed in the Keywords
section.
These Keyword Values are contained in all the email messages and attachments that
are imported into OnBase using this Auto Import folder.
10. If necessary, configure the available Keyword Types in the Keywords section. For more
information, see Configuring Keyword Options on page 125.

Configuration
11. From the Storage Format drop-down list, select one of the following formats:
Storage Format Description
Native (txt, html, rtf) Store email messages in their native .txt, .html, or .rtf
file format.
MSG Format Store email messages in the native Outlook .msg file
format.
MSG store attachments separately Store email messages in the native Outlook .msg file
format and store attachments separately.
Note: The Storage Format option is only available with the Archive Messages option.
Email attachments are automatically stored in their native file format. OLE is considered
a default file format (even though OLE applications can produce many different file
formats). Email messages with any type of OLE attachment can be processed if you
assign a Document Type whose default file format is OLE.
Note: If the OLE file type is not currently available in your system, create a new file format in
the Configuration module. In the Viewer Type field, select OLE Server . For more information
about creating a new file format, see the System Administration documentation.
12. Click OK to save your changes and close the Keyword Mappings dialog box.
13. Repeat steps 1-10 if you select the Archive Attachments option.
Configuring Items Sent to a Scan Queue

Auto Import folders can be configured to send email messages and attachments to a
configured scan queue. When configuring an Auto Import folder, you can select the Send
Message to Scan Queue option or the Send Attachments to Scan Queue option. When one of
these options are selected, you must configure a scan queue for the messages and
attachments to be archived.

Configuration
To configure a scan queue for the Send Message to Scan Queue option or the Send
Attachments to Scan Queue option:
1. From the integration with OnBase tab, click Folder Configuration . The Outlook Folder
Configuration window is displayed.
2. Click the Folder tab. The Folder ribbon is displayed.

3. From the Configured Folders section, select a folder from the list.

Configuration
4. From the Folder ribbon, click Configure . The Folder Rules dialog box is displayed.
5. From the Actions section, select Send Message to Scan Queue .

Configuration
6. From the Rules section, select the Scan Queue hyperlink.
The Send to Scan Queue dialog box is displayed.
7. From the Batch Name field, enter the name of the batch to be scanned. If you do not
enter a name, a default name is used.

Configuration
8. From the Scan Queue drop-down list, select a scan queue to assign to the Auto Import
folder.
9. Select the Images Only option to only send attached image files from email messages
to the scan queue.
10. Click OK to save your changes and close the Send to Scan Queue dialog box.
Configuring Keyword Options

When configuring an Auto Import folder, you must have Document Types and corresponding
Keyword Types configured.
Note: There are known limitations when using a Document Type with a configured Multi-
Instance Keyword Type Group. See Using Multi-Instance Keyword Type Groups with Auto
Import Folders on page 130 for more information on using a Multi-Instance Keyword Type
Group with an Auto Import folder configuration.
In addition to indexing by Keyword Types configured in the Document Type, there are several
Keyword Value options that you can configure in the Keyword Mappings dialog box.
Note: If Keyword Value options are not available, the selected Keyword Type is a System
Keyword Type with one or more mapped Keyword Values. Options for System Keyword Types
cannot be changed.

Configuration
You can double-click the Keyword Type name to add another instance of the Keyword Type, or
place the cursor inside the Keyword Value field and press F6 .

Configuration
Keyword Options
The following table describes the options available from the Keywords section drop-down lists.
Note: When configuring options for required Keyword Types, you must select Data Entry or
specify a Mapped or Static Keyword Value.
Keyword Value Option Description
Blank Imports email messages or attachments with an empty Keyword

Value. This option is selected by default unless the Keyword Type is a
Note: Duplicated Keyword Types containing Blank Keyword Value

options are not applied to the imported message or attachment.
Data Entry Displays the Import Document pane when an email message is
moved to an Auto Import folder. This allows users to enter their own
Keyword Values for the required Keyword Types.
Note: Duplicated Keyword Types containing Data Entry Keyword

Value options do not display as duplicated in the Import Document
pane. You must duplicate these Keyword Types in the Import
Document pane to apply them to the imported message or
attachment.
Any configured System Keyword Types for the Document Type are
automatically populated and cannot be changed. Users can enter
Keyword Values for all Keyword Types that do not have a Mapped
Keyword Value option or a Static Keyword Value option configured.
Caution: Do not select the Data Entry Keyword Value option for
required Keyword Values that are part of a Multi-Instance Keyword
Type Group assigned to the configured Document Type. Under this
configuration, users selecting the Apply to all Messages option
can import the first email successfully, but the manually entered
Keyword Values are not retained in subsequent messages.

Configuration
Keyword Value Option Description
Mapped Displays the standard email field options drop-down list. Select a
standard email field such as To , From , or Subject as the Keyword
Value for the Keyword Type.
Any configured System Keyword Types are already mapped and
their mappings cannot be changed.
For a detailed list of the available standard email field options, see
Mapped Keyword Value Options on page 128.
Caution: Do not select the Mapped Keyword Value option for

Keyword Types that are included in a Multi-Instance Keyword Type
Group. If configured, documents can be improperly indexed.
Static Displays an empty field for data entry. Enter the Keyword Value for the
selected Keyword Type in the field.
Note: Currency Keyword Types cannot be configured as a Static

Keyword Value option.
When using an Auto Import Folder, any assigned AutoFill Keyword

Sets take precedence over Static Keyword Values.
Folder Name Uses the name of the configured Auto Import folder as the Keyword
Value. The Keyword Type must be configured as an alphanumeric
data type.
If the name of the Auto Import folder is longer than the maximum
length of the Keyword Type, the name is truncated to fit within the
maximum length.
Note: Specific Keyword Options have known limitations when using a Multi-Instance Keyword
Type Group. See Using Multi-Instance Keyword Type Groups with Auto Import Folders on page
130 for more information on using a Multi-Instance Keyword Type Group with an Auto Import
folder configuration.
Mapped Keyword Value Options

When Mapped is selected as a Keyword Value option for a Keyword Type, the following options
are available from the corresponding drop-down list:
Mapped Outlook Field Option Maps to Item in Outlook
Alternate Recipient Allowed The email message’s Sensitivity setting.
Note: This property is set to true when the Sensitivity is

Private .

Configuration
Mapped Outlook Field Option Maps to Item in Outlook
CC (Display Name) Cc: field (Display Value).
CC (SMTP Address) Cc: field (Email Address Value).
Note: SMTP is currently not supported in the Unity Client or

Web Client.
Creation Time Creation time of email message.
Note: The Creation Time is the time of last action. For

example, importing a message sets the Creation Time to the
current time.
Entry ID Message ID field.
Expiry Time Expires after: field.
From (Display Name) From: field (Display Value).
From (SMTP Address) From: field (Email Address Value).

Web Client.
Importance Importance: setting.
Number of Attachments Number of attachments.
Attachment Name The name of the email attachment.
Read Receipt Request a read receipt for this message: setting.
Received Time Received Time: field.
Sensitivity Sensitivity: setting.
Submit Time Sent Time: field.
Subject Subject: field.
To (Display Name) To: field (Display Value).
To (SMTP Address) To: field (Email Address Value).

Web Client.

Configuration
Considerations for Time-Related Keyword Types

The time of the Keyword Value is determined by the time at which the document is imported,
not sent or received.
For example, if a message is sent and received during standard time, but not imported until
daylight saving time is in effect, daylight saving time is applied to all time-related Keyword
Types. Conversely, if a message is sent and received during daylight saving time, but not
imported until standard time is in effect, standard time is applied to all time-related Keyword
Types.
Using Multi-Instance Keyword Type Groups with Auto Import Folders

There are a few known limitations when configuring email messages and attachments to use
Document Types with configured Multi-Instance Keyword Type Groups. Consider the following
information before completing an Auto Import folder configuration that uses a Multi-Instance
Keyword Type Group.
General Usage
If the Auto Import folder is configured to not require entry of any Keyword Values, Keyword
Types that are part of a Multi-Instance Keyword Type Group should not be used. Documents
can be improperly indexed.
If the Auto Import folder is configured to require entry of any Keyword Values, Keyword Types
that are part of a Multi-Instance Keyword Type Group can be used. However, the Multi-Instance
Keyword Type Group is not automatically populated. This is a known limitation of the Keywords
pane.
Data Entry Keyword Option

Do not select the Data Entry Keyword Value option for required Keyword Values that are part of
a Multi-Instance Keyword Type Group assigned to the configured Document Type. Under this
configuration, users selecting the Apply to all Messages option can import the first email
successfully, but the manually entered Keyword Values are not retained in subsequent
messages.
Mapped Keyword Option

Keyword Types that are included in a Multi-Instance Keyword Type Group should not be configured
as a Mapped Keyword Value option. If configured, documents can be improperly indexed.
Static and Folder Name Keyword Options

When a Keyword Type that is included in a Multi-Instance Keyword Type Group is configured as
a Static Keyword Value option or a Folder Name Keyword Value option, only the first instance
of the Keyword Type is populated.

Configuration
Understanding the Configuration Merge Process

When you configure a setting in the Integration for Microsoft Outlook 2019, the configuration is
stored in the database. When you access the Integration for Microsoft Outlook 2019 from
another workstation by using the same credentials and the same datasource, the settings
should be available as normal on the new workstation. However, if the local settings on a
workstation conflict with the settings stored in the database, discrepancies may occur. The
Integration for Microsoft Outlook 2019 always attempts to use the latest settings, which may
not always be local settings.
The below sections outline two possible scenarios that may occur with the configuration merge
process.
Example Configuration One

You are using a computer called Workstation 1. You are logged on as Jane Harper using the
datasource, 9SecondFoods. A folder is configured in the integration and functioning as
expected. It is used to archive email messages.
You log out of the integration and move to another computer which is called Workstation 2. You
log on to the integration with the same credentials (Jane Harper) and datasource
(9SecondFoods) as before. The folder is available and is configured and functioning as
expected. While logged on to Workstation 2, you change the configuration of the folder by
deselecting the Archive Message option in the Folder Options dialog box.
You log out of Workstation 2 and return to Workstation 1. You are still using the same
credentials and datasource as you have throughout. The folder seems to be available, but when
you drag an email to the folder for archival, you get the following message:
This folder’s configuration has changed and is no longer applicable .
You have received this message because the local configuration available on Workstation 1
was not the most recent configuration. The changes made on Workstation 2 override the local
settings. Because you were using the same credentials and datasource throughout the
exercise, the changes are persisted to your new session on Workstation 1.
Example Configuration Two

You are using a computer called Workstation 1. You are logged on as Jane Harper using the
datasource 9SecondFoods. The Workflow button is enabled and visible. When clicked, the
Workflow window is opened.
You log out of the integration and move to another computer which is called Workstation 2. You
log on to the integration with the same credentials (Jane Harper) and datasource
(9SecondFoods) as before. The Workflow button is visible and functioning as expected. While
logged on to Workstation 2, you disable the Workflow button.
You log out of Workstation 2 and return to Workstation 1. You are still using the same
credentials and datasource as you have throughout. The Workflow button seems to be
available, but when you click it, you get the following message:

Configuration
This option is no longer available.
You have received this message because the local configuration available on Workstation 1
was not the most recent configuration. The changes made on Workstation 2 override the local
settings. Because you were using the same credentials and datasource throughout the
exercise, the changes are persisted to your new session on Workstation 1.

OUTLOOK FOLDER C ONFIGURATION U TILITY
Overview
The Integration for Microsoft Outlook Folder Configuration utility gives administrators the
ability to create, update, and deploy Auto Import folder configurations for their Integration for
Microsoft Outlook users. It is an optional tool that can be used when installing these modules.
Usage
The following contains information on the Outlook Folder Configuration utility.
Creating an Auto Import Folder Configuration File

Creating an Auto Import folder configuration file allows you to deploy configured Auto Import
folders for Integration for Microsoft Outlook 2019 users.
To create an Auto Import folder configuration file:
1. Run the Hyland Outlook Folder Configuration utility executable file
(Hyland.Office.OutlookFolderConfiguration.exe). The OnBase logon splash screen is
displayed.
2. Log on to OnBase. The Folder Configuration window is displayed.

Outlook Folder Configuration Utility
3. See Creating an Outlook Folder to Configure as an Auto Import Folder on page 50 for
detailed instructions on configuring an Auto Import folder.
Note: Ensure users who are receiving this folder configuration have rights to the Document
Types that you select during configuration.
4. Select the configured Auto Import folder from the Configured Folders section.
5. From the Folder tab, click Save .
The Microsoft Windows Save As dialog box is displayed.

6. Enter a name for the configuration file in the File name field.
7. Select a location to which to save the configuration file.
8. Click Save .
Deploying an Auto Import Folder Configuration

You can deploy the Auto Import folder configuration when installing the Integration for
Microsoft Outlook 2019 from the Hyland Office Products Installer.

To deploy an Auto Import folder configuration:

1. Run the Hyland Office Products Installer. See Hyland Office Products Installers on page
11 for information on executing the installer.
2. On the Outlook Integration Toolbar Configuration screen under Admin Configuration ,
configure the following options:
• Set the Update the Client’s Default Settings option to Yes .
• Set the Allow User Folder Configuration option to No .
Note: When setting the Allow User Folder Configuration option to No , the Folder Configuration
button is not available on the Integration with OnBase tab or in the Integration with OnBase
menu of the Integration for Microsoft Outlook 2019.

3. On the Folder Configuration screen, enter the path to the Auto Import folder
configuration file (.confg).
4. Complete the Integration for Microsoft Outlook 2019 installation using the installation
instructions from the Hyland Office Products Installers chapter in this module
reference guide.
Installation
To install the Integration for Microsoft Outlook Folder Configuration utility:
1. Navigate to the ..\apps\OfficeProducts folder of your solution files.
2. Copy the OutlookFolderConfiguration folder.
3. Paste the folder to a location on your workstation.
4. From the OutlookFolderConfiguration folder, open the Integration for Microsoft Outlook
Folder Configuration utility configuration file
(Hyland.Office.OutlookFolderConfiguration.exe.config).
5. Locate the <ServiceLocations> tag and configure the following:
Setting Name Description
ServicePath Enter the URL to the Service.asmx page of the Application Server.

Setting Name Description
DataSource Enter the data source name (configured at the Application Server)
that the Integration for Microsoft Outlook Folder Configuration
application connects to.
FriendlyName Enter the display name of the service location.
UseNTAuthentication Enter whether or not you are using NT Authentication.

When True is entered, Active Directory/LDAP Authentication is
used.
When False is entered, Active Directory/LDAP Authentication is not
used.
6. Save and close the Integration for Microsoft Outlook Folder Configuration utility
configuration file.

I NTEGRATION FOR M ICROSOFT O UTLOOK 2019 B EST
P RACTICES
The following best practice recommendations were assembled by a team of OnBase subject
matter experts. They represent the accumulation of years of experience installing and
configuring OnBase solutions.
The following recommendations are general in nature, and are applicable to most OnBase
solutions and network environments. Depending on your solution design and your
organization’s needs, not all of the best practice recommendations listed below may apply to,
or be recommended for, your OnBase solution.
Carefully consider the impact of making any changes, including those listed below, to your
OnBase solution prior to implementing them in a production environment.
Configuration
The following sections describe best practices related to the configuration of the Integration
for Microsoft Outlook 2019.
Document Types
It is considered a best practice to use the System Keyword Types when configuring Document
Types.
Keyword Types
System Keyword Types should not be included in Multi-Instance Keyword Type Groups. Doing
so can cause documents to be improperly indexed.
Additionally, the MAIL To , MAIL To Address , MAIL Cc , MAIL Cc Address , MAIL Bcc , and MAIL
Attachment Name Keyword Types should not be included in Keyword Type Groups because
only the last value is indexed.
Import Options
If you are not storing email messages in MSG format, it is considered a best practice to
configure cross references to the email attachment using the MAIL MessageID System
Keyword Type.
Auto Import Folder Configuration

It is considered a best practice to name the folder to reflect its function. For example, if you are
using the folder to import resumes, name it Resumes .

Integration for Microsoft Outlook 2019 Best Practices
While user interaction cannot be entirely avoided as users must manually drag and drop
messages into the Auto Import folder (Outlook Rules cannot be used in conjunction with Auto
Import folders), it is still considered a best practice to configure folders so that the least
amount of manual interaction possible is required when importing email messages and
attachments.
Installation
The following sections describe best practices related to the installation of the Integration for
Microsoft Outlook 2019.
ClickOnce
It is considered a best practice to create separate ClickOnce deployments when configuration
settings differ across OnBase User Groups. For example, your Human Resources users do not
need to access the OnBase Client, but your Accounts Payable users do need access to the
OnBase Client. In this example, you should create two deployments; one with the ability to
launch the OnBase Client, and one without the ability to launch the OnBase Client.

User Guide
Foundation EP4
U SAGE
Using the Integration for Microsoft Outlook 2019 is similar to using the Unity Client. For this
reason, similar functionality is not discussed in this documentation. For more information on
Unity Client functionality, see the Unity Client documentation.
Exclusive Integration for Microsoft Outlook 2019 functionality is outlined in this chapter, as
well as differences between the Integration for Microsoft Outlook 2019 and the Unity Client.
Although the Integration for Microsoft Outlook 2019 uses Unity Client functionality when
working with documents, you do not need the Unity Client running to use the Integration for
Microsoft Outlook 2019. As long as the Application Server is running, you can use the
Before using OnBase functionality in Outlook, you are required to log on to OnBase.
Note: If any System Notifications are available, they are displayed after logging on. The
Effective Date is shown above each message. Click OK when you are finished reading the
notifications.
Caution: Closing the Microsoft Outlook application does not display a prompt to save your
work, and any unsaved work may be lost.

Usage
Accessing the Integration for Microsoft Outlook 2019

The Integration for Microsoft Outlook 2019 is accessed from the OnBase tab in the Microsoft
Outlook application.
Note: Depending on the configuration of your system, the name of this tab may have been
changed by your system administrator or in the user settings.
If the integration with OnBase tab is not available, the Integration for Microsoft Outlook 2019 is
not installed. If you were provided with a URL or UNC path to the installation package, click the
path to install Integration for Microsoft Outlook 2019. When the installation is confirmed, click
Close and launch the Microsoft Outlook application to access the integration with OnBase tab.
Note: When the installation package is modified by your system administrator, you are
prompted to install a new version of Integration for Microsoft Outlook 2019 after opening the
Microsoft Outlook application.
If you have not been provided with a URL or UNC path, contact your system administrator.

Usage
The Integration with OnBase Ribbon

The integration with OnBase ribbon is added to Outlook when the Integration for Microsoft
Outlook 2019 is installed. Access the ribbon by clicking the integration with OnBase tab.
Note: If you are not already logged on to OnBase, you are prompted to log on after clicking a
button in the integration ribbon. If it is your first time using the Integration for Microsoft
Outlook 2019 after installation, you are prompted to log on when Outlook opens.

Usage
Depending on your configuration and licensing, the ribbon may contain the following buttons:
Document Group Description
Custom Queries Opens the Custom Queries window.
Retrieval Opens the Retrieval window.
Envelopes Opens the Envelope window.
File Cabinets Opens the File Cabinets window.
Retrieve by Document Opens the Retrieve by Document Handle window.

Handle
OnBase Group Description
Import Imports the selected email messages and any attachments into
OnBase.
Note: Depending on your system configuration, the icon for the

Import button may differ from that pictured here.
Dashboards Opens the Dashboards window. A Reporting Dashboards license

is required to use this button.
For more information on Reporting Dashboards, see the
Reporting Dashboards module reference guide.

Usage
OnBase Group Description
Workflow Opens the Workflow window. A Workflow Named User Client or a

Workflow Concurrent Client license is required to use this button.
For more information on Workflow, see the Workflow module
reference guide.
My Reading Groups Opens the My Reading Groups window. A Document Knowledge

Transfer & Compliance license is required to use this button.
For more information on Reading Groups, see the Document
Knowledge Transfer & Compliance module reference guide.
Client Opens the OnBase Client.

Client button may differ from that pictured here.
Folder Configuration Opens the Outlook Folder Configuration window. For

instructions on how to configure an Auto Import folder, see Auto
Import Folder Configuration on page 48.
Help Opens the Integration for Microsoft Outlook 2019 help file.

Usage
Connect Group Description
Reconnect
Note: This button is only displayed when OnBase has lost
connection to the Application Server.
Reconnects the Integration for Microsoft Outlook 2019 to the

Application Server when the connection is lost. If you are still
unable to reconnect to the Application Server after clicking
Reconnect , contact your system administrator.
Create Group Description
Forms Opens the Create a New Form window to create a new E-Form or
Unity Form.
For more information on E-Forms, see the E-Forms module
reference guide. For more information on Unity Forms, see the
Unity Forms module reference guide.
Import from File Opens the Import from File window.

Import from File button may differ from that pictured here.
Imaging Group Description
Send to Scan Queue Sends the selected or open mail messages to your configured
scan queue. When using this button, messages are processed
with the .msg file format.
Note: The Store messages in MSG format option in File |

OnBase is ignored by the Send to Scan Queue button. Outlook
messages sent to a scan queue for processing are stored in .msg
format whether or not the Store messages in MSG format
option is selected.
For more information on scan queues, see the Document

Imaging module reference guide.

Usage
Imaging Group Description
Batch Processing Opens the Batch Processing window.

For more information on batch processing, see the Document
Imaging module reference guide.
Importing Email Messages and Attachments

Integration for Microsoft Outlook 2019 provides the ability to import email messages and
attachments from your Outlook Inbox into OnBase.
To import email messages and attachments, you must have the appropriate user rights. If you
attempt to import email messages and attachments and are notified that you do not have
import rights, contact your system administrator.
To allow users to retrieve email messages and attachments once they have been imported, you
must index the email messages and attachments. Indexing provides the information required
for the later retrieval of specific email messages and attachments.
There are two ways to import and index email messages and attachments:
• Import and index using an Auto Import folder. See Importing and Indexing with an
Auto Import Folder on page 147.
• Import and index manually. See Importing and Indexing without an Auto Import
Folder on page 155.
Importing and Indexing with an Auto Import Folder

Note the following considerations when using an Auto Import folder to import messages and
attachments into OnBase:
• During automatic import, you may receive an error message stating that your
administrator has placed a limit on the number of items that can be opened
simultaneously. To reduce the number of opened items, close messages you have
open or remove attachments and images from unsent messages.
• Non-mail items such as drafts, tasks, and notes cannot be imported using an Auto
Import folder.
• If an Auto Import folder has been configured to import only attachments (and not
email messages), you cannot move an email without attachments into that Auto
Import folder.

Usage
To import and index email messages and attachments using an Auto Import folder:
1. Move one or more email messages to the appropriate Auto Import folder, using any of
the following methods:
• Select the email and drag it to the Auto Import folder.
• Right-click the email and drag it to the Auto Import folder, release the mouse, and
select Move from the displayed menu.
Note: Emails dragged from Outlook Search Folders (such as the Unread Mail search folder) to
the Auto Import folder are not imported automatically. Emails must be dragged from a non-
search folder to be imported automatically.
• Right-click the email, select Move , and select the Auto Import folder from the list.
Note: The order in which email messages are selected dictates the order in which they are
imported into OnBase.

Usage
2. Log on to OnBase.
• If you are not logged on to OnBase, enter your user name and password to log on
from the logon splash screen.
• If you are already logged on to OnBase, the selected messages begin the import
process.
Once logged on to OnBase, the following may occur:
• If the Auto Import folder is configured to require entry of any Keyword Values, the
Import Document pane is displayed. Proceed to step 3.
Tip: You can hover over the message header above the Import section to display the entire
name of the message being imported.
• If the Auto Import folder is not configured to require entry of any Keyword Values, the
messages and any attachments are automatically imported and indexed into
OnBase.

Usage
3. From the Import Document pane, select the Document Type Group from the Document
Type Group drop-down list.
Note: This option is automatically populated based on Auto Import folder configuration.
4. Select the Document Type from the Document Type drop-down list.
Note: This option is automatically populated based on Auto Import folder configuration.
5. Select the file type for the attachment from the File Type drop-down list.
Note: In most instances, the file type is automatically populated because the Integration for
Microsoft Outlook 2019 automatically recognizes file types. If an attachment has an unknown
extension or does not have an extension at all, a file type is not populated and must be manually
selected.
6. Select the date for the document from the Document Date drop-down list.
7. From the Keywords section, enter Keyword Values in the appropriate Keyword Type
fields. Keyword Type fields are populated based on how the Auto Import folder was
configured. Any Keyword Types configured as Data Entry or Blank have an empty value.
If your Document Type was configured with default mail System Keyword Types, some
of the Keyword Type fields may already be filled in.
Note: You cannot edit default mail System Keyword Types, such as MAIL To or MAIL From .

Usage
8. If the email message contains attachments, click the Attachment button available in the
top-right corner of the Import Document pane.
Note: The Attachment button is only available if the Integration for Microsoft Outlook 2019 is
configured to store attachments separately.
The Select Attachments for Import dialog box is displayed.
Note: Depending on your configuration, attachments may already be selected for import. You
do not need to click the Attachment button unless you want to change which attachments are
imported.
9. Select the attachments to be imported in one of the following ways:

• Select the box to the left of the Attachment Type column for the corresponding
attachment.
Tip: You can hover over the file name in the Attachment Name column to display the entire

Usage
• Right-click an attachment and select the Select All option from the right-click menu.
• Left-click an attachment in the list and press Ctrl + A to select all the attachments.
Tip: To preview an attachment, double-click the attachment name to view the document in a
separate window.
10. Click OK .
11. Select the Apply to all messages option to apply the settings from the Import
Document pane to all remaining email messages. When selected, all remaining email
messages are imported after clicking Import .
When this option is not selected and multiple email messages are to be imported:
• The Document Type selected for the last imported email message is retained in the
subsequent email message.
• Any Keyword Types (other than mail System Keyword Types) that are populated for
the last imported email message are retained in the subsequent email message.
These Keyword Types are also retained in the subsequent attachment if the
Document Type selected for the attachment contains these same Keyword Types.
• When a Keyword Value is modified, the modified Keyword Value is retained in
subsequent email messages or attachments.
Note: Any entered or modified Static and Mapped Keyword Values are not retained across
messages and attachments. When a Static or Mapped Keyword Value is edited, the subsequent
item contains the original Static or Mapped Keyword Value, not the edited Keyword Value.
12. Select the Apply to all attachments option to apply the selected settings from the
Import Document pane to all remaining email attachments. When selected, all
remaining email attachments are imported after clicking Import .
When this option is not selected and multiple email attachments are to be imported:
• The Document Type selected for the last imported email attachment is retained in
the subsequent email message.
the last imported email attachment are retained in the subsequent email attachment.
• If an attachment has an unknown extension or does not have an extension at all, a

file type must be manually selected for that attachment from the File Type drop-
down list.

Usage
13. Click one of the following buttons:
Button Description
Import Imports any selected email messages and attachments into OnBase.
The following items may be displayed:
• If you selected any attachments, the Import Document pane for the attachment
is displayed.
• If there are no attachments that are selected for import, or if attachments are not
configured to require user entry of any Keyword Values, the Import Document
pane for the next message is displayed.
• If there are additional email messages to import and you did not select Apply to
all messages or Apply to all attachments , the Import Document pane for the
next message is displayed.
When there are no more email messages, the Import Document pane is closed.
Skip Skips the selected message or attachment for import into OnBase.
• If there are any attachments to import, the Import Document pane for the first
attachment is displayed.
• If there are no attachments to import, the Import Document pane for the next
message is displayed.
When there are no more messages to import, the Import Document pane is closed.
Importing and Indexing an Auto Import Folder with Existing Messages

If you configured an existing folder as an Auto Import folder, any existing messages in that
folder cannot be automatically imported into OnBase. However, the Auto Import configuration
can be run manually on existing messages.

Usage
To manually import existing messages from a newly configured Auto Import folder:
1. From your Outlook Inbox, select the existing folder configured for Auto Import.
2. Select the Run Folder Import option in one of the following ways:
• Click the Folder tab, then click the Run Folder Import button from the ribbon.
• Right-click the existing folder and select Run Folder Import from the right-click
menu.
The Run Folder Import dialog box is displayed.
3. From the Apply folder import rules to drop-down select menu, select one of the
following options:
• All Messages
• Unread Messages
• Read Messages
The Rules section displays where the messages are sent to according to the Auto
Import folder configuration.
4. Click Run Now to import existing messages from the selected folder into OnBase.

Usage
Importing and Indexing without an Auto Import Folder

You can import an email message and attachments into OnBase when an email message is
selected in Outlook, or from an open email message.
To manually import email messages and attachments:
1. Perform one of the following actions:
• Select one or more email messages in Outlook, then right-click on the selected email
messages and select Import.
• Select one or more email messages in Outlook, then click the Import button on the
integration with OnBase tab.
• From an open email message, click the Import button on the Message tab.
Note: Depending on your system configuration, the pictured icon for the Import button may
differ slightly.
Depending on your logon status to OnBase, one of the following is displayed:

• The OnBase logon splash screen
• The Import Document pane

Usage
• If you are already logged on to OnBase, the Import Document pane is displayed.
Tip: You can hover over the message header above the Import section to display the entire
3. From the Import Document pane, select the Document Type Group from the Document
Type Group drop-down list.
4. Select the Document Type from the Document Type drop-down list.

Usage
selected.
6. Select the date for the document from the Document Date drop-down list.
fields. If your Document Type was configured with default mail System Keyword Types,
some of the Keyword Type fields may already be filled in.
Note: You cannot edit default mail System Keyword Types, such as MAIL To or MAIL From .

Usage
8. If the email message contains attachments, click the Attachment button available in the
top right corner of the Import Document pane.
Note: The Attachment button is only available if the Integration for Microsoft Outlook 2019 is
configured to store attachments separately.
The Select Attachments for Import dialog box is displayed.
Note: Depending on your configuration, attachments may already be selected for import. You
do not need to click the Attachment button unless you want to change which attachments are
imported.
9. Select the attachments to be imported in one of the following ways:

• Select the box to the left of the Attachment Type column for the corresponding
attachment.
Tip: You can hover over the file name in the Attachment Name column to display the entire

Usage
• Right-click an attachment and select the Select All option from the right-click menu.
• Left-click an attachment in the list and press Ctrl + A to select all the attachments.
Tip: To preview an attachment, double-click the attachment name to view the document in a
separate window.
10. Click OK .
11. Select the Apply to all messages option to apply the settings from the Import
Document pane to all remaining email messages. When selected, all remaining email
messages are imported after clicking Import .
When this option is not selected and multiple email messages are to be imported:
• The Document Type selected for the last imported email message is retained in the
subsequent email message.
the last imported email message are retained in the subsequent email message.
These Keyword Types are also retained in the subsequent attachment if the
Document Type selected for the attachment contains these same Keyword Types.
12. Select the Apply to all attachments option to apply the selected settings from the
Import Document pane to all remaining email attachments. When selected, all
remaining email attachments are imported after clicking Import .
When this option is not selected and multiple email attachments are to be imported:
• The Document Type selected for the last imported email attachment is retained in
the subsequent email message.
the last imported email attachment are retained in the subsequent email attachment.
• If an attachment has an unknown extension or does not have an extension at all, a

file type must be manually selected for that attachment from the File Type drop-
down list.

Usage
Button Description
Import Imports the email message into OnBase.

• If you selected any attachments, the Import Document pane for the attachment
is displayed.
• If there are no attachments that are selected for import, or if attachments are
not configured to require user entry of any Keyword Values, the Import
Document pane for the next message is displayed.
• If there are additional email messages to import and you did not select Apply to
all messages or Apply to all attachments , the Import Document pane for the
next message is displayed.
• If there are no more email messages, the Import Document pane is closed.
Skip Skips the selected message or attachment for import into OnBase.
• If there are any attachments to import, the Import Document pane for the first
attachment is displayed.
• If there are no attachments to import, the Import Document pane for the next
message is displayed.
• If there are no more messages to import, the Import Document pane is closed.
Importing Attachments Only

The Integration for Microsoft Outlook 2019 allows users to import only the attachments of an
email message into OnBase.You can import multiple attachments or a single attachment. See
the following sections for more information:
• Importing All Attachments from an Email Message on page 160
• Importing a Single Attachment from an Email Message on page 163
Importing All Attachments from an Email Message

The Integration for Microsoft Outlook 2019 allows users to import only the attachments of an
email message into OnBase. When multiple images are imported as attachments, you can also
combine them into a single document by using the Import All Attachments option.

Usage
To import attachments only:

1. Open an email message from Outlook.
2. From the Message tab, click the Import All Attachments button.
Note: The Import All Attachments button is not available if the email has no attachments.
• If you are already logged on to OnBase, a message is displayed.

Usage
4. Select one of the following options from the message:

• Select Yes to create a single, multi-page document of all the imported attachments.
• Select No to create a document for each imported attachment.
The Import Document pane is displayed.
5. Select the Document Type Group for the attachment from the Document Type Group
drop-down list.
6. Select the Document Type for the attachment from the Document Type drop-down list.
selected.
8. Select the date for the attachment from the Document Date drop-down list.

Usage
fields. Any Keyword Types configured as Data Entry or Blank will have an empty value.
of the Keyword Values may already be filled in.
Note: You cannot edit default mail System Keyword Types, for example, MAIL To or MAIL
From .
10. If you are importing more than one attachment, select the Apply to all attachments
option to apply the selected settings in the Import Document pane to all remaining
email attachments.
• Import : Imports the attachment to OnBase. If there are multiple attachments to
import and the Apply to all attachments option is not selected, the Import Document
pane for the next attachment is displayed. If the Apply to all attachments option is
selected, all remaining email attachments are imported.
• Skip : Skips the selected attachment for import into OnBase. If there are no other
attachments to import, the Import Document pane is closed.
Importing a Single Attachment from an Email Message

The Integration for Microsoft Outlook 2019 allows users to import only a single attachment of
an email message into OnBase if multiple attachments exist.
To import only a single attachment from an email message:
1. Open an email message from Outlook.
2. From the attachment, select the drop-down menu and click Import Attachments .

Usage
• If you are already logged on to OnBase, the Import Document pane is displayed.
4. Select the Document Type Group for the attachment from the Document Type Group
drop-down list.
5. Select the Document Type for the attachment from the Document Type drop-down list.
selected.
7. Select the date for the attachment from the Document Date drop-down list.

Usage
fields. Any Keyword Types configured as Data Entry or Blank will have an empty value.
of the Keyword Values may already be filled in.
Note: You cannot edit default mail System Keyword Types, for example, MAIL To or MAIL
From .

• Import : Imports the attachment to OnBase.
• Skip : Skips the selected attachment for import into OnBase. The Import Document
pane is closed.
Attaching a File from OnBase to an Outlook Email

Message
The Integration for Microsoft Outlook 2019 allows users to attach files from OnBase to an
email message and send it to other recipients.
Note: You must have external mail rights to email documents to users outside of OnBase. For
more information, see your system administrator.

Usage
To attach a file from OnBase:

1. Open a new mail message, or reply to an existing message.
2. On the Message tab, click Attach from OnBase.
Note: Depending on your system configuration, the pictured icon and name of the button may
have been changed by your system administrator or in user settings.
Depending on your logon status to OnBase, the following may display:

• If you are not logged on to OnBase, the OnBase logon splash screen is displayed.
• If you are already logged on to OnBase, the Search Panel pane is displayed.

Usage
3. From the Document Types and Groups sections, select the Document Type Group from
which the document to attach belongs from the drop-down list.
4. Select the Document Type from which the document to attach belongs from the
Document Type list.
5. From the Keywords and Date Range section, enter Keyword Values in the appropriate
Keyword Type fields from which to search for the document to attach.

Usage
6. Click Find . The Search Results pane is displayed with any documents that match your
search criteria.
7. Select one or more documents and click the Attach from OnBase button to attach the
selected documents to the email message.
Tip: Double-click on a search result to view the document in the Document Viewer.
8. If the document is an image, a dialog box is displayed to select the format in which the
image will be attached. Available options vary depending on the document’s original
format. The following options may be available:
• Default/TIFF : Attaches the document as a TIFF file.
• Unencrypted PDF : Attaches the document as a PDF file.
• Encrypted PDF : Attaches the document as an encrypted PDF file. When this option is
selected, the Password field is displayed. Enter an encryption password in the
Password field. The recipient opening the attachment will need to enter this
password to open it.
• Native Format : Attaches the document in the format in which it is stored in OnBase.
9. Click OK . The document is attached to your email message. Documents attached from
OnBase use the document’s name as the file name.
Viewing Imported Email and Other Documents in

Outlook
The Integration for Microsoft Outlook 2019 allows you to retrieve email and attachments
imported into OnBase and view them in Outlook by using the Retrieval window.
Note: To use Document Retrieval, you must have the appropriate user rights. Contact your
system administrator for additional information.

Usage
To view emails and attachments imported into OnBase:

1. On the OnBase tab, click Retrieval .
Note: You must have appropriate user rights to access the Retrieval button. If you cannot
access the Retrieval button, contact your system administrator.
Depending on your logon status to OnBase, one of the following may be displayed:
• If you are not logged on to OnBase, the Login dialog box is displayed
• If you are logged on to OnBase, the Retrieval window is displayed
2. Select the Document Type Group you used to import your email messages and
attachments from the drop-down list in the Document Types and Groups pane.
3. Select the Document Type from the list of Document Types.

Usage
4. Enter any Keyword Values needed to refine your search in the Keywords and Date
Range pane.
5. Click Find . For more information about retrieving and viewing documents using the
Retrieval window, see the Unity Client documentation.
Note: If your system is configured to store email messages in the Outlook native .msg format,
any email message you retrieve is displayed in the Outlook viewer where you can perform email
actions, such as replying or forwarding a message.
System Interaction
The following information contains information about buttons in the integration with OnBase
ribbon that interact with other OnBase modules.
Application Enabler
Application Enabler can populate index values when importing email and attachments in the
Note: See the Application Enabler documentation for more information.
Document Imaging
If your OnBase system is licensed for Document Imaging and properly configured, the Imaging
ribbon group is available in the integration with OnBase ribbon.
Sending Messages to a Scan Queue

You can send email messages from your Outlook Inbox to a configured scan queue.
Note: The quantity of messages that can be imported at once is limited to 1024.

Usage
To send an email message to a scan queue:

1. Select the email message from your Outlook Inbox.
2. From the OnBase ribbon, click Send to Scan Queue . The Send to Scan Queue dialog
box is displayed.
Note: The Send to Scan Queue option requires documents with an .msg file type, and does not
respect the deselection of the Store messages in MSG Format setting.
3. Select a scan queue from the Scan Queue drop-down list.

4. Enter a batch name in the Batch Name field in one of the following ways:
• Use the default batch name automatically entered when a scan queue is selected
• Type a new batch name
5. Select the Images Only option to only send attached image files from email messages
to the scan queue.
6. Click OK .
Note: For more information on scan queues, see the Document Imaging documentation.
Sending Only Attachments to a Scan Queue

You can send email attachments from your Outlook Inbox to a configured scan queue.

Usage
To send an email attachment to a scan queue:

1. Select the email message with the attachment from your Outlook Inbox.
2. Select the drop-down arrow on the attachment. The attachment drop-down menu is
displayed.
3. Select Send Attachments to Scan Queue . The Send to Scan Queue dialog box is
displayed.
4. Select a scan queue from the Scan Queue drop-down list.

5. Enter a batch name in the Batch Name field in one of the following ways:
• Use the default batch name automatically entered when a scan queue is selected
• Type a new batch name
6. Click OK .
Note: For more information on scan queues, see the Document Imaging documentation.

Usage
Accessing Batch Processing

You can access the Batch Processing window using the Integration for Microsoft Outlook 2019
to view batches waiting in your scan queues for indexing.
To access the Batch Processing window:
1. From the OnBase ribbon, click Batch Processing .
The Batch Processing window is displayed.
2. Select a batch from the Status Queues or Scan Queues list in the Batch Processing
pane.
Note: For more information on batch processing, see the Document Imaging documentation.

Usage
Document Knowledge Transfer & Compliance

If your system is licensed for Document Knowledge Transfer & Compliance and properly
configured, the My Reading Groups button is available on the integration with OnBase ribbon.
Click the My Reading Groups button to display the My Reading Groups window from the
Note: For more information on Reading Groups, see the Document Knowledge Transfer &
Compliance documentation.
Mailbox Importer
If you are licensed and configured for Mailbox Importer, Integration for Microsoft Outlook 2019
can work with Mailbox Importer to monitor your Outlook folders that are configured for auto
import.
Note: For more information on Mailbox Importer, see the Mailbox Importer module reference
guide.
Reporting Dashboards
If you are licensed and configured for Reporting Dashboards, the Reporting button is available
on the integration with OnBase tab.
Click the Reporting button to open the Reporting window and the Create Dashboard Wizard
window.
Note: For more information on Reporting Dashboards, see the Reporting Dashboards
documentation.

Usage
Workflow
If your system is licensed for Workflow and properly configured, the Workflow button is
available on the integration with OnBase ribbon.
Click the Workflow button to launch Unity Workflow from the Integration for Microsoft Outlook
2019.
Note: For more information on Unity Workflow, see the Workflow documentation.
Email Notifications
If your system is licensed for Workflow, email notifications can be configured that allow you to
execute Workflow ad hoc tasks directly from an Outlook email message.
Note: When creating an email notification in OnBase Studio, you must select the Add Outlook
Header option to allow users to execute Workflow ad hoc tasks directly from an Outlook email
message. See the Workflow documentation for configuring Workflow notifications and
notification settings.
If a Workflow email notification is configured to allow you to execute ad hoc tasks directly from
an Outlook email message, the Workflow Task Pane button is displayed in the Message tab.
To execute Workflow ad hoc tasks directly from an Outlook email message:

1. Click the Workflow Task Pane button.
2. If you are not already logged on to OnBase, you are prompted to log on.

Usage
3. The Workflow Ad Hoc Tasks pane is displayed.
4. Select an ad hoc task from the Tasks pane. The ad hock task is executed.
Depending on your configuration, the email notification is modified to include
information on the ad hoc task that was executed. If ad hoc task execution transitions
the document to a different queue, the Workflow Task Pane button is removed from the
Message tab and the Workflow Ad Hoc Tasks pane is closed.
Note: The Show in Queue button is also available when an email notification is opened. Click
this button to open the Workflow queue associated with the notification.

Integration For Microsoft Outlook 2019 Onbase Foundation Ep4 Modu

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Integration For Microsoft Outlook 2019 Onbase Foundation Ep4 Modu

Uploaded by

Copyright:

Available Formats

Integration for Microsoft Outlook 2019

© 2020 Hyland Software, Inc. and its affiliates ii

© 2020 Hyland Software, Inc. and its affiliates iii

HYLAND OFFICE PRODUCTS INSTALLERS

© 2020 Hyland Software, Inc. and its affiliates iv

Change, Repair, or Remove an Installation ....................................................................................................... 74

OFFICE INTEGRATION FEATURE MATRIX

© 2020 Hyland Software, Inc. and its affiliates v

Keyword Types ................................................................................................................................................... 93

OUTLOOK FOLDER CONFIGURATION UTILITY

INTEGRATION FOR MICROSOFT OUTLOOK 2019 BEST PRACTICES

© 2020 Hyland Software, Inc. and its affiliates vi

Installation ............................................................................................................................................ 139

© 2020 Hyland Software, Inc. and its affiliates vii

© 2020 Hyland Software, Inc. and its affiliates 1

Microsoft Office 64-Bit Support Statement

© 2020 Hyland Software, Inc. and its affiliates 3

Hyland Software - Microsoft Service Pack Statement

© 2020 Hyland Software, Inc. and its affiliates 4

Integration for Microsoft Outlook 2019 Configuration

Command Line Switches and .ini Settings

© 2020 Hyland Software, Inc. and its affiliates 5

Public Folders and Shared Folders Not Supported

© 2020 Hyland Software, Inc. and its affiliates 6

Shared Mailboxes Not Recommended

Error When Opening Microsoft Office Documents

Releasing Concurrent Client and Named Client Licenses

Releasing Workflow Licenses

When I Launch Outlook, the Integration with OnBase Tab is

© 2020 Hyland Software, Inc. and its affiliates 7

To enable the Integration for Microsoft Outlook 2019:

Configured Outlook Signatures are Not Displayed on Outgoing

The Imaging Options Do Not Display in the Integration with

Fatal Error is Displayed When Attempting to Reconnect

HTML Custom Queries Do Not Perform a Search

© 2020 Hyland Software, Inc. and its affiliates 8

Displaying Troubleshooting Information

Requesting Profile Diagrams

Error During Installation on Client Machines

© 2020 Hyland Software, Inc. and its affiliates 9

© 2020 Hyland Software, Inc. and its affiliates 10

© 2020 Hyland Software, Inc. and its affiliates 11

ClickOnce installer Standard (MSI) installer

© 2020 Hyland Software, Inc. and its affiliates 12

ClickOnce installer Standard (MSI) installer

This chapter covers installation using either method:

Microsoft Office 2016 Support Statement

© 2020 Hyland Software, Inc. and its affiliates 13

Microsoft Office 2019 Support Statement

© 2020 Hyland Software, Inc. and its affiliates 14

Microsoft Office 365 Support Statement

Microsoft Updates to Microsoft Outlook

© 2020 Hyland Software, Inc. and its affiliates 15

If you are installing a deployment package to be delivered to a client workstation using

© 2020 Hyland Software, Inc. and its affiliates 16

Installation Using ClickOnce

© 2020 Hyland Software, Inc. and its affiliates 17

Note: ClickOnce-deployed applications are not supported by Microsoft within a Remote

© 2020 Hyland Software, Inc. and its affiliates 18

General Installation Options

© 2020 Hyland Software, Inc. and its affiliates 19

© 2020 Hyland Software, Inc. and its affiliates 20

4. Click Next . The Instance Settings dialog box is displayed.