OnBase Unity API Interface

DNAX Name: OnBaseUnity.dnax

Application ID: 373de0c0-aa89-402a-a784-8b61005756bc
OnBase Unity API Interface Fiserv

© 2016-2022 Fiserv, Inc. or its affiliates. All rights reserved. This work is confidential and its use is
strictly limited. Use is permitted only in accordance with the terms of the agreement under which it
was furnished. Any other use, duplication, or dissemination without the prior written consent of
Fiserv, Inc. or its affiliates is strictly prohibited. The information contained herein is subject to
change without notice. Except as specified by the agreement under which the materials are
furnished, Fiserv, Inc. and its affiliates do not accept any liabilities with respect to the information
contained herein and is not responsible for any direct, indirect, special, consequential or
exemplary damages resulting from the use of this information. No warranties, either express or
implied, are granted or extended by this document.
http://www.fiserv.com
Fiserv is a registered trademark of Fiserv, Inc.
Other brands and their products are trademarks or registered trademarks of their respective
holders and should be noted as such.

OnBase Unity API Interface 2 August 2022

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates
OnBase Unity API Interface Fiserv

Table of Contents
OnBase Unity API Interface .............................................................................................. 4
Overview ................................................................................................................... 4
Key Benefits .............................................................................................................. 4
Exclusions ................................................................................................................. 5
Institution Option ....................................................................................................... 5
System Variables ...................................................................................................... 5
Real-Time Interaction with Other Applications .......................................................... 6
What You Should Do ................................................................................................. 7
In This Document ...................................................................................................... 8
Setting Up the External System User for OnBase ........................................................ 9
Overview ................................................................................................................... 9
Field Descriptions ...................................................................................................... 9
Procedures ................................................................................................................ 9
Additional Requirements ............................................................................................. 12
Installation Instructions ................................................................................................ 12
Configuration Checklist ............................................................................................... 12
Revisions..................................................................................................................... 13

OnBase Unity API Interface 3 August 2022

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates
OnBase Unity API Interface Fiserv

OnBase Unity API Interface

Overview
The OnBase Web Services API was sunset by Hyland. The OnBase Unity API Interface
DNAapp replaces the existing OnBase Web Services functionality with corresponding
Unity API calls. As most of this interaction occurs in the background, few visible changes
are apparent to the user.
The OnBase Unity API Interface DNAapp is a purchase only app. It is not available for
trial.
Note: Nautilus customers should not use this app. The OnBase Unity API Interface
DNAapp is intended for use by Hyland OnBase customers only.
The Unity API interface is used with the following:
• The BusinessServices.dnax, which contains capabilities for archiving documents to
OnBase.
• The DocuSign eSignature Archive application used to archive documents to OnBase.
• The display of driver’s license images in the banner on the Relationship Profile and
Transaction Express screens when the existing Display Person ID on Banner (DPID)
institution option is set to Y and the existing OnBase PersID Banner Display (OBID)
variable is set to Y.
Note: When the Document Storage Type (DOST) variable is set to ONBS, the most
recent image displays in the banner on the Relationship Profile and Transaction Express
screens irrespective of whether the UPDATE PRIMARY ID checkbox is selected or cleared
on the Documents screen when the driver’s license image is archived.
The document storage user ID and password were migrated to SAF for non-Windows
authentication.

Key Benefits
The OnBase Unity API Interface provides a real-time, two-way interface between DNA
and Hyland’s OnBase Enterprise Content Management (ECM) software. Using this
DNAapp, DNA users can transmit signature-embedded receipts, signature-embedded
WMF forms created in DNA such as signature cards and scanned ID documents such as
a driver’s license to OnBase. In addition, this module provides the ability to view in DNA
documents stored at the OnBase repository.
The OnBase Unity API Interface DNAapp provides the following key benefits:
• The OnBase Web Services functionality is replaced with corresponding Unity API
calls. The OnBase ActiveX controls are replaced with a Web browser control that
displays new versions of the ActiveX controls rendered from the OnBase Web
server. The appearance and functionality is the same as the previous versions.
• The External Documents screen and associated OnBase functionality is moved from
core DNA to the OnBase Unity API Interface DNAapp and enhanced to use the
DocPop feature of OnBase using a Unity API interface.

OnBase Unity API Interface 4 August 2022

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates
OnBase Unity API Interface Fiserv

• Improved error logging and reporting. Error messages displayed through the user
interface are more descriptive.

Exclusions
• OnBase ActiveX controls with other methods to support non-Internet Explorer
browsers.
• Document slideout, and Relationships Dashboard screens using the Unity API
interface are not supported.

Institution Option
The OnBaseUnity Document Storage (ONBU) institution option enables the OnBase
Unity API feature when set to Y; otherwise, when set to N, the feature is disabled.

System Variables
The following system-level variables are used with the OnBase Unity API feature:
Variable Description
Document Storage Authentication type used to connect to OnBase.
Auth Type (DOAU) Windows = Windows authentication. Default.
Standard = OnBase authentication.
Document View Underlying technology used to display documents on the Unity API
OnBase ClientTyp External Documents screen using the DocPop feature. ActiveX is
(DOVP) the only option available initially.
Note: Refer to the Hyland manuals to configure the Web server’s
Web.Config file for DocPop.
Document View DocPop URL on the OnBase server. The URL is used by the Unity
OnBase URL (DOVU) API External Documents screen to display an OnBase web page
containing a list of documents that can be viewed.

These variables are in the Inst Processing (BANK) calculation type under the Inst
Processing (BANK) calculation category.
The following system-level variable has been added to the User Interface Display
Options (UIDO) calculation type and is used with the OnBase Unity API application:

OnBase Unity API Interface 5 August 2022

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates
OnBase Unity API Interface Fiserv

Variable Description
Launch Web Browser The following option values have been added:
(LWBR) • Default Web Browser (DEFA) -This will open the app in the
browser designated as the default on the machine.
• Internet Explorer (IE) -This will open the app in Internet
Explorer
• Microsoft Edge (EDGE) -This will open the app in Microsoft
Edge Note: This option has been added for backward
compatibility only as IE 11 is no longer supported by
Microsoft.
• Google Chrome (CHRM) – This will open the app in Chrome
Note: This variable does not just control OnBase Unity API
Interface. Refer to the DNA Chromium Support for Chrome section
in the DNA 2022.3 documentation for additional information.

Real-Time Interaction with Other Applications

The optional DocuSign module can be used to manage the preparation, sending,
signing, tracking, and archiving of signature cards and other financial institution
documents.

OnBase Unity API Interface 6 August 2022

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates
OnBase Unity API Interface Fiserv

What You Should Do

To convert from the OnBase Web Services to the Unity API interface, you must do the
following:
• Obtain a Hyland Web server license.
• Set the OnBaseUnity Document Storage (ONBU) institution option to Y. See the
“Institution Options” online Help topic for detailed instructions.
Navigate to System > Institution > Institution Options.
• Set the values of the following variables at the system level:
• Document Storage Auth Type (DOAU)
• Document View OnBase URL (DOVU)
See the “System-Level Variables” online Help topic for detailed instructions.
Navigate to System > Institution > Variables.
• Set up the external system user for OnBase based on the authentication type set in
the Document Storage Auth Type (DOAU) variable. See Setting Up the External
System User for OnBase in this document for detailed instructions.
• Refer to the Hyland OnBase Interface setup section in the DNA Release 3.0 Add-On
Module document on the extranet for the base configuration before using the
OnBase Unity API Interface DNAapp.
• Hyland ActiveX Controls version 12 must be installed on every machine at a
minimum. The Hyland ActiveX Controls that match the OnBase version must be
installed on each machine. For example, if OnBase Version 13 is in use, versions 12
and 13 of the controls must be installed.
• For DocPop configuration, the following options must be set in the Web server’s
Web.Config file. For standard configuration, the key settings are:
• DataSource – must match the data source set in the Document Storage Data
Source (DOSD) variable in the Inst Processing (BANK) calculation type.
Navigate to System > Institution > Variables.
• Embedded – must be set to True.
For more detail about DocPop configuration, refer to Hyland’s DocPop
documentation. Contact your Hyland support group if you do not have this
documentation.

OnBase Unity API Interface 7 August 2022

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates
OnBase Unity API Interface Fiserv

In This Document
The following topics are included in this document:
• Setting Up the External System User for OnBase
• Additional Requirements
• Installation Instructions
• Configuration Checklist
• Revisions

OnBase Unity API Interface 8 August 2022

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates
OnBase Unity API Interface Fiserv

Setting Up the External System User for OnBase

Overview
External system users must be set up for the authentication type set in the Document
Storage Auth Type (DOAU) variable. The authentication set in DOAU takes effect for all
communication with OnBase.
Windows Authentication Standard Authentication
Business Services User ID for the credentials stored in User ID for the credentials
(workflows) the external system for OnBase stored in the external system
must be formatted as for OnBase must be
<Domain>\<UserID> formatted as only the OnBase
<UserID>

Field Descriptions
The following fields are used on the Form used to add and edit external system users
screen:
Field Description
External System Name of the external system, i.e., OnBase.
External User Id User ID for authentication.
If DOAU is set to Windows, the external user ID must be formatted
as domainname\userID.
If DOAU is set to Standard, the external user ID is only the OnBase
user ID.
Password Password for the user ID.
Re-enter Password Verification of the password for the user ID.
Effective Date Date the external user ID and password takes effect.
Inactive Date Date the external user ID and password inactivates.

Procedures

Prerequisites
None

Restrictions
None

Related Procedures
None

Navigation
SAF > Administration> External System> Users

OnBase Unity API Interface 9 April 2021

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates
OnBase Unity API Interface Fiserv

Steps
Follow the steps below to maintain the OnBase user for standard or Windows
authentication.
1. On the Form used to add and edit external system users screen,
Example of Windows authentication

Example of standard authentication

a. Select the OnBase user in the External System Users grid.

b. Click Edit.

OnBase Unity API Interface 10 August 2022

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates
OnBase Unity API Interface Fiserv

The User Details group box enables.

c. Type the user ID in the format required for the authentication set in the Document
Storage Auth Type (DOAU) variable.
d. If applicable, type a new password in the PASSWORD and RE-ENTER PASSWORD
fields.
e. If applicable, type or select a new effective date in the EFFECTIVE DATE field.
f. If applicable, type or select the date the user inactivates in the INACTIVE DATE
field.
g. Click the Review radio button.
h. Click Process.
2. To return to the previous screen (if not displayed), click Close.

OnBase Unity API Interface 11 August 2022

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates
OnBase Unity API Interface Fiserv

Additional Requirements
Before executing this DNAapp, the following prerequisites must be met:
• DNA® Release 2022.3 or higher
• Adobe 11.0.15 or higher
• Requires purchase or subscription to a third-party solution – OnBase by Hyland
version 20 or higher. Third-party solution is not included in the price of this app.
The OnBase Unity API Interface DNAapp offers optional integration with DocuSign (no
minimum level required) that must be purchased and configured to use the associated
functionality.
Note 1: Significant changes by third-party vendors to their systems, files, and integration
approaches that impact the functionality of this DNAapp are not covered under
maintenance.
Note 2: Contact your third-party solution provider for instructions on configuring your
third-party solution.

Installation Instructions
If you are an in-house client, follow the installation instructions available in the
"DNAapps" section of the DNA Help files available on the extranet.
If you are a data center client, a case is automatically created when you order a trial or
paid version of a DNAapp and routed to the Data Center team for installation. Data
center DNAapp installation typically takes two weeks; however, the time frame varies
depending on the complexity of the app, case load, and the responsiveness of the client
and/or third parties.
The What You Should Do section contains step-by-step setup instructions. Specific
setup and procedural topics for specific features of the DNAapp are also included in this
document. The topics are listed in the In This Document section.

Configuration Checklist
Item Test Environment Production Environment
Institution Option
System-Level Variables
External System User
Hyland OnBase Interface
Hyland ActiveX Controls
Hyland Web Server’s
Web.Config File

OnBase Unity API Interface 12 August 2022

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates
OnBase Unity API Interface Fiserv

Revisions
Date App Version # Change
08/2016 1.0.0.0 Application created
04/2017 2.0.0.0 Prerequisites of DNA 4.2.4.0 and applicable hot fixes added
02/2019 4.5.1.2 Prerequisite of DNA 4.5.1.0 added due to repackaging of
application for use with the New Deposit Account Wizard
(NDAW) changes in that release
07/2019 4.5.2.0 This DNAapp version is certified for use with Unity API
(version 17) and DNA 4.5.2.0.
In additional, minor cosmetic updates were made to the
document. No functional information was changed.
07/2020 4.6.2.1 Calls were optimized by utilizing caching to improve
performance.
Enhanced keyword support in NDAW (to benefit from this
enhancement, DNA 4.6.2.0 or higher is required).
04/2021 4.6.2.1 Modified confidentiality statement in footers
08/2022 22.3.0.2 Prerequisite of DNA 22.3 added. DNA Chromium support for
Chrome feature added.

OnBase Unity API Interface 13 August 2022

Fiserv Confidential: Distribution restricted to:
• Clients using or considering purchase of the product described in this document
• Fiserv associates