Body
Overview
This article is designed to act as a guide for the installation of the latest version (24.1) of the DuckDocs (OnBase) Unity Client. The client is only available for use on Windows. Depending on your level of access, you may need to reach out to IT support to assist you with this installation.
Prerequisites
The following software packages are required for successful installation of the Unity client. If these packages are missing, you’ll encounter an error, and the Unity client installation process will halt until they are installed.
Installers for these packages can be found along with the other files described in installation step 2 via UO Software Downloads, below.
- Microsoft Visual C++ 2015-2022 Redistributable (x64)
- Microsoft Visual C++ 2015-2022 Redistributable (x86)
Installation Steps
Select the tab corresponding with the location which you are downloading the Unity Client.
Follow the steps below:
- In the search box on your Windows task bar, search for and open Software Center.
- On the Applications page of the Software Center, search for OnBase Unity Client. Click on the application to open the Unity Client application details page.
- Verify that the client version is 23.1 on the application details page. If viewing version 24.1, click the Install button.
- Once completed, open the Unity Client. If you are prompted for your Duck ID credentials as shown below, the installation was successful. If you are prompted with the Foundation 24.1 screen, you may need to update your configuration file.
- The configuration file is available on the UO Software Downloads website.
- Sign in with your Duck ID credentials.
- Navigate to Software Downloads > OnBase Unity Client
- Right-click and download the file titled: OnBase 24.1 Unity Client Config File
- When prompted, save it as obunity.exe.config.
- To update your configuration file, copy and paste the file (specified above) on your computer hard drive: C:\Program Files (x86)\Hyland\Unity Client, overwriting the existing obunity.exe.config file if prompted.
- Re-launch the client.
Follow the steps below:
- Navigate to UO Software Downloads. You may need to use the login button to access available software.
- Click the Software Downloads link in the main navigation menu. Scroll down to find the OnBase Unity Client, and click the button labeled 24.1.27.1000. This will take you to the download page for the Unity Client and relevant prerequisites.
- Click the OnBase 24.1 Unity Client Installer link to download OnBase-24.1-UnityClient.zip.
- Locate the downloaded folder on your computer, right-click and choose Extract All….
- Navigate to the extracted folder, then navigate to OnBase-24.1-UnityClient > install > Unity Client.
- Right-click on both the setup.exe and Hyland Unity Client, and click Properties. If the option is available on the General tab in this Properties window, check Unblock.
- Double-click setup.exe to begin the installation. A welcome screen should appear. Click Next.
- Note: You may be prompted to install additional prerequisites. To proceed click Install.
- The following details explain how to navigate the steps in the installer:
- On the Destination Folder screen, accept the default Installation Directory and click Next.
- On the Custom Setup screen, click the drop-down menu next to Unity Client and select Will be installed on local hard drive. You may also choose to install the Virtual Print Driver Listener (required for using the Virtual Print Driver). Otherwise, accept the default setup options and click Next.
- On the Service Location screen, click Next.
- On the Additional Settings screen, if prompted, accept the Default Mail Client option of Microsoft Outlook by clicking Next.
- If presented with additional Service Mode Options, accept the default options and click Next.
- On the Unity Configuration File Location screen, uncheck the option to deploy pre-configured Unity configuration file from specific location.
- On the Ready to install Hyland Unity Client screen, click Install.
- Once the installation is complete, click Finish.
Additional Required Configuration
Some additional configuration is required to login to the Unity Client when installing via UO Software Downloads. Please complete the following before launching the application.
- The configuration file is also available on the UO Software Downloads website.
- Sign in with your Duck ID credentials.
- Navigate to Software Downloads -> OnBase Unity Client
- Right-click and download the file titled: OnBase 24.1 Unity Client Config File
- Important Note: Depending on the browser it may try to save this file as an XML file. If so, change it back to .config so that the program can use it effectively.
- When prompted, save it as obunity.exe.config.
- To update your configuration file, copy and paste the file (specified above) on your computer hard drive: C:\Program Files (x86)\Hyland\Unity Client (You will copy the obunity.exe.config file to that location and specify that you would overwrite the existing file if prompted.)
Log in
When you launch the client, you should be prompted to log in using Single Sign On (SSO), which requires your Duck ID and password. (Please note that those not on a campus network will need to use VPN in order to access the application.)
Troubleshooting and Common Issues
During manual installation of the client, a pop-up appears stating that "The feature you are trying to use is on a network resource that is unavailable".
This is an artifact of the previous version having been installed by Software Center (MECM). In order to proceed with the installation, you must create a folder location identical to the one in the Use source path and place the MSI file installer for the previous version in that folder.
This file is available at UO Software Downloads at the following location: Software Downloads > OnBase Unity Client > 24.1 HylandUnityClient.msi (Use only for if new install gets stuck).
Error appears: This installation must be launched with administrative privileges.
- Ensure you’re attempting to install via the setup.exe file, and not the Hyland Unity Client Windows Installer Package. Double-clicking on the setup.exe file should launch the installer with the appropriate privileges.
Pop-up appears: This application requires Microsoft Visual C++ Redistributable...
- Navigate to the Unity Client 24.1.27.1000 files described in installation steps 1 and 2 of the installation instructions via UO Software Downloads.
- Download and run each of the Microsoft Visual C++ 2015-2022 Redistributable installers (x86 and x64) to ensure the prerequisites have been installed.
Prompted for a username and password but no UO login screen appears
- The configuration file may need to be replaced. Instructions for updating the configuration file can be found above in the Installation Steps section.
The login or Duo screen appears but one or both are blank
- Close the window with the X and try launching again.
I'm encountering additional issues with installing the client
Virtual Print Driver Installation (Optional)
The Virtual Print Driver is installed automatically if installing the Unity Client via Software Center. If you have installed the Unity client via UO Software Downloads and would like to install the Virtual Print Driver, you may do so by following the steps in the Installing the OnBase Virtual Print Driver for the Unity Client article.