Client Installer - Onbase 18 Module Reference Guide

Client and Configuration Installers
Version 18
Copyright
Information in this document is subject to change without notice. The OnBase® software (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 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.
© 2018 Hyland Software, Inc. All rights reserved.
Depending on the modules licensed, the OnBase® software may include software developed and copyrighted
by third parties, including but not limited to the following:
A2iA CheckReader™ by A2iA Corp;
Adobe® PDF Library™ by Adobe Systems Incorporated;
dtSearch® Text Retrieval Engine by dtSearch Corp.;
software or other content adapted from Smart Client – Composite UI Application Block by Microsoft
Corporation © 2005 Microsoft Corporation;
software or other content adapted from Microsoft patterns & practices ObjectBuilder © 2006 Microsoft
Corporation;
Nuance™ OCR © 1994-2012 Nuance Communications;
portions of imaging code owned and copyrighted by Pegasus Imaging Corporation, Tampa, FL;
Imaging Technology copyrighted by Snowbound Software Corporation, Snowbound.com;
CD-R technology by Sonic Solutions, Inc.;
full-text indexing technology by Autonomy;
IDSMail © 2005 by Intuitive Data Solutions;
jLex Copyright 1996-2003 by Elliot Joel Berk and C. Scott Ananian;
Rumba by NetManage;
AutoVue by Oracle America, Inc.
Streaming Powered by Wowza Streaming software
All rights reserved.
Further information regarding third-party software included in OnBase can be found in the About box within
the Software.
Hyland, Hyland Software®, and OnBase® are registered and/or unregistered trademarks of Hyland Software,
Inc. in the United States and other countries. A2iA CheckReader™ is a trademark of A2iA Corporation.
Adobe® PDF Library™ is a trademark of Adobe Systems Incorporated.
All other trademarks, service marks, trade names and products of other companies are the property of their
respective owners.
Document Name ............................................................................... Client and Configuration Installers
Department/Group.......................................................................................................... Documentation
Revision Number ................................................................................................................................. 18
© 2018 Hyland Software, Inc. ii

© 2018 Hyland Software, Inc. iii
Using the Module Reference Guide (MRG)
If you are unfamiliar with module reference guides (MRGs), please review the content below so
that you can more quickly and efficiently locate the information you need.
The MRG is a PDF document containing all available instructions for a module. The content in this
MRG is considered module-specific. You may be referred to another MRG if a referenced function
is not specific to this module.
Each MRG typically includes the following chapters:
• Exposure - Provides introductory information and license requirements.
• Usage - Provides procedures for user-facing functionality.
• Configuration - Provides procedures for configuration and system administration.
• Installation - Provides system requirements and installation procedures.
You can open any chapter or section in the MRG by clicking its entry in the Table of Contents.
It is considered a best practice to read through an entire procedure before attempting to complete
any of its steps. Pay close attention to notes, tips, and cautions, which can help you better
understand the entire process and discover any prerequisites you may not have completed.
The MRGs use notes, tips, and cautions to draw your attention to additional information.
Note: A note provides supplemental information or highlights behavior you might not expect.
Tip: A tip describes extra, non-crucial information, such as a shortcut, reminder, or use for a
feature you might not think of.
Caution: Cautions are designed to help protect the system from data loss or severe issues that
may arise when an instruction is not followed properly.
Cross-references are links to related information or additional instructions you may need to
complete a task. Click a cross-reference to navigate to the referenced section. To return to the
page you were viewing before following a cross-reference, press Alt + Left Arrow until the desired
page is displayed.
Searching: The following search instructions pertain to viewing an MRG in Adobe Reader or Adobe
Acrobat. Some information may not apply to other PDF readers.
• Basic search: Press Ctrl + F . Enter the word or phrase you are looking for in the search
box and press Enter to locate each instance.
• Advanced search: Press Ctrl + Shift + F to find all instances of a phrase in an MRG or
folder. In the Search dialog box, enter the word or phrase you are looking for, and then
select one of the following options:
• In the current document - Searches the document you are viewing.
• All PDF Documents in - Searches a selected folder or directory. If you are unsure of
which MRG to search, try searching the folder where your MRGs are located to
display all results for the word or phrase.
© 2018 Hyland Software, Inc. iv

Table of Contents
Using the Module Reference Guide (MRG) ........................................................................................iv
EXPOSURE
Requirements ............................................................................................................................................1
Client Module Supported Operating Systems .................................................................................................... 1
.NET Framework Requirements .......................................................................................................................... 1
Microsoft Visual C++ Requirements ................................................................................................................... 2
Processing Workstation Minimum Hardware Requirements............................................................................ 2
Client Retrieval Workstation Hardware Requirements ...................................................................................... 2
Databases Supported .......................................................................................................................................... 3
Microsoft SQL Server ................................................................................................................................... 3
Oracle ............................................................................................................................................................ 3
SAP SQL Anywhere ...................................................................................................................................... 4
Database/File Servers.......................................................................................................................................... 4
Database Client / Server Compatibility............................................................................................................... 4
.NET Framework................................................................................................................................................... 5
Remote Desktop Environment Considerations .................................................................................................. 5
System Assessment Tool.................................................................................................................................... 5
Third-Party Software Compatibility ..................................................................................................................... 6
About Virtual Environments................................................................................................................................. 6
64-Bit Support Statement .................................................................................................................................... 6
Windows User Account Control Statement ........................................................................................................ 7
Modifying Configuration Files ..................................................................................................................... 7
INI File ................................................................................................................................................................... 7
Previous File Location/File Name ............................................................................................................... 8
Location ........................................................................................................................................................ 8
INI Considerations in a Citrix and Microsoft Windows Remote Desktop Environment ........................... 8
Editing the INI File ......................................................................................................................................... 9
Authenticode Signature Verification ................................................................................................................... 9
Enabling Authenticode Signature Verification ............................................................................................ 9
Disabling Authenticode Signature Verification ......................................................................................... 10
Modifying Configuration Files ................................................................................................................... 10
Administrative Installations ............................................................................................................... 10
Skip Persistence..................................................................................................................................... 11
CLIENT INSTALLER
Overview ................................................................................................................................................. 12
Installer Overview................................................................................................................................. 13
Installer Prerequisites ........................................................................................................................................ 14
Installer User Permissions................................................................................................................................. 15
Installer .NET Framework Requirements.......................................................................................................... 15
Windows User Account Control Statement ...................................................................................................... 15
OnBase 18
©2018
v
Hyland Software, Inc.
Table of Contents

ODBC ................................................................................................................................................................... 16
Components Requirements................................................................................................................. 16
Installation .............................................................................................................................................. 16
Running the Client Installer................................................................................................................................ 16
Silent Installation Using setup.exe ............................................................................................................ 16
Installation Using the Graphical User Interface ........................................................................................ 17
INI File ................................................................................................................................................................. 23
Previous File Location/File Name ............................................................................................................. 24
Location ...................................................................................................................................................... 24
INI Considerations in a Citrix and Microsoft Windows Remote Desktop Environment ......................... 24
Editing the INI File ....................................................................................................................................... 25
Change, Repair, or Remove an Installation ....................................................................................................... 25
Client Installer Command Line Options ........................................................................................... 26
Feature Names ................................................................................................................................................... 26
Folder Variables ................................................................................................................................................. 27
Shortcut Switches .............................................................................................................................................. 27
Data Source Variables ....................................................................................................................................... 28
Shortcuts............................................................................................................................................................. 28
DCOM Configuration .......................................................................................................................................... 29
Troubleshooting .................................................................................................................................... 29
Authenticode Signature Verification ................................................................................................................. 29
Enabling Authenticode Signature Verification .......................................................................................... 30
ODBC Setup for a Windows 64-bit Workstation ............................................................................................... 30
Contacting Support ............................................................................................................................... 30
CONFIGURATION INSTALLER
Overview ................................................................................................................................................. 32
Installer Overview................................................................................................................................. 32
Installer Prerequisites ........................................................................................................................................ 34
Installer User Permissions................................................................................................................................. 34
Installer .NET Framework Requirements.......................................................................................................... 34
Windows User Account Control Statement ...................................................................................................... 34
ODBC ................................................................................................................................................................... 35
Components Requirements................................................................................................................. 35
Installation .............................................................................................................................................. 35
Running the Configuration Installer .................................................................................................................. 35
Silent Installation Using setup.exe ............................................................................................................ 36
Installation Using the Graphical User Interface ........................................................................................ 36
INI File ................................................................................................................................................................. 41
OnBase 18
©2018
vi
Table of Contents
Previous File Location/File Name ............................................................................................................. 42

Location ...................................................................................................................................................... 42
INI Considerations in a Citrix and Microsoft Windows Remote Desktop Environment ......................... 42
Editing the INI File ....................................................................................................................................... 43
Change, Repair, or Remove an Installation ....................................................................................................... 43
Configuration Installer Command Line Options ............................................................................ 44
Feature Name ..................................................................................................................................................... 44
Folder Variable ................................................................................................................................................... 44
Shortcut Switches .............................................................................................................................................. 44
Data Source Variables ....................................................................................................................................... 45
Shortcuts............................................................................................................................................................. 45
Troubleshooting .................................................................................................................................... 46
Authenticode Signature Verification ................................................................................................................. 46
Enabling Authenticode Signature Verification .......................................................................................... 46
ODBC Setup for a Windows 64-bit Workstation ............................................................................................... 47
Contacting Support ............................................................................................................................... 47
CLIENT COMMAND LINE SWITCHES

Command Line Switches ...................................................................................................................... 48
API Options......................................................................................................................................................... 48
-DDE ............................................................................................................................................................. 48
-DISCONNECT ............................................................................................................................................. 48
-DONT_FORCE_BROKER_EXIT ................................................................................................................... 48
-MZAPP# ..................................................................................................................................................... 48
-NOBROKER ................................................................................................................................................ 48
-OBAPP# ..................................................................................................................................................... 49
-OLEAPI ....................................................................................................................................................... 49
-USE_TERMINATE_BROKER ....................................................................................................................... 49
Login Options ..................................................................................................................................................... 49
-AL ............................................................................................................................................................... 49
-LT=“HH:MM” .............................................................................................................................................. 49
-RT=“HH:MM” .............................................................................................................................................. 49
-ODBC .......................................................................................................................................................... 50
-PW .............................................................................................................................................................. 50
-UN ............................................................................................................................................................... 50
Running OnBase as a Windows Service ........................................................................................................... 50
-SERVICE=“SERVICE NAME” ...................................................................................................................... 50
-STARTMINIMIZED ..................................................................................................................................... 50
Server Options .................................................................................................................................................... 51
-QUIETDISCONNECT .................................................................................................................................. 51
-SE ................................................................................................................................................................ 51
-SWREQ ....................................................................................................................................................... 51
OnBase 18
©2018
vii
Table of Contents
System/Debugging Options .............................................................................................................................. 51

-DUMP ......................................................................................................................................................... 51
-V .................................................................................................................................................................. 51
User Options ....................................................................................................................................................... 53
-CE ............................................................................................................................................................... 53
-DL ............................................................................................................................................................... 53
-DTGAPPLY ................................................................................................................................................. 53
-INIFILE="[Full Path]\[File Name]" .............................................................................................................. 53
-NOSTATUS ................................................................................................................................................. 54
-NOUI ........................................................................................................................................................... 54
-ROMANZO .................................................................................................................................................. 54
-SEEDINI ...................................................................................................................................................... 54
SYSTEM ASSESSMENT TOOL

Using the System Assessment Tool ................................................................................................... 55
OnBase 18
©2018
viii
EXPOSURE
The Client and Configuration installers are used to install the basic components required to
deploy OnBase including the Client and Configuration modules, Mail Services, OnBase Client
API, and DCOM Configuration. They also provide an automatic upgrade method, and the Client
installer can deliver the EDI Framework installer required by RCM.
Requirements
This section explains the common requirements that all of the components that can be
installed by the OnBase Client and Configuration installers must meet. The specific
components installed may have additional requirements to complete a successful deployment,
beyond these requirements. Before installation, it is a best practice to refer to the separate
documentation for the components being installed to ensure that any additional requirements
are met.
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.
Client Module Supported Operating Systems

• Windows Server 2008 R2 SP1 or later service pack
• Windows 7 SP1 or later service pack
• Windows 8.1
• Windows Server 2012 R2
• Windows 10 (1607 Anniversary Update, 1703 Creators Update, or 1709 Fall Creators
Update)
• Windows Server 2016
Note: As of OnBase 16, the Windows Vista, Windows 8, Windows Server 2008, and Windows
Server 2012 operating systems are no longer supported. If you are using any of these operating
systems, you should not upgrade to OnBase 18 until you have upgraded to a Windows
operating system supported by OnBase. For a complete list of operating systems that are no
longer supported, see the Technical Requirements Overview for New Installations and
Upgrades document.
.NET Framework Requirements

OnBase requires Microsoft .NET Framework 4.6 or later. The .NET Framework can be obtained
from the Microsoft Download Center at http://www.microsoft.com/downloads.
OnBase 18 1
©2018
Exposure
Microsoft Visual C++ Requirements

The Microsoft Visual C++ 2015 Redistributable Package (x86) is required. If not already present
on your system, this package is installed when the setup.exe installer is used to install the
OnBase Client or Configuration modules.
Processing Workstation Minimum Hardware

Requirements
Hardware Minimum Requirement
Memory (RAM) A typical processing station can run on as little as 64 MB in

addition to the amount of memory required to run the operating
system. OS requirements vary greatly.
Free Hard Disk Space 200 MB (system files and OnBase software)
Screen Resolution 1024 x 768 (1280 x 800)
Note: Using a lower resolution may result in a loss of

functionality.
Client Retrieval Workstation Hardware Requirements
Hardware Minimum Recommended
CPU 1 GHz 2 GHz or faster
Memory (RAM) • 32-bit OS: 1 GB 4 GB

• 64-bit OS: 2 GB
Free Hard Disk Space 2 GB 2 GB or greater

(total for installation
itself and post-
installation files)
Screen Resolution 1024 x 768 (1280 x 800) 1280 x 1024 (1440 x 900 widescreen)
Note: Using a lower

resolution may result in a loss
of functionality.
OnBase 18 2
©2018
Exposure
Databases Supported
The following sections list the databases supported in OnBase 18.
Microsoft SQL Server

The following versions of Microsoft SQL Server™ are supported:
• Microsoft SQL Server 2008 (RTM, SP1, SP2, SP3, or SP4)
• Microsoft SQL Server 2008 R2 (RTM, SP1, SP2, or SP3)
• Microsoft SQL Server 2012 (RTM, SP1, SP2, SP3, or SP4)
• Microsoft SQL Server 2014 (RTM, SP1, or SP2)
• Microsoft SQL Server 2016 (RTM or SP1)
• Microsoft SQL Server 2017 (for Windows or Linux)
When using Microsoft SQL Server databases, also note the following:
• Microsoft SQL Server 2008 and Microsoft SQL Server 2008 R2 are being deprecated
for eventual removal from the OnBase product suite. SQL Server 2008 and 2008 R2
are supported in OnBase 18; however, they will not be available in OnBase 19 and
subsequent versions of OnBase. If you are currently using either Microsoft SQL
Server 2008 or Microsoft SQL Server 2008 R2, Hyland Software recommends using
Microsoft SQL Server 2012 or later to fulfill your needs.
• In April 2016, Microsoft discontinued technical support for Microsoft SQL Server
2005. As of release 17, Hyland Software no longer supports SQL Server 2005.
• If you are using an ODBC data source to connect to the database, you must ensure
that your SQL Server database client software version matches or exceeds the
database server version. For example, if your database server is SQL Server 2012,
verify that the database client is SQL Server 2012 (or later). Running a previous client
version, such as SQL Server 2008, will result in system instability and memory issues.
For instructions on determining your server and client versions, see Database Client /
Server Version Compatibility.
Oracle
The following versions of Oracle ® are supported:
• Oracle 11g (R2)
• Oracle 12c (R1 or R2)
Note: All Oracle 11g and 12c drivers can be used.
Note: If you are using an Oracle database, it is strongly recommended that you have a certified
Oracle Database Administrator on staff.
OnBase 18 3
©2018
Exposure
SAP SQL Anywhere

Support for SAP SQL Anywhere™ databases is being deprecated for eventual removal from the
OnBase product suite. Beginning in OnBase 18, new customers are required to use a supported
version of a Microsoft SQL Server or Oracle database. However, the following versions of SAP
SQL Anywhere are still supported for existing customers:
• SAP SQL Anywhere 16
• SAP SQL Anywhere 17
Beginning in OnBase 19, SAP SQL Anywhere databases will no longer be supported.
Note: On December 31, 2016, SAP retired engineering support for SQL Anywhere versions 12.x
and lower. As of OnBase 17, Hyland Software no longer supports SQL Anywhere versions 12.x
and lower.
Database/File Servers
Server requirements are site-specific. Database/file servers should be dedicated purpose
servers; that is, these servers should not be used as a domain controller, email server, print
server, or proxy server. Network and disk I/O hardware should be optimized for performance
and redundancy. Multiple network interface cards on servers are often required to minimize
network bottlenecks.
Database Client / Server Compatibility

Due to critical issues that have been reported, Hyland Software strongly recommends the
following:
• Ensure that your database client software version matches or exceeds the database
server version.
• Ensure that you are running the most recent version of the database client.
This will help to reduce compatibility issues and minimize troubleshooting time when issues do
occur.
Your database administrator can determine the database server version and identify the most-
recent version of the database client software. The ODBC driver number indicates which
version of the database client software you are using. For example, if your database server
software is Oracle 12 Release 1, verify that the Oracle Client software is Oracle 12 Release 1 (or
later). The same is true of SQL databases. For example, if your database server is SQL Server
2012, verify that the database client is SQL Server 2012 (or later).
OnBase 18 4
©2018
Exposure
To check your database client version, perform the following steps from the workstation or
server where the ODBC connection is configured:
1. Open your ODBC Data Source Administrator, and click on the Drivers tab.
2. Select the driver you are using to connect to your OnBase database.
• If your database server software is Oracle 12 Release 1, the version number should
appear as 12.1.[#.#.#] (or later), where 12.1 is the version number and [#.#.#]
represents the service pack.
• If your database server software is any version of Microsoft SQL Server, select ODBC
Driver 13 for SQL Server .
The above descriptions are examples of two commonly used database version schemes.
Ensure that the supported database you use adheres to the database client/server
recommendation. In general, Hyland Software recommends that you use the most current
drivers that correspond to your system.
.NET Framework
The installer must be run on a machine that meets the .NET Framework requirements of the
module being installed. The installer checks for the required version of the .NET Framework
and, if it is not installed, the installation will exit. The .NET Framework is not installed by the
installer if it is missing.
Module requirements can be found in the installation chapters of the corresponding module
reference guides. The .NET Framework can be obtained from the Microsoft Download Center at
http://www.microsoft.com/downloads .
Remote Desktop Environment Considerations

In Remote Desktop environments, a remote session is established in which the user is running
applications that are not installed locally. OnBase functionality accessed via Remote Desktop
Services remains exactly the same. There are, however, some additional considerations that
have to be made when deploying any application in this way, including OnBase.
Additional details regarding the deployment of OnBase in a remote desktop environment is
discussed in detail in the Citrix and Microsoft Windows Remote Desktop Environment
Deployment Guide , available from your first line of support.
System Assessment Tool

The System Assessment Tool helps to ensure that workstations meets the minimum system
requirements for the 18 OnBase Client, Unity Client, and Web/Application Server. It is an
optional tool that can be used when deploying or upgrading workstations to OnBase 18.
Tip: For complete details on using this tool, see System Assessment Tool on page 55.
OnBase 18 5
©2018
Exposure
Third-Party Software Compatibility

OnBase is used in conjunction with a variety of third-party software products. The specific
versions of third-party software that are supported are documented in the requirements
sections of this manual, which reflect the versions that were required at the time this manual
was published.
For up-to-date information, visit the following site: https://www.onbase.com/community/
technical_communities/third_party_software_updates/default.aspx.
About Virtual Environments

Hyland Software develops, tests, and supports the OnBase suite of products on specific
Operating Systems, not specific hardware configurations. When OnBase is operated in a virtual
environment (such as Citrix, VMware, Hyper-V, or Windows Remote Desktop) there may be
limitations or subtle differences imposed by the environment. The customer and the virtual
environment vendor are responsible for any interactions or issues that arise at the Hardware or
Operating System layer as a result of their use of a virtual environment.
When it appears that a performance-related issue in OnBase is either caused by (or is unique
to) the virtual environment, organizations may be asked to validate that the issue occurs in a
non-virtual environment. Hyland Software will make this request if there is reason to believe
that the virtual environment is a contributing factor to the issue.
Each OnBase site is unique. Hyland Software depends on the customers who deploy OnBase in
virtual environments to do so only after careful design and adequate planning (that takes into
account the workloads of your organization), and in accordance with recommendations
provided by the virtual environment’s vendor. As with any implementation, Hyland Software
strongly recommends that any customer deploying the OnBase solution in a virtual
environment thoroughly test the solution before putting it into production.
For information about using OnBase in a Citrix and Microsoft Windows Remote Desktop
environment, please see the Citrix and Microsoft Windows Remote Desktop Environment
Deployment Guide , available on the Hyland Community (https://www.onbase.com/
community).
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. However,
OnBase modules that integrate with third-party applications may not be able to be used with
the 64-bit versions of these applications. For these modules, only the 32-bit versions of these
third-party applications are currently supported by the OnBase integrations. Consult the
module-specific requirements section in each module reference guide for complete
requirements details.
Supported database versions that are deployed on a 64-bit database server are also supported.
For more information, contact your solution provider.
OnBase 18 6
©2018
Exposure
Windows User Account Control Statement

Hyland Software is dedicated to ensuring that OnBase is compatible with Windows User
Account Control (UAC). UAC is a feature of Windows operating systems that was introduced
with Windows Vista. It limits the ability of standard users to make global system changes to a
workstation and prevents malicious software from making unauthorized changes to protected
areas.
For details on UAC, refer to your Microsoft support information or see http://
technet.microsoft.com/en-us/library/cc709691(WS.10).aspx.
You may encounter UAC in OnBase when:
• Installing or uninstalling OnBase, OnBase modules, or OnBase ActiveX controls.
• Copying, moving, or saving files to the Program Files directory, Windows directory, or
another protected location.
• Modifying system-wide settings, such as the registry.
• Re-indexing a document or opening a scanned batch using published Internet
Explorer from a Remote Desktop Server.
If Windows UAC is enabled, the above operations may prompt for administrator privileges or
credentials, even if an administrator is currently logged on.
Modifying Configuration Files

When UAC is enabled, administrators may be unable to modify Web.config or other *.config
files. To address this issue, the administrator should open a text editor (such as Notepad) by
right-clicking it and selecting Run as administrator . The administrator can then open the
*.config file from within the text editor. Because the text editor is running with administrator
privileges, the configuration file can be modified and saved using that application.
INI File
INI files (initialization files) are plain-text files that contain configuration information. These
files are used by Windows and Windows-based applications to save and access information
about your preferences and operating environment. OnBase uses an initialization file named
onbase32.ini. If a user does not have rights to access the onbase32.ini file, that user will be
unable to use the Client or Configuration modules.
The onbase32.ini file is primarily used to store settings specified in the Client or Configuration
module. For example, when a user selects a default data source in the OnBase Client’s
Workstation Options dialog box, this selection is saved to the onbase32.ini file. The
onbase32.ini file is also used to make modifications to OnBase modules that cannot be made
through the module’s interface.
OnBase 18 7
©2018
Exposure
Previous File Location/File Name

Every version of the OnBase Client prior to 8.2.0 used an INI file named OnBase.ini. In OnBase
8.2.0 and subsequent versions, the INI file was moved to a new location to be consistent with
changes Microsoft has made to Windows. Since the location has changed, the name of the file
has also been changed to alleviate some confusion between the needs of OnBase 8.2.0 and
installations of older executables. The new file name is onbase32.ini.
Location
For all currently supported operating systems (i.e., Windows 7 SP1 or later), the default location
of the onbase32.ini file is C:\ProgramData\Hyland Software . For previous versions of OnBase
running on older operating systems, the default location of the onbase32.ini file may have been
different (e.g., C:\Documents and Settings\All Users\Application Data\Hyland Software ).
Note: To maintain backwards compatibility with previous versions of OnBase, OnBase will
check the workstation’s C:\Windows folder for the OnBase INI file if it is not found in the folder
specified above. If the OnBase INI file is found in the C:\Windows folder, OnBase will copy the
file to the new location. The previously existing version of the OnBase INI file will remain in the
C:\Windows folder, but will no longer be used by OnBase.
Your onbase32.ini file may reside in a different location, if that location is specified by the
following command line switch on the OnBase Client shortcut target:
-INIFILE= "full path\filename" , where full path and filename are replaced by the specific path
and file name.
If this command line switch is not used and you move or rename your onbase32.ini file, OnBase
will recreate the file in the default folder and ignore the newly created file.
INI Considerations in a Citrix and Microsoft Windows Remote

Desktop Environment
applications that are not installed locally. This presents a challenge when an application, such
as OnBase, requires a user-specific INI file to establish unique settings. In a Remote Desktop
environment, you must ensure that each user has a single, unique INI file to make sure any
user-specific settings are consistent for that user.
Note: The default location of the OnBase INI file is not unique in a Remote Desktop
environment.
To ensure that the INI file is accessible by OnBase and unique to each user in a Remote
Desktop environment, the -INIFILE command line switch must be applied to the OnBase Client
and Configuration shortcuts and be set to a unique location for the INI file.
Note: Additional details regarding the deployment of OnBase in a remote desktop environment
is discussed in detail in the Citrix and Microsoft Windows Remote Desktop Environment
OnBase 18 8
©2018
Exposure
Editing the INI File

Users with the Configuration Product Right can open the onbase32.ini file from the OnBase
Client by selecting Admin | Utilities | Edit INI File . When multiple onbase32.ini files exist,
opening the onbase32.ini file from the OnBase Client ensures that a user is editing the correct
onbase32.ini file instance. In most cases, this will be the onbase32.ini file residing in the
default directory described above. If an alternate location for the onbase32.ini file is specified
by the -INIFILE command line switch, the file in the specified location will be opened.
Authenticode Signature Verification

The OnBase Client and Configuration modules each require an additional configuration file to
complete a successful installation: obclnt32.exe.config and obcfg32.exe.config , for use with
the OnBase Client and Configuration module, respectively. These files are necessary under the
.NET Framework to enable or disable a check of the Authenticode signatures applied to the
OnBase executables. Authenticode is a Microsoft technology that uses digital certificates to
identify the publisher of an application to ensure the application's integrity and to verify that
the software has not been infected by any malware since it was created.
These files are located in the same directory as the OnBase Client and Configuration module
executables and are installed automatically by the Client Installer. Signature verification is
disabled by default for both executables. For more information on this topic, see: http://
support.microsoft.com/kb/936707.
Note: If you are running the OnBase Client or Configuration module via a UNC connection, and
trust is set to verify by publisher, then Authenticode signature verification must be enabled. If
trust is set to verify by UNC path, signature verification does not have to be enabled.
Enabling Authenticode Signature Verification

Locate the obclnt32.exe.config file for the OnBase Client or the obcfg32.exe.config file for the
Configuration module. To enable signature verification:
1. Open the file for editing in a plain-text editor, such as Notepad.
2. Locate the generatePublisherEvidence element.
3. Change the enabled attribute to true :
<generatePublisherEvidence enabled="true"/>
4. Save and close the file.
Note: If the machine running the executables does not have Internet access, or the speed of
the network to which it is connected is slow, it could take a noticeably long time to perform this
check, causing the application to take longer to launch.
OnBase 18 9
©2018
Exposure
Disabling Authenticode Signature Verification

Configuration module. To disable signature verification:
3. Change the enabled attribute to false :
<generatePublisherEvidence enabled="false"/>

Administrative Installations
An administrative installation creates an uncompressed source image for the products
contained in an installer.
An administrative installation can be used to make changes to any configuration files, or other
items that cannot be set on the command line or by using the installer GUI, before the installer
is run. The uncompressed installer can then be run from the uncompressed location and will
include the changes made to the source image files.
Caution: Administrative installations should not be used unless you fully understand the effect
the changes you make will have on the installation. For details on administrative installations,
see the Administrative Installation section of the Microsoft Dev Center : http://
msdn.microsoft.com/en-us/library/windows/desktop/aa367541%28v=vs.85%29.aspx.
To perform an administrative installation, execute a command like this example from the
command prompt:
msiexec /a "C:\Installer\Installer File.msi"
TARGETDIR="C:\Installer\admin" /qb
In this example, the Installer File.msi is uncompressed to the C:\Installer\admin directory.
OnBase 18 10
©2018
Exposure
After modifying the uncompressed files, the installer located at C:\Installer\admin\Installer

File.msi must be run, not the original compressed *.msi.
Note: When executing the installer from the command line, any additional options with
command-line parameters must still be applied when executing the uncompressed installer. If
parameters are not applied, the default options for those parameters are used. See the
command-line installation instructions for the specific installer you are running.
Skip Persistence
When controlling an installation from the command line, the SKIPPERSISTENCE property can
be used to ignore default values taken from a previous installation. To ignore saved values, set
the SKIPPERSISTENCE property to 1 .
When applying transforms to an installation, it is a best practice to set the SKIPPERSISTENCE
property to 1 . If this property is not included or is set to 0 (or false ), values saved from a
previous installation may overwrite the values applied using the transform.
OnBase 18 11
©2018
C LIENT INSTALLER
Overview
The OnBase Client installer is used to install the components required to deploy OnBase. The
installation wizard can be used to install the following products in the combination that best
meets your organization’s needs.
Component Description
OnBase Client The OnBase Client provides a single interface for retrieval and
management of all documents, regardless of the file type
(text, image, application, etc.). Based on security, the Client
module also provides system analysis and management tools.
The value of this module stems from the fact that you can
retrieve all types of documents from one interface, as well as
cross-references between these documents. The OnBase
Client requires an ODBC connection to the database.
Note: Installing the OnBase Client also installs the Client-side

files required for Document Composition.
Mail Services Mail Services is designed to create a single interface with a

given mail system. By default, OnBase uses Mail Services to
communicate with a specified external mail system. Mail
Services allows users to send external e-mail messages, with
user-defined e-mail recipients, subject, body text, and
attachments. When a message is sent outside of the OnBase
system, a connection is made to the mail system (e.g.,
Outlook) using Mail Services.
OnBase Client API The OnBase Client API provides an interface for programmers
to extend the functionality of the OnBase Client through the
use of scripts and custom applications. The Client installer
installs the API in local mode only.
DCOM Configuration This component installs and enables the DCOM settings that
can be configured to allow the OnBase Client API to operate in
a distributed environment (i.e., across networked computers).
Without this component, the API only works in local mode.
Note: The specific DCOM settings must still be configured by

an administrator after installation.
OnBase 18 12
©2018
Client Installer
EDI Framework Delivers the EDI Framework installer, a third-party installer

used to install the EDI Framework, which is required by RCM
modules to perform EDI processing. See the RCM module
reference guides for details on running this installer.
Installer 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 http://msdn.microsoft.com/
en-us/library/aa367988.aspx.
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.
OnBase 18 13
©2018
Client Installer
For more information on Microsoft’s ClickOnce technology see

http://msdn.microsoft.com/en-us/library/142dbbz4(VS.80).aspx.
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 http://technet.microsoft.com/en-us/library/cc759262(WS.10).aspx.
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.
Installer Prerequisites
The installer must be run on operating systems that support the Windows® Installer 3.0+
architecture.
OnBase 18 14
©2018
Client Installer
The installer setup executable ( setup.exe ) detects most of the prerequisites for the module
that are also required for installation and installs them, if necessary. If the installer fails to run,
install all of the requirements for the module separately before relaunching the installer.
reference guides.
Note: If installation is being performed using the installer MSI file, the requirements for the
module must be installed before launching the installer.
Installer User Permissions

You must be logged on to the installation machine with administrator privileges in order to run
the installer.
If installing under Windows operating systems with UAC enabled, the installer must be run with
elevated administrator privileges, even if the user currently logged in is an administrator.
Installer .NET Framework Requirements


areas.
OnBase 18 15
©2018
Client Installer

ODBC
There must be at least one ODBC connection configured on the machine that is running the
Client installer. If there are no ODBC connections configured, a Failed to enumerate data
sources error is encountered and the Client installer cannot be run.
Tip: The names of all configured ODBC connections for the workstation are available in the
data source drop-down select list when logging in to OnBase. When configuring a connection, it
is a best practice to use a name that makes sense to the data source it refers to. For example,
OnBase Production DB instead of DB1 or OBSERVER .
Components Requirements
See Requirements on page 1, in the Exposure chapter of this manual.
Installation
The Client installer can be run from an installation CD or a local drive. If upgrading from a
previous installation that used the Client installer, it is not necessary to uninstall the old
components before running the installer.
Running the Client Installer

The installer can be run silently or using the graphical user interface.
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
OnBase 18 16
©2018
Client Installer
Tip: For complete details on the command-line parameters available, see Client Installer
Command Line Options on page 26.
Installation Using the Graphical User Interface

To run the installer with the graphical user interface:
1. Double-click setup.exe , or launch it using Start | Run from the Windows task bar. The
OnBase Client welcome screen is displayed.
If another version of the OnBase Client is installed, a prompt is displayed asking if you
would like to upgrade the current installation.
• Click No to cancel the installation and exit the installer.
• Click Yes to install the newer version of the OnBase Client.
Note: A previous version of the OnBase Client can be removed using the Add/Remove
Programs function in the Windows Control Panel. You must be logged in as an Administrator in
order to use Add/Remove Programs to remove the OnBase Client.
OnBase 18 17
©2018
Client Installer
2. Click Next . The Custom Setup dialog box is displayed.
3. Click the drop-down select list beside the name of a component to display the
installation options:
Option Description
Will be installed on local hard drive Installs the selected feature and does not install any
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 on Installs the selected feature and any dependent
local hard drive functionality. To view the dependent functionality, click
the + icon next to the feature to expand the sub feature
list.
Entire feature will be unavailable Select this option to remove a feature from the list of
features to install.
OnBase 18 18
©2018
Client Installer
4. Select This feature 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 select list beside the top-level component.
5. To determine the amount of space available for installation of the selected
components, click Disk Usage . The Disk Space Requirements dialog is displayed, with
information on the space required for the selected components and the space available
on the drives accessible by the installation machine.
6. To change the installation location of a component, select it and click Browse . The
Change destination folder dialog is displayed.
Enter a Folder name in the field provided or select it from the Look in drop-down select
list. If the destination folder is not changed, components are installed to the default
locations listed in the following table.
OnBase 18 19
©2018
Client Installer
If the location is not changed, components are installed to the default locations listed in
the following table.
Component Default Location
OnBase Client C:\Program Files\Hyland\OnBase Client\
Note: The Document Composition files are installed to the

Document Composition sub directory at this location.
Mail Services This component is installed to the same location as the

OnBase Client.
OnBase Client API This component is installed to the same location as the
OnBase Client.
DCOM Configuration This component is installed to the same location as the

OnBase Client.
EDI Framework The EDI installer is delivered to the same location as the
OnBase Client.
Note: Under 64-bit systems, the Program Files (x86) folder is used by default (e.g., C:\Program
Files (x86)\Hyland\OnBase Client\ ).
OnBase 18 20
©2018
Client Installer
7. Click Next . The Data Source dialog box is displayed.
8. Select Specify System ODBC to set a system-level ODBC connection as the default data
source that is displayed to the user when logging in, then select from the drop-down
select list the connection you want to set as the default. The default connection can still
be changed by the user at log in and is overridden by the -ODBC command line switch.
Note: Do not select this option if there are no system ODBC data sources configured. If there
are no ODBC data sources configured, the Next button is disabled if this option is selected.
OnBase 18 21
©2018
Client Installer
9. Click Next . The Client Options dialog box is displayed.
This dialog box allows you to add any command line parameters to the OnBase Client
shortcut that is placed on your Windows desktop. For example, if you want to
automatically log in to your OnBase system, the autologon parameters can be added in
the field provided.
Tip: See Client Command Line Switches on page 48 for more information on the available
parameters.
OnBase 18 22
©2018
Client Installer
10. Click Next . The Ready to install dialog is displayed.
11. Select Create Desktop shortcut(s) when applicable to create shortcuts to the installed
components in the Windows Start | All Programs | Hyland menu, on the Windows
desktop, or in both locations, when applicable.
12. Click Install to continue with the installation, or click Cancel to cancel the installation.
13. When the installation is complete, click Finish .
Tip: 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.
INI File
OnBase 18 23
©2018
Client Installer

Location
and file name.

Desktop Environment
environment.
OnBase 18 24
©2018
Client Installer

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.
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.
OnBase 18 25
©2018
Client Installer
Client Installer Command Line Options

When running the Client installer from the command line, there are several variables that can be
used to control those aspects of the installation available from the user interface.
Note: If the requirements for installation are not met, you are prompted to run the Client
installer with the user interface (i.e., by launching setup.exe) in order to install the required
files. For more information, see Installer Overview on page 13.
Feature Names
You can control the installation of components from the command line using the ADDLOCAL
property. Each OnBase component is assigned a feature name. To install a component, pass its
feature name to the installer using the ADDLOCAL property.
The table below lists the feature name for each component.
Note: Feature names are case sensitive and must be added to the command line exactly as
they appear in this table.
Component Feature Name
OnBase Client OnBaseThickClient
OnBase Client API ThickClientAPILocal
DCOM Configuration Thick_API_DCOM
Mail Services MailServices
EDI Framework EDIFramework
The ADDLOCAL property is appended to the end of the install command line, as shown here:
msiexec.exe /i "Hyland OnBase Client.msi" ADDLOCAL=OnBaseThickClient,MailServices
This example installs the OnBase Client module and Mail Services. It does not install any of the
other components listed.
OnBase 18 26
©2018
Client Installer
Folder Variables
Components are installed to the default locations listed in the following table.
Component Default Location
OnBase Client C:\Program Files\Hyland\OnBase Client\
Note: The Document Composition files are installed to

the Document Composition sub directory at this
location.
Mail Services This component is installed to the same location as the

OnBase Client.
OnBase Client API This component is installed to the same location as the
OnBase Client.
DCOM Configuration This component is installed to the same location as the

OnBase Client.
EDI Framework This component is installed to the same location as the

OnBase Client.
These default locations can be changed through a command line option that specifies the
value for each folder’s variable. If these variables are not included during installation from the
command line, the default locations are used for installation.
Note: Under 64-bit systems, use the Program Files (x86) folder (e.g., C:\Program Files
(x86)\Hyland\OnBase Client\ ).
The folder variable used to change C:\Program Files\Hyland\OnBase Client\ is

THICKCLIENT_FILES .
When using this variable, the custom location for installation must be given in double quotes,
for example:
msiexec.exe /i "Hyland OnBase Client.msi" THICKCLIENT_FILES="C:\Program
Files\MyInstallFolder"
Shortcut Switches
Command line switches can be applied to the shortcuts that are placed on the desktop during
installation by using the COMMANDLINE parameter.
For example, to set an autologin for a specific user, the -AL and related command line switches
can be applied as follows:
OnBase 18 27
©2018
Client Installer
msiexec.exe /i "Hyland OnBase Client.msi" COMMANDLINE="-AL -ODBC=""OBSERVER"" -

UN=""MANAGER"" -PW=""PASSWORD"""
Note: The entire value of the command-line parameter must be enclosed in double quotes.
Accordingly, each shortcut switch definition within the command-line parameter must be
enclosed in two sets of double quotes.
Tip: See Client Command Line Switches on page 48 for a list of available command line
switches that you can set with this parameter.
Data Source Variables

The following parameters configure the data source settings that are installed with OnBase.
• SYSTEMODBC : Use a value of 1 to indicate that you want to set a system-level ODBC
connection as the default data source that is displayed to the user when logging in.
Note: Do not set this option to 1 if there are no system ODBC data sources configured.
• DATASOURCE : Sets the ODBC you want to set as the default, if SYSTEMODBC is set
to 1 .
For example:
msiexec.exe /i "Hyland OnBase Client.msi" SYSTEMODBC=1 DATASOURCE="MyDataSource"
Note: The default connection configured can still be changed by the user at log in and is
overridden by the -ODBC command line switch.
Shortcuts
The following parameters determine whether or not shortcuts are added to the Windows
desktop and program menu for the components installed, if shortcuts are available for the
installed components.
• CREATE_DESKTOP_SHORTCUTS: Set to 1 to create shortcuts on the Windows
desktop for the installed components, or leave empty to not add the shortcuts. By
default, this property is empty. For example: CREATE_DESKTOP_SHORTCUTS="1" or
CREATE_DESKTOP_SHORTCUTS="" .
• CREATE_MENU_SHORTCUTS: Set to 1 to create shortcuts in the Windows program
menu for the installed components, or leave empty to not add the shortcuts. By
default, this property is empty. For example: CREATE_MENU_SHORTCUTS="1" or
CREATE_MENU_SHORTCUTS="" .
OnBase 18 28
©2018
Client Installer
DCOM Configuration
The following parameters can be used to configure the DCOM server connection information if
the DCOM Configuration component is installed with the Client API component. DCOM
Configuration allows the OnBase Client API to operate in a distributed environment (i.e., across
networked computers). Without this component, the API only works in local mode.
Note: The specific DCOM settings must still be configured by an administrator after
installation.
• THICK_API_SERVERMACHINE: The machine name of the server used to run the

Client API (e.g., SRV-API0001 ).
• THICK_API_DCOM_USER: The user name of the account used to run the Client API
on the server.
For example: THICK_API_SERVERMACHINE="SRV-API0001" THICK_API_DCOM_USER="User
Name" .
Troubleshooting
The following issues may be need to be addressed after installing components using the Client
installer.
Note: For more complete troubleshooting sections, see the troubleshooting section contained
in the General Troubleshooting appendix of the System Administration module reference
guide.

OnBase 18 29
©2018
Client Installer


ODBC Setup for a Windows 64-bit Workstation

In a Windows 64-bit environment there are two different registries: 32-bit and 64-bit. This can
cause issues to occur when setting up System DSN ODBC sources because OnBase requires
the settings be written to the 32-bit registry, but the default behavior is to write to the 64-bit
registry. Since the OnBase Client since it is a 32-bit application, it only displays ODBC
connections written to the 32-bit registry.
In order to create 32-bit ODBC connections under 64-bit Windows, the odbcad32.exe program
in the %systemroot%\WINDOWS\SYSwow64 directory must be used, instead of the default
version under WINDOWS\system32 . ODBC sources created via the SYSwow64 version of this
executable are written to the 32-bit registry. The 64-bit version (found in the
WINDOWS\system32 directory) stores its System DSN settings in the 64-bit registry.
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 (Example: 18.0.0.10).
OnBase 18 30
©2018
Client Installer
• The type and version of the connected database, such as Microsoft SQL Server 2014
or Oracle 12c, and any Service Packs that have been installed.
• The operating system that the workstation is running on, such as Windows 10 or
Windows Server 2012 R2, and any Service Packs that have 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 Packs that have 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.
OnBase 18 31
©2018
C ONFIGURATION INSTALLER
Overview
The Configuration installer is used to install the components required to deploy the
Configuration module.
The OnBase Configuration module allows for the configuration and management of an OnBase
system. It allows the OnBase administrator to configure processes, set up Document Types,
and manage users and rights, among other tasks. The OnBase Configuration module requires
an ODBC connection to the database.
Installation of the Configuration module includes the OnBase Unity directory and files, which
are required to use the OnBase API. See the API SDK for details.
Installer 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 http://msdn.microsoft.com/
en-us/library/aa367988.aspx.
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.
OnBase 18 32
©2018
Configuration Installer
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
http://msdn.microsoft.com/en-us/library/142dbbz4(VS.80).aspx.
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 http://technet.microsoft.com/en-us/library/cc759262(WS.10).aspx.
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
OnBase 18 33
©2018
Installer Prerequisites
The installer must be run on operating systems that support the Windows® Installer 3.0+
architecture.
The installer setup executable ( setup.exe ) detects most of the prerequisites for the module
that are also required for installation and installs them, if necessary. If the installer fails to run,
install all of the requirements for the module separately before relaunching the installer.
reference guides.
Note: If installation is being performed using the installer MSI file, the requirements for the
module must be installed before launching the installer.
Installer User Permissions

You must be logged on to the installation machine with administrator privileges in order to run
the installer.
If installing under Windows operating systems with UAC enabled, the installer must be run with
elevated administrator privileges, even if the user currently logged in is an administrator.
Installer .NET Framework Requirements


areas.
OnBase 18 34
©2018

ODBC
There must be at least one ODBC connection configured on the machine that is running the
Configuration installer. If there are no ODBC connections configured, a Failed to enumerate
data sources error is encountered and the Configuration installer cannot be run.
Tip: The names of all configured ODBC connections for the workstation are available in the
data source drop-down select list when logging in to OnBase. When configuring a connection, it
is a best practice to use a name that makes sense to the data source it refers to. For example,
OnBase Production DB instead of DB1 or OBSERVER .
Components Requirements
See Requirements on page 1, in the Exposure chapter of this manual.
Installation
The Configuration installer can be run from an installation CD or a local drive. If upgrading from
a previous installation that used the Configuration installer, it is not necessary to uninstall the
old components before running the installer.
Running the Configuration Installer

The installer can be run silently or using the graphical user interface.
OnBase 18 35
©2018
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
Tip: For complete details on the command-line parameters available, see Configuration
Installer Command Line Options on page 44.
Installation Using the Graphical User Interface

To run the installer with the graphical user interface:
1. Double-click setup.exe , or launch it using Start | Run from the Windows task bar. The
OnBase Configuration welcome screen is displayed.
If another version of the Configuration module is installed, a prompt is displayed asking
if you would like to upgrade the current installation.
• Click No to cancel the installation and exit the installer.
• Click Yes to install the newer version of the Configuration module.
Note: A previous version of the Configuration module can be removed using the Add/Remove
Programs function in the Windows Control Panel. You must be logged in as an Administrator in
order to use Add/Remove Programs to remove the Configuration module.
OnBase 18 36
©2018
2. Click Next . The Destination Folder dialog box is displayed.
OnBase 18 37
©2018
3. Enter the top-level installation directory in the field provided, or click Change to browse
to it.
Note: This location does not affect components not installed under the top-level directory. If
the installer provides for the installation of multiple components, the specific installation
locations of each component can be changed later in the installation process.
If Change is clicked the Change destination folder dialog box is displayed.
Enter a Folder name in the field provided or select it from the Look in drop-down select
list, then click OK .
If the Destination Folder is not changed, the default location is used.
OnBase 18 38
©2018
4. Click Next . The Data Source dialog box is displayed.
5. Select Specify System ODBC to set a system-level ODBC connection as the default data
source that is displayed to the user when logging in, then select from the drop-down
select list the connection you want to set as the default. The default connection can still
be changed by the user at log in and is overridden by the -ODBC command line switch.
Note: Do not select this option if there are no system ODBC data sources configured. If there
are no ODBC data sources configured, the Next button is disabled if this option is selected.
OnBase 18 39
©2018
6. Click Next . The Configuration Options dialog box is displayed.
This dialog box allows you to add any command line parameters to the Configuration
shortcut that is placed on your Windows desktop. For example, if you want to
automatically log in to your OnBase system, the autologon parameters can be added in
the field provided.
Tip: See Client Command Line Switches on page 48 for more information on the available
parameters.
OnBase 18 40
©2018
7. Click Next . The Ready to install dialog is displayed.
8. Select Create Desktop shortcut(s) when applicable to create shortcuts to the installed
components in the Windows Start | All Programs | Hyland menu, on the Windows
desktop, or in both locations, when applicable.
9. Click Install to continue with the installation, or click Cancel to cancel the installation.
10. When the installation is complete, click Finish .
Tip: 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.
INI File
OnBase 18 41
©2018

Location
and file name.

Desktop Environment
environment.
OnBase 18 42
©2018

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.
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.
OnBase 18 43
©2018
Configuration Installer Command Line Options

When running the Configuration installer from the command line, there are variables that can
be used to control those aspects of the installation available from the user interface.
Note: If the requirements for installation are not met, you are prompted to run the
Configuration installer with the user interface (i.e., by launching setup.exe) in order to install
the required files. For more information, see Installer Overview on page 32.
Feature Name
You can control the installation of the Configuration module from the command line using the
ADDLOCAL property. To install the Configuration module, pass the feature name
OnBaseConfig to the installer using the ADDLOCAL property.
Note: Feature names are case sensitive and must be added to the command line exactly as
they appear in this table.
The ADDLOCAL property is appended to the end of the install command line, as shown here:
msiexec.exe /i "Hyland OnBase Configuration.msi" ADDLOCAL=OnBaseConfig
Folder Variable
By default, the Configuration module is installed to C:\Program Files\Hyland\OnBase
Configuration .
These default locations can be changed through a command line option that specifies the
value for each folder’s variable. If these variables are not included during installation from the
command line, the default locations are used for installation.
Note: Under 64-bit systems, use the Program Files (x86) folder (e.g., C:\Program Files
(x86)\Hyland\OnBase Configuration\ ).
The folder variable used to change C:\Program Files\Hyland\OnBase Configuration\ is

THICKCLIENT_CONFIG_FILES .
When using this variable, the custom location for installation must be given in double quotes,
for example:
msiexec.exe /i "Hyland OnBase Configuration.msi" THICKCLIENT_CONFIG_
FILES="C:\Program Files\MyInstallFolder"
Shortcut Switches
Command line switches can be applied to the shortcuts that are placed on the desktop during
installation by using the COMMANDLINE_CONFIG parameter.
OnBase 18 44
©2018
For example, to set an autologin for a specific user, the -AL and related command line switches
can be applied as follows:
msiexec.exe /i "Hyland OnBase Configuration.msi" COMMANDLINE_CONFIG="-AL -
ODBC=""OBSERVER"" -UN=""MANAGER"" -PW=""PASSWORD"""
Note: The entire value of the command-line parameter must be enclosed in double quotes.
Accordingly, each shortcut switch definition within the command-line parameter must be
enclosed in two sets of double quotes.
Tip: See Client Command Line Switches on page 48 for a list of available command line
switches that you can set with this parameter.
Data Source Variables

The following parameters configure the data source settings that are installed with OnBase.
• SYSTEMODBC : Use a value of 1 to indicate that you want to set a system-level ODBC
connection as the default data source that is displayed to the user when logging in.
Note: Do not set this option to 1 if there are no system ODBC data sources configured.
• DATASOURCE : Sets the ODBC you want to set as the default, if SYSTEMODBC is set
to 1 .
For example:
msiexec.exe /i "Hyland OnBase Configuration.msi" SYSTEMODBC=1
DATASOURCE="MyDataSource"
Note: The default connection configured can still be changed by the user at log in and is
overridden by the -ODBC command line switch.
Shortcuts
The following parameters determine whether shortcuts are added to the Windows desktop and
program menu for the Configuration module:
• CREATE_DESKTOP_SHORTCUTS: Set to 1 to create a shortcut on the Windows
desktop for the Configuration module, or leave empty to not add the shortcut. By
default, this property is empty. For example: CREATE_DESKTOP_SHORTCUTS="1" or
CREATE_DESKTOP_SHORTCUTS="" .
• CREATE_MENU_SHORTCUTS: Set to 1 to create a shortcut in the Windows program
menu for the Configuration module, or leave empty to not add the shortcut. By
default, this property is empty. For example: CREATE_MENU_SHORTCUTS="1" or
CREATE_MENU_SHORTCUTS="" .
OnBase 18 45
©2018
Troubleshooting
The following issues may be need to be addressed after installing components using the
Configuration module.
Note: For more complete troubleshooting sections, see the troubleshooting section contained
in the General Troubleshooting appendix of the System Administration module reference
guide.


OnBase 18 46
©2018

ODBC Setup for a Windows 64-bit Workstation

In a Windows 64-bit environment there are two different registries: 32-bit and 64-bit. This can
cause issues to occur when setting up System DSN ODBC sources because OnBase requires
the settings be written to the 32-bit registry, but the default behavior is to write to the 64-bit
registry. Since the OnBase Client since it is a 32-bit application, it only displays ODBC
connections written to the 32-bit registry.
In order to create 32-bit ODBC connections under 64-bit Windows, the odbcad32.exe program
in the %systemroot%\WINDOWS\SYSwow64 directory must be used, instead of the default
version under WINDOWS\system32 . ODBC sources created via the SYSwow64 version of this
executable are written to the 32-bit registry. The 64-bit version (found in the
WINDOWS\system32 directory) stores its System DSN settings in the 64-bit registry.
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 (Example: 18.0.0.10).
• The type and version of the connected database, such as Microsoft SQL Server 2014
or Oracle 12c, and any Service Packs that have been installed.
• The operating system that the workstation is running on, such as Windows 10 or
Windows Server 2012 R2, and any Service Packs that have 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 Packs that have 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.
OnBase 18 47
©2018
C LIENT C OMMAND LINE S WITCHES
Command Line Switches

The following command line switches can be used with the OnBase Client and Configuration
module. No module-specific licensing is required to use these command line switches.
API Options
-DDE
This switch allows the Client to service the Dynamic Data Exchange (DDE) commands sent by
the DDE management library (DDEML).
-DISCONNECT
This switch disables the warning message that the Client issues when the user tries to exit the
Client and API connections are still attached. By default, the Client broker interrupts the Client,
closing with a warning, and presents an option to cancel the closing.
-DONT_FORCE_BROKER_EXIT
This switch prevents the Client broker from completely shutting down when it is closed. The
Client broker will run in the background, waiting for future connections. This ensures that the
only way to terminate the broker is by forcibly closing the Client.
Ordinarily, the broker shuts down when there are no API connections and the user has closed
the Client. Also, if there are API connections, the user is given the choice to stop the broker
when closing the Client.
-MZAPP#
This switch causes the Client to run as an API broker on a specific port. The # value in the
command line switch (in the range of 1 - 5 or 20 - 79) specifies the port number used.
-NOBROKER
This switch disables the ability of the Client to function as an API broker. By default, the Client
is always an API broker.
OnBase 18 48
©2018
Client Command Line Switches
-OBAPP#
This switch causes the Client to run as an API broker on a specific port. The # value in the
command line switch (in the range of 1 - 5 or 20 - 79) specifies the port number used.
-OLEAPI
This switch allows the Client to operate as an API server.
-USE_TERMINATE_BROKER
This switch may be used if the API broker hangs when shutting down the Client. This switch
forces the broker to stop when shutting down the Client.
Login Options
-AL
This switch automatically logs in a user starting the OnBase Client or Configuration module
when the correct user name, password, and ODBC connection are included: -AL UN="<user
name>" PW="<password>" ODBC="<Local Server>"
-LT=“HH:MM”
This switch allows you to configure a time to automatically log out of the Client module. Be
aware of timers that may be running when using this switch, because they will not trigger
unless the Client workstation is logged on to OnBase. This switch will also log off a Client
module that is being run as a service and stop the service. The switch uses the 24-hour clock
(military time) for the time format (i.e., 01:00 for 1:00 AM and 13:00 for 1:00 PM).
Note: The -LT=“HH:MM” and -RT=“HH:MM” command line switches cannot be used on the
same command line.
-RT=“HH:MM”
This switch allows you to indicate a time to relaunch the Client module. Be aware of timers that
may be running when using this switch, because they will not trigger unless the Client
workstation is logged on to OnBase. The switch uses the 24-hour clock (military time) for the
time format (i.e., 01:00 for 1:00 AM and 13:00 for 1:00 PM).
OnBase 18 49
©2018
This command line switch performs the same operation as selecting File | Re-Launch Client in
the OnBase Client.
Note: The OnBase Client must be running for at least 30 seconds before a scheduled or manual
process begins. This ensures that the OnBase Client recognizes that the restart time passed
while the process was running.
Note: The -LT=“HH:MM” and -RT=“HH:MM” command line switches cannot be used on the
same command line.
Note: The -RT=“HH:MM” command line switch cannot be used to relaunch the Client module
when the Client module is running as a Windows Service.
-ODBC
This switch sets the ODBC connection used for logging on to the OnBase Client or
Configuration module. For example, -ODBC="Local Server" .
-PW
This switch sets the password of the OnBase user logging on to the OnBase Client or
Configuration module. For example, -PW="password" .
-UN
This switch sets the user name of the OnBase user logging on to the OnBase Client or
Configuration module. For example, -UN=“username” . This allows for added login security,
since the Client login dialog box displays a specific user name without a supplied password.
Running OnBase as a Windows Service
-SERVICE=“SERVICE NAME”
This switch launches the OnBase Service Monitor and monitors the named service.
Note: The Windows service itself still needs to be started. This switch does not start the
Windows service.
-STARTMINIMIZED
This switch causes the OnBase Service Monitor to launch in a minimized state, in the system
tray.
OnBase 18 50
©2018
Server Options
-QUIETDISCONNECT
This switch causes a server that loses its database connection to shut down without prompting
the user to respond to a dialog box indicating that the program will terminate due to the lost
database connection. This allows servers to shut down quickly in circumstances where
database connectivity is lost. These circumstances are often temporary, and often due to
backup operations.
-SE
This switch allows the Client to function as a search server. A search server is required when
users are required to submit text searches in a distributed fashion to a search server. A search
server offloads the time and resource-intensive work of text searching to another machine, so
the user does not tie up their system doing that work. Instead, a user submits the text search to
the search server and accesses the results when it is completed.
-SWREQ
This switch allows the Client to function as a sweep directory server.
System/Debugging Options
-DUMP
Enables the Client to generate a log file upon unexpected termination containing information
that can be used to more effectively troubleshoot.
-V
The Verbose switch is used to write output text from OnBase into the verbose.txt file at the
temporary report path. This is used for the purpose of troubleshooting problems.
Note: If you are running OnBase as a service, the verbose.txt file will be saved in the temporary
report path for the service profile.
OnBase 18 51
©2018
Use the following qualifiers to add additional information to the report:
Qualifier Description
DCONLY This option allows the user to run the Diagnostic Console
without also writing the output to the verbose.txt file.
L This option adds document and process lock information into

the verbose.txt file for tracing locks caused by the program.
MSG This option increases the number and depth of status

messages to the user. While this might slow down time
intensive processes, such as the COLD processor, it is a vital
tool in the search for faults and better ways to optimize this
kind of process.
SIZE When followed by a space and a number between 1 and 1024 ,

this option specifies the maximum number of megabytes a
verbose log file can reach before statements are logged in a
new log file.
The naming of verbose log files created is specified by
VerboseFilename in the INI file. If the position of $D is not
specified, the date and time are added to the verbose log file
name before the file extension. For more information, see the
INI Settings module reference guide.
Note: Previous verbose log files are not overwritten when

using the SIZE switch. It is considered a best practice to
manage previous verbose log files as part of system
maintenance.
SQL This option logs SQL queries and statements made by the
program to the verbose.txt file.
SQL "Phrase" When using the SQL qualifier, you can include phrase filters to
log only statements that contain the specified phrases. This is
useful when the verbose file grows very big.
The search phrase is case sensitive, and it must be enclosed
in quotation marks.
SQL "Insert", L If you want to use additional qualifiers for the -V switch, they
must be separated with a comma, and they must fall outside
of the quotation marks.
SQL "Insert" "usergroup" Specify multiple phrases to log SQL statements containing
any specified phrase.
There is no limit to the number of phrases you can specify.
Remember phrase searching is case sensitive.
WG This option prints out data packets received from a WinGate

Client.
OnBase 18 52
©2018
Note: The following example causes the system to output each SQL statement with
timestamps as it is prepared and/or executed: -V SQL. It is possible to have multiple
parameters in your Verbose switch, for example, -V [MSG][,SQL ["Phrase"]][,WG][,L]. The
following example causes the system to output each SQL statement to the Diagnostic Console
only: -V SQL, DCONLY.
User Options
-CE
This switch causes OnBase to start with an empty desktop. This is useful if you saved your
OnBase settings and have a query that is taking a long time to run, or the Client is hanging on
startup.
-DL
This switch causes OnBase to open with an alternate login dialog box. It should be used if there
is a problem viewing the standard login dialog box due to a video card or driver.
-DTGAPPLY
Enables the Apply to All Document Types in Document Type Group check box in Document
Type configuration dialog boxes. This option is used to apply a Document Type’s settings to all
Document Types in a Document Type Group.
Note: If a Document Type Group contains multiple file formats and the settings from one
Document Type are applied to the Document Type Group, the Default File Format setting of
each Document Type will need to be manually modified.
-INIFILE="[Full Path]\[File Name]"

This switch allows you to specify the full path and file name of the INI file that should be used
by the Client or Configuration module. With this switch, users can set up separate desktop
shortcuts to the same OnBase database, with each shortcut using different INI settings. For
example, one INI file may cause the program to use a different directory for temporary output
files.
Note: If the -INIFILE switch points to a file that does not exist, an error message describing the
invalid -INIFILE command line parameter is displayed when logging in to OnBase. After clicking
OK , a new INI file is created at the specified file path. This new INI file does not contain any of
the previously configured INI file settings.
OnBase 18 53
©2018
-NOSTATUS
This switch hides the splash screen and status window after logging on to OnBase.
-NOUI
This switch causes the Client to start without any user interface. To close the Client, end the
task from Windows Task Manager.
-ROMANZO
Caution: Before using features enabled by the -ROMANZO switch, ensure that you understand
the feature and implications of any changes to your system. Contact your service provider with
any questions regarding these features. Features enabled by the -ROMANZO switch should not
be made available to the casual user. Remove the -ROMANZO switch after completing
necessary actions.
This switch is used for advanced functionality. The features hidden by this switch are intended
for use by customers, but not by just any user. Therefore, they are hidden from the casual user.
An example of this would be the Directory Service Authentication dialog box in the
Configuration module, where an administrator can configure Active Directory or LDAP
authentication options for their OnBase system.
-SEEDINI
This switch allows OnBase to create an INI file when one does not exist. It must be used in
conjunction with the -INIFILE switch. Without this switch, the Client or Configuration module
will fail to start when the file specified by the -INIFILE switch does not exist. The switch was
added to support Remote Desktop environments, so multiple attempts to start OnBase will not
attempt to access the same INI file simultaneously.
You can use this switch in either of these two ways:
• -SEEDINI -INIFILE="\\server\share\onbase32.ini" – A default onbase32.ini file is
created in the -INIFILE path.
• -SEEDINI="\\server\share\onbase32.ini" -INIFILE="\\server\share\onbase32.ini" –
The onbase32.ini file in the SEEDINI path is copied to the INIFILE path.
OnBase 18 54
©2018
SYSTEM A SSESSMENT TOOL
The System Assessment Tool helps to ensure that workstations meet the minimum system
requirements for the OnBase Client, Unity Client, and Web and Application Servers. It is an
optional tool that can be used when deploying or upgrading workstations to the current version
of OnBase.
Using the System Assessment Tool

To run the System Assessment Tool:
1. Navigate to the SAT folder of your OnBase Client or OnBase Core Services build.
2. Double-click System Assessment Tool.exe .
3. The System Assessment Results page is opened in a web browser.
4. Results are returned in two sections:
• Client Report - This section checks the workstation’s components against the
OnBase Client and Unity Client minimum requirements. It contains the following
results:
Operating System The operating system installed on the workstation.
CPU The speed of the workstation’s CPU.
RAM The amount of RAM on the workstation.
Free Hard Disk Space The amount of free hard disk space on the workstation.
Video Memory The amount of video memory on the workstation.
.NET Framework Whether or not the required Microsoft .NET Framework

is installed on the workstation.
Internet Browser The Internet browser installed on the workstation.
Visual C++ Redistributable Whether or not the required Microsoft Visual C++
Redistributable Package is installed on the workstation.
OnBase 18 55
©2018
System Assessment Tool
• Server Report - This section checks the workstation’s components against the
OnBase Web/Application Server minimum requirements. It contains the following
results:
Operating System The operating system installed on the workstation.
CPU The speed of the workstation’s CPU.
RAM The amount of RAM on the workstation.
Free Hard Disk Space The amount of free hard disk space on the workstation.
.NET Framework Whether or not the required Microsoft .NET Framework

is installed on the workstation.
Internet Browser The Internet browser installed on the workstation.
Visual C++ Redistributable Whether or not the required Microsoft Visual C++
Redistributable Package is installed on the workstation.
5. One of the following statuses is displayed next to each component:
Status Description
PASS This component meets or exceeds the minimum requirement.
FAIL This component does not meet the minimum requirement.
Note: The description for each PASS component indicates whether the component meets the
minimum requirement or the recommended requirement.
OnBase 18 56
©2018

Client Installer - Onbase 18 Module Reference Guide

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Client Installer - Onbase 18 Module Reference Guide

Hochgeladen von

Copyright:

Verfügbare Formate

Client and Configuration Installers

© 2018 Hyland Software, Inc. ii

© 2018 Hyland Software, Inc. iv

Using the Module Reference Guide (MRG) ........................................................................................iv

Modifying Configuration Files ................................................................................................................... 16

Previous File Location/File Name ............................................................................................................. 42

CLIENT COMMAND LINE SWITCHES

System/Debugging Options .............................................................................................................................. 51

SYSTEM ASSESSMENT TOOL

Client Module Supported Operating Systems

.NET Framework Requirements

Microsoft Visual C++ Requirements

Processing Workstation Minimum Hardware

Hardware Minimum Requirement

Memory (RAM) A typical processing station can run on as little as 64 MB in

Screen Resolution 1024 x 768 (1280 x 800)

Note: Using a lower resolution may result in a loss of

Client Retrieval Workstation Hardware Requirements

Hardware Minimum Recommended

CPU 1 GHz 2 GHz or faster

Memory (RAM) • 32-bit OS: 1 GB 4 GB

Free Hard Disk Space 2 GB 2 GB or greater

Note: Using a lower

Microsoft SQL Server

Note: All Oracle 11g and 12c drivers can be used.

SAP SQL Anywhere

Database Client / Server Compatibility

Remote Desktop Environment Considerations

System Assessment Tool

Third-Party Software Compatibility

About Virtual Environments

64-Bit Support Statement

Windows User Account Control Statement

Modifying Configuration Files

Previous File Location/File Name

INI Considerations in a Citrix and Microsoft Windows Remote

Editing the INI File

Authenticode Signature Verification

Enabling Authenticode Signature Verification

Disabling Authenticode Signature Verification

Modifying Configuration Files

After modifying the uncompressed files, the installer located at C:\Installer\admin\Installer

Note: Installing the OnBase Client also installs the Client-side

Mail Services Mail Services is designed to create a single interface with a

Note: The specific DCOM settings must still be configured by

EDI Framework Delivers the EDI Framework installer, a third-party installer

For more information on Microsoft’s ClickOnce technology see

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

Installer User Permissions

Installer .NET Framework Requirements

Windows User Account Control Statement

Modifying Configuration Files

Running the Client Installer

Silent Installation Using setup.exe

Installation Using the Graphical User Interface

2. Click Next . The Custom Setup dialog box is displayed.

Component Default Location

OnBase Client C:\Program Files\Hyland\OnBase Client\

Note: The Document Composition files are installed to the

Mail Services This component is installed to the same location as the

DCOM Configuration This component is installed to the same location as the

7. Click Next . The Data Source dialog box is displayed.

9. Click Next . The Client Options dialog box is displayed.