Quick Reference Guide - Unity Upgrade Considerations - Onbase 18
Quick Reference Guide - Unity Upgrade Considerations - Onbase 18
Getting Started
Upgrading is an essential part of a software solution. It is a necessary piece of housekeeping,
especially with a rapidly evolving solution like OnBase. This document covers an overview of
commonly used items that can help make upgrading the Unity Client easier.
General Notes
As of OnBase v17 the Unity Client has a new user interface design. If upgrading from
v16 or earlier, make sure to review these updates. More information is available in
OnBase 17 Release Interactive Video Gallery.
Ensure minimum hardware/operating requirements have been met and system pre-
requisites, such as Visual C++ Redistributables and .NET Framework, have been
installed whether using physical or virtual machines.
If the Windows User Access Control (UAC) feature is enabled, end users may need
‘Administrative Privileges’ at the operating system level. See Installation section of the
Unity Client Module Reference Guide for more details.
Utilize secure connections like Secure Socket Layer (SSL) between workstations and
servers to ensure data in transit remains protected.
Pre-Upgrade Considerations
As of OnBase v18 ADO.NET connection strings are required within the Application
Server’s web.config file to connect to the Database Server. For more information review
the ADO.NET Connection Strings section of the Application Server Module Reference
Guide.
Consider how authentication methods may be impacted (Identity Service Provider (IdP),
Single Sign-On (SSO), Active Directory, etc.)
Backup the OnBase Database, backup any/all web.config files, and make a note of any/all
related network user accounts and Windows Services.
Add the directory where the Unity Client was installed to the respective anti-virus white
list.
Perform basic networking tests like ping or tracert commands between client and server
machine.
Post-Upgrade Reflections
After installing/upgrading the Application Server, ensure a successful connection to the
respective Service.asmx page.
o Verify the user does not receive certificate errors.
o Verity the user is not prompted for authentication credentials when accessing this
page.
Make a note of any settings in the Application Server’s web.config file and the Unity
Client’s configuration file (e.g. obUnity.exe.config) that have been modified from their
default values.
Always use the same OnBase version when connecting the Unity Client to an Application
Server.
Use the installer setup executable (e.g. Setup.exe) to install pre-requisites for the Unity
Client and Application Server.
When installing the Unity Client via a Click Once Deployment, do not install the
deployment in a Terminal Services environment. Try re-using existing deployments OR
try using the OnBase version as the Deployment version to avoid confusion.
If the Windows User Access Control (UAC) feature is enabled, run the MSI Installer as
an Administrator account using ‘Administrative Privileges’ at the operating system level.
OnBase is backwards compatible, meaning older clients can connect to the latest and
greatest database version. However, the latest and greatest client version will not connect
backwards to an older database version.
In order to ensure that the required system settings take effect, it is a best practice to
restart the installing machine once the installer has finished.
Read the documentation. See the OnBase Upgrade Guidelines Module Reference
Guide.
Additional Resources
For more information on upgrading OnBase, please visit the OnBase Upgrade Technical
Community.
If you have additional questions or concerns, please contact Hyland Technical Support by
submitting a Support Issue via the Customer Portal of the Hyland Community: