Installation. Hyland Software OnBase 16
Reklama
Reklama
INSTALLATION
Requirements
Unity Client 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
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 16 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 table below.
Operating System
Windows NT 4.0
Windows 98
Windows 2000
Windows XP
Windows Server 2003
Windows Vista
Windows 8
Windows Server 2008
Windows Server 2012
No Longer Supported As Of:
OnBase 7.2
OnBase 7.2
OnBase 10.0.0
OnBase 14
OnBase 14
OnBase 16
OnBase 16
OnBase 16
OnBase 16
Unity Client Hardware and Browser Requirements
Component
CPU
Minimum
1.6 GHz dual-core
Recommended
2.4 GHz dual-core
©
2016 Hyland Software, Inc.
371
Unity Client OnBase 16
Component
Memory (RAM)
Free Hard Disk Space (for installing and running the
Unity Client)
Screen Resolution
Minimum
2 GB
450 MB
Recommended
4 GB
1024 x 768 (1280 x 800)
Note:
Using a lower resolution may result in a loss of functionality.
1280 x 1024 (1440 x 900 widescreen)
Graphics Card
128 MB 256 MB with hardware acceleration support
Web Browser
Note:
As long as you are using a supported operating system, there are no further Web browser requirements.
Email Platform
Media Player
Lotus Notes 8.0.2 or 8.5
IBM Notes 9
Microsoft Outlook 2007,
2010, or 2013
Novell GroupWise 8 or 12
Note:
When sending messages with Novell
GroupWise, Plain Text is the only format available.
Windows Media Player 10
Note:
The OnBase System Assessment Tool can be used to ensure that your workstation meets the minimum system requirements for the 16 OnBase Unity Client. For more
information on this tool, see System Assessment Tool on page 451.
HTTPS Automation Requirements
If you are installing Application Enabler and you want to expose an HTTPS endpoint to allow third-party applications to perform Application Enabler context events, additional requirements must be met.
The following requirements must be configured prior to enabling HTTPS Automation:
• A domain that will resolve to localhost.
©
2016 Hyland Software, Inc.
372
OnBase 16 Unity Client
• An HTTPS binding public/private key pair for the domain, in .PFX format, that must be trusted by all client workstations.
• The password for the private key must be OnBase.
• The key pair must be stored somewhere accessible to all clients using HTTPS
Automation (for example, distributed to every workstation or stored in a network share accessible via UNC).
If you need a URL and certificate to use with an HTTPS binding, contact your first line of support.
.NET Framework
The version of the .NET Framework required by the module being installed must be installed on both the deployment and client machines before installation. The .NET
Framework can be obtained from the Microsoft Download Center at http:// www.microsoft.com/downloads.
.NET Framework on Client Machines
This module requires Microsoft
®
.NET Framework 4.5.2. The .NET Framework can be obtained from the Microsoft Download Center at http://www.microsoft.com/downloads.
Databases Supported
The following tables list the databases supported.
©
2016 Hyland Software, Inc.
373
Unity Client
Microsoft SQL Server
OnBase 16
Microsoft SQL Server Additional Information
Microsoft SQL
Server™ 2005 (SP2 or later recommended)
Microsoft SQL Server
2008 (RTM, SP1, SP2;
SP2 recommended)
Microsoft SQL Server
2008 R2 (RTM, SP1;
SP1 recommended)
Microsoft SQL Server
2012
Microsoft SQL Server
2014
Microsoft SQL Server 2005 must be running in compatibility mode 7 or greater. Running in compatibility mode 6.5 or lower will result in errors during the upgrade process.
SQL Server 2005 drivers must be upgraded to the Feature Pack for
Microsoft SQL Server 2005 - December 2008 or a later feature pack.
Note:
for Microsoft SQL Server 7.0. As of release 11.0.0, Hyland Software no longer supports SQL Server 7.0.
Note:
On January 11, 2011, Microsoft discontinued technical support
On April 9, 2013, Microsoft discontinued technical support for
Microsoft SQL Server 2000. As of release 13, Hyland Software no longer supports SQL Server 2000.
Note:
Oracle
Note:
If you are using an Oracle database, it is strongly recommended that you have a certified Oracle Database Administrator on staff.
Oracle
Oracle v 8.0.5.0 or later
Oracle 8i: 8.1.7.7 or later
Additional Information
Oracle version 8.0.5.0 can be used, but it is not recommended due to potential memory leaks. If Oracle 8.0.5.0 is used, a third-party
ODBC driver is recommended.
ODBC drivers should be 8.1.7 or later. 8.1.6.x drivers have known issues and are not supported.
©
2016 Hyland Software, Inc.
374
OnBase 16 Unity Client
Oracle
Oracle 9i: Release 1 and Release 2 (9.2)
Oracle 10g: Release 1 and Release 2
Additional Information
Oracle driver version 10.2.0.3 is recommended.
An issue has been observed with the Oracle ODBC drivers where
Unicode characters (e.g., Japanese characters) retrieved from a
CLOB data type will be truncated, and could potentially cause errors in OnBase. The data remains intact in the database; however, the results when retrieving the data will be truncated. This has specifically been observed in one area of OnBase that uses the CLOB data type to store large amounts of data: License Certificates. This behavior may apply to other areas of the software that use this data type, as well.
To ensure that Unicode characters retrieved from a CLOB data type are not truncated, the Oracle 10g R2 ODBC drivers (which are backward compatible) should be installed, as well as the latest patchset (version 10.2.0.3) for these drivers.
All Oracle 11g drivers can be used.
Oracle 11g: Release 1 and Release 2
Oracle 12c
All Oracle 12c drivers can be used.
Sybase SQL Anywhere
Sybase SQL
Anywhere
Sybase SQL
Anywhere
™ 12
SAP Sybase SQL
Anywhere 16
Additional Information
As of OnBase 14, Sybase SQL Anywhere™ versions 11.x and lower are no longer supported. Sybase’s engineering support for SQL
Anywhere versions 11.x and lower has been retired (Sybase End of
Life Page).
Database Client / Server Version Compatibility
Due to critical issues that have been reported to Hyland Software, Hyland Software strongly recommends that:
• your database client software version matches or exceeds the database server version and
• 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 10 Release 2, verify that the Oracle Client software is
Oracle 10 Release 2 (or later). The same is true of SQL databases. For example, if your database server is SQL Server 2005, verify that the database client is SQL Server 2005
(or later).
©
2016 Hyland Software, Inc.
375
Unity Client OnBase 16
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 10 Release 2, the version number should appear as 10.2.[#.#.#] (or later), where 10.2 is the version number and
[#.#.#]
represents the service pack.
• If your database server software is any version of Microsoft SQL Server, select
Microsoft ODBC Driver 11.
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.
Hyland Software - MS Service Pack Statement
The developers of OnBase are dedicated to ensuring the monthly cumulative updates released by Microsoft® are compatible with OnBase®. On the second Tuesday of each month, the Quality Assurance Department of Hyland Software evaluates the cumulative fixes released and labeled as Critical or Important by Microsoft®. The details of the update provided by Microsoft are reviewed for interaction with OnBase® and installed when appropriate for testing its compatibility with OnBase®. If you have questions regarding a specific Microsoft® cumulative update and its compatibility with OnBase®, please contact your support provider.
Third-Party Software Support
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.
©
2016 Hyland Software, Inc.
376
OnBase 16 Unity Client
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 from your solution provider.
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.
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.
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.
©
2016 Hyland Software, Inc.
377
Unity Client
Licensing
See Licensing on page 1 for licensing requirements.
OnBase 16
Note:
A Unity Client Server license is required for each server instance in your OnBase solution.
Digital Input Device Compatibility
Digital input devices, such as scanners and digital cameras, can use the Windows Image
Acquisition (WIA) driver model. Depending on the module being used, devices that use
TWAIN, Kofax, or ISIS can also be used.
To use Windows Image Acquisition (WIA) digital input devices to acquire images, the
WIA Windows service must be configured with an Automatic or Manual Startup Type. For more information on WIA, including a complete list of devices compatible with WIA, see http://www.microsoft.com.
For more information on the TWAIN standard for image acquisition devices, see http:// www.twain.org.
Third-Party Software Requirements
Microsoft Office 2007 or greater is required to work with Microsoft Office documents in the Unity Client. Ensure that the latest Office service pack is installed.
Microsoft Outlook 2007 or greater or Lotus Notes 8.5 is required to email documents in the Unity Client.
Additionally:
• If you are using Outlook 2007, the 2007 Microsoft Office System Primary Interop
Assemblies (PIA)
are required. Primary interop assemblies can be installed by performing a Complete installation of Microsoft Office or by using the redistributable primary interop assemblies package, which can be obtained from the Microsoft Download Center at http://www.microsoft.com/downloads.
Microsoft Office XP Support
On June 11, 2011, Microsoft’s extended support for Office XP was retired.
Although OnBase 16 supports the use of Office XP, support for Office XP is being deprecated for eventual removal from the OnBase suite of products. Since Microsoft will no longer offer software design changes, complimentary or paid support, security update support or non-security hotfixes, Hyland Software can offer only limited support response to any issues that may arise with the use of Office XP. Office XP will no longer be supported in future OnBase releases. It is recommended that Office 2007 or later be used with OnBase 16.
©
2016 Hyland Software, Inc.
378
OnBase 16
Installation Overview
Unity Client
Note:
Before installing the OnBase Unity Client, ensure you have a functioning OnBase
Application Server. Ensure that the build of the OnBase Application Server matches the build of the OnBase Unity Client.
The Unity Client can be installed:
• Using the Hyland Unity Client Installer. For more information, see Installation
Using the MSI Installer on page 381.
• Using a ClickOnce Deployment. For more information, see ClickOnce
• Manually. For more information, see Manual Installation on page 442.
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. The .NET Framework installer is available from the Microsoft Download Center at http://www.microsoft.com/downloads.
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.
©
2016 Hyland Software, Inc.
379
Unity Client OnBase 16
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.
For more information on Microsoft ClickOnce technology in a Remote Desktop environment, see http://support.microsoft.com/kb/2020945.
For more information on Microsoft ClickOnce technology in a Citrix environment, refer to the Citrix help files or support provided by Citrix.
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/enus/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.
©
2016 Hyland Software, Inc.
380
OnBase 16 Unity Client
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
®
3.0+ architecture.
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. Module requirements can be found in the installation chapters of the corresponding module 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
The installer must be run on a machine that meets the .NET Framework requirements of the module being installed. Module requirements can be found in the installation chapters of the corresponding module reference guides.
The required version of the .NET Framework must be installed before launching the installer; it is not installed if it is missing. The .NET Framework can be obtained from the
Microsoft Download Center at http://www.microsoft.com/downloads.
Installation Using the MSI Installer
©
2016 Hyland Software, Inc.
381
Unity Client OnBase 16
Running the Installer
Launch the Hyland Unity Client installer by executing setup.exe. This executable is usually located in the \install\Unity Client\ folder of your source installation files.
Note:
If the installer is being copied from the source location to be run from a different location, the entire Unity Client folder and its contents must be copied to the new location.
1. The Hyland Unity Client installation welcome dialog is displayed.
2. Click Next. The Destination Folder dialog box is displayed.
©
2016 Hyland Software, Inc.
382
OnBase 16 Unity Client
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.
©
2016 Hyland Software, Inc.
383
Unity Client
4. Click Next. The Custom Setup dialog is displayed.
OnBase 16
The following features can be installed using the Hyland Unity Client installer:
Component
Unity Client
Datalogics
Application Enabler
*
Client Automation API
*
Virtual Print Driver Listener
*
Unity Pop Automation
*
Description
Installs the Unity Client.
The Unity Client is a next-generation document management system that offers the familiar look-and-feel of Microsoft® Office® 2007/2010.
Installs the Datalogics files required for the Plan Review
Internal Viewer.
Plan Review provides a way for public users to conveniently and securely upload electronic plan documents into OnBase.
Installs the Application Enabler module.
Application Enabler provides a way to seamlessly integrate an organization’s core line-of-business applications with
OnBase.
Installs the Unity Client Automation API, which is used by third-party applications to automate the Unity Client.
Installs the Virtual Print Driver listener.
Installs Unity Pop.
©
2016 Hyland Software, Inc.
384
OnBase 16 Unity Client
* Because this component can only run when the Unity Client is in Service Mode, choosing to install this component automatically configures the Unity Client to run in Service
Mode.
5. Click the drop-down select list beside the name of a component to display the installation options:
Option
Will be installed on local hard drive
Entire feature will be installed on local hard drive
Entire feature will be unavailable
Description
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.
Installs the selected feature and any dependent functionality. To view the dependent functionality, click the + icon next to the feature to expand the sub feature list.
Select this option to remove a feature from the list of features to install.
6. 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.
7. 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.
©
2016 Hyland Software, Inc.
385
Unity Client OnBase 16
8. 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.
9. Click Next. The Service Location dialog is displayed.
©
2016 Hyland Software, Inc.
386
OnBase 16 Unity Client
10.In the Display Name field, enter a user-friendly name for the service location.
11.In the Service Path field, enter the full URL to the Service.asmx page on the
OnBase Application Server. For example, https://MachineName/AppServer/
Service.asmx
.
Note:
Ensure that the Service Path reflects the configuration of the OnBase Application
Server in regard to HTTPS bindings. If the Application Server is not configured to use
HTTPS, setting the Service Path to HTTPS in this installer does not configure an HTTPS binding on the OnBase Application Server.
12.In the Data Source field, enter the ODBC connection for the data source this component will use to connect to OnBase.
13.Select Yes from the Use NT / LDAP Authentication drop-down select list if your system uses Active Directory or LDAP Authentication, otherwise select No.
Note:
In order to use Active Directory or LDAP authentication, the database against which the installed component runs must be separately configured for Active Directory or LDAP authentication. This installer configures the installed components to match the authentication scheme of the database but does not configure Active Directory or LDAP.
©
2016 Hyland Software, Inc.
387
Unity Client
14.Click Next. The Additional Settings dialog is displayed.
OnBase 16
In the Default Mail Client drop-down select list, select the default email client that users will use to send external mail from within the Unity Client.
If you chose to install Unity Pop Automation, the Additional Settings dialog includes
Unity Pop options.
©
2016 Hyland Software, Inc.
388
OnBase 16 Unity Client
In the Unity Pop option drop-down select list, select the Pop integration option that will be used for document retrieval and viewing.
Option
DocPop Link
Description
Select this option to use DocPop. The DocPop URL field will become available. For more information, see the DocPop module reference guide.
Unity Pop File
Select this option to use Unity Pop Files. For more information, see Viewing Unity
Pop Files and Links on page 255 and Configuring Unity Pop on page 355.
Unity Pop Link
Select this option to use Unity Pop Links. For more information, see Viewing Unity
Pop Files and Links on page 255 and Configuring Unity Pop on page 355.
Caution:
Do not select Unity Pop Link if existing Unity Pop files are still in use by your organization.
©
2016 Hyland Software, Inc.
389
Unity Client OnBase 16
15.Click Next. If you chose to install Application Enabler Client, the Application Enabler
Options
dialog is displayed.
c. In the Default Configuration File field, enter the full URL or UNC path to the default configuration file that Application Enabler should use (for example,
\\FileServer\Apps\ApplicationEnabler\DefaultFile.xml
), or click Change to navigate to the file to use. Leave this field empty to not configure a default file.
d.Select Enable HTTP Automation to expose an HTTP endpoint to allow third-party applications to perform Application Enabler context events.
e.If Enable HTTP Automation is selected, type the port number for the HTTP endpoint in the Port field. The default value is 15412.
f. Select Enable HTTPS Automation to expose an HTTPS endpoint to allow thirdparty applications to perform Application Enabler context events.
Note:
HTTPS Automation requires additional configuration after installation.
g.If Enable HTTPS Automation is selected, type the port number for the HTTPS endpoint in the Port field. The default value is 15425.
©
2016 Hyland Software, Inc.
390
OnBase 16 Unity Client
16.Click Next. If you chose to install any of the Service Mode components, the
Service Mode Options
dialog is displayed.
Select Prevent Client from launching on system startup to prevent the Client from automatically launching when the system starts.
©
2016 Hyland Software, Inc.
391
Unity Client
17.Click Next. The Ready to install dialog is displayed.
OnBase 16
18.Select Create Desktop shortcut(s) when applicable to create shortcuts to the installed components on in the Windows Start | All Programs | Hyland menu, on the Windows desktop, or in both locations, when applicable.
19.Click Install to continue with the installation, or click Cancel to cancel the installation.
20.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.
Note:
Some functionality must be configured directly in the configuration file. See Post-
©
2016 Hyland Software, Inc.
392
OnBase 16 Unity Client
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
Change
Repair
Remove
Description
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 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.
Removes all previously installed components.
Running the Installer from the Command Line
You can control the installation of components from the command line by passing its feature name to the installer using the ADDLOCAL property. The values of the configuration options available in the graphical installation wizard are passed to the installer using the property names associated with the installer options.
This section describes the feature names and properties associated with this installer.
Note:
Feature and Property names are case sensitive.
©
2016 Hyland Software, Inc.
393
Unity Client OnBase 16
Feature Names
To install the components contained in this installer, the value of the ADDLOCAL property must use the following Feature Names:
Component
Unity Client
Datalogics
Application Enabler*
Client Automation API*
Virtual Print Driver Listener*
Unity Pop Automation*
Feature Name
Unity_Client
UnityClient_Datalogics
ApplicationEnabler
UnityClientAutomation
VirtualPrintDriverListener
UpopAutomation
* Because this component can only run when the Unity Client is in Service Mode, choosing to install this component automatically configures the Unity Client to run in Service
Mode.
The ADDLOCAL property is added to the installation command line, as shown here:
msiexec /i "Hyland Unity Client.msi" ADDLOCAL=Unity_Client,ApplicationEnabler
Properties
When controlling the installation of components from the command line you must also configure the settings for each component you are installing by using the properties listed in the following table. If a property is not included, the default value is configured for that property.
Property
AE_DEFAULTFILE
CREATE_DESKTOP_SHORTCUTS
Description
The full URL or UNC path to the default configuration file that Application Enabler should use. Leave this property empty to not configure a default file. By default, this property is empty.
For example:
AE_DEFAULTFILE="\\FileServer\Apps\Applic ationEnabler\DefaultFile.xml"
Set to 1 to add desktop shortcuts for the installed component, or leave empty to not add the shortcuts. By default, this property is empty.
For example:
CREATE_DESKTOP_SHORTCUTS="1"
or
CREATE_DESKTOP_SHORTCUTS=""
©
2016 Hyland Software, Inc.
394
OnBase 16
Property
CREATE_MENU_SHORTCUTS
SERVICE_LOCATION_DATA_SOURCE
SERVICE_LOCATION_DISPLAY_NAME
SERVICE_LOCATION_NT_AUTH
SERVICE_LOCATION_SERVICE_PATH
Unity Client
Description
Set to 1 to add program menu shortcuts for the installed component, or leave empty to not add the shortcuts. By default, this property is set to 1.
For example:
CREATE_MENU_SHORTCUTS="1"
or
CREATE_MENU_SHORTCUTS=""
The ODBC connection for the data source installed components will use to connect to
OnBase. By default, this property is set to
{DataSource}
.
For example:
SERVICE_LOCATION_DATA_SOURCE="ODBC source name"
A user-friendly name for the service location.
By default, this property is set to New Service
Location
.
For example:
SERVICE_LOCATION_DISPLAY_NAME="My
Service Location"
Set to true if your system uses Active Directory or LDAP authentication, or set to false if it does not. By default, the
SERVICE_LOCATION_NT_AUTH
property is set to false.
Note:
In order to use Active Directory or LDAP authentication, the database against which the installed component runs must also be configured for Active Directory or LDAP authentication. The installer configures the installed component to match the authentication scheme of the database.
For example:
SERVICE_LOCATION_NT_AUTH="true"
or
SERVICE_LOCATION_NT_AUTH="false"
The full URL to the Service.asmx page on the
OnBase application server. By default, this property is set to https://{WebSite}/
{Directory}/Service.asmx
.
For example:
SERVICE_LOCATION_SERVICE_PATH="http:/
/MachineName/AppServer/Service.asmx"
©
2016 Hyland Software, Inc.
395
Unity Client
Property
UNITYCLIENT_AE_HTTPAUTOMATION
UNITYCLIENT_AE_HTTPSAUTOMATION
UNITYCLIENT_AE_HTTPS_PORT
UNITYCLIENT_AE_PORT
UNITYCLIENT_DEFAULT_MAIL_CLIENT
OnBase 16
Description
Set to 1 to enable HTTP Automation for
Application Enabler, or leave empty to not enable HTTP Automation for Application Enabler.
By default, this property is empty.
For example:
UNITYCLIENT_AE_HTTPAUTOMATION="1"
or
UNITYCLIENT_AE_HTTPAUTOMATION=""
Set to 1 to enable HTTPS Automation for
Application Enabler, or leave empty to not enable HTTPS Automation for Application
Enabler. By default, this property is empty.
For example:
UNITYCLIENT_AE_HTTPSAUTOMATION="1"
or UNITYCLIENT_AE_HTTPSAUTOMATION=""
Note:
If HTTPS Automation is selected during installation, the location of the
HTTPS certificate to be used must be specified in the obunity.exe.config file. For
more information, see Post-Installation on page 397.
The secure port number Application Enabler will use if HTTPS Automation is enabled. By default, this property is set to 15425.
Note:
Valid values are any integer 1 to 65535.
The port number Application Enabler will use if
HTTP Automation is enabled. By default, this property is set to 15412.
Note:
Valid values are any integer 1 to 65535.
The default mail client for Unity Client. By default, this property is set to outlook.
Note:
Valid values are outlook, lotus,
groupwise
, and gmail.
For example:
UNITYCLIENT_DEFAULT_MAIL_CLIENT="outl ook"
or
UNITYCLIENT_DEFAULT_MAIL_CLIENT="lotu s"
©
2016 Hyland Software, Inc.
396
OnBase 16 Unity Client
Property
UNITYCLIENT_DOCPOP_URL
UNITYCLIENT_POP_OPTION
UNITYCLIENT_SERVICEMODE_DISABLEA
UTORUN
Description
The URL that will be used when sending DocPop links. By default, this property is set to http://
[server]/[virtual directory]/docpop/ docpop.aspx?docid={0}&clienttype=html
.
For more information on DocPop links, see the
DocPop
module reference guide.
The Unity Pop option to set. Set to disabled,
upop
(Unity Pop Link), upop-file (Unity Pop
File), or weblink (DocPop Link). By default, this property is set to upop.
For example:
UNITYCLIENT_POP_OPTION="disabled"
or
UNITYCLIENT_POP_OPTION="upop"
Set to 1 to prevent Unity Client from launching on system startup, or leave blank to allow Unity
Client to launch on system startup. By default, this property is empty.
For example:
UNITYCLIENT_SERVICEMODE_DISABLEAUTO
RUN="1"
or
UNITYCLIENT_SERVICEMODE_DISABLEAUTO
RUN=""
Properties are added to the installation command line, as shown here:
msiexec /i "Hyland Unity Client.msi" ADDLOCAL=Unity_Client
SERVICE_LOCATION_DATA_SOURCE="My ODBC"
SERVICE_LOCATION_SERVICE_PATH="http://MyMachineName/AppServer/Service.asmx"
Post-Installation
Some functionality must be configured directly in the configuration file. For general
information about making changes to the obunity.exe.config file, see The Unity Client
Configuration File on page 343.
AD FS Configuration
For information on how to configure the Unity Client for AD FS, see Configuring the Unity
Client, MRM Unity Client, and Office Business Application for AD FS on page 366.
HTTPS Automation
For information on HTTPS Automation requirements, see HTTPS Automation
If HTTPS Automation is selected during installation, the location of the HTTPS certificate to be used must be specified in the obunity.exe.config file.
©
2016 Hyland Software, Inc.
397
Unity Client OnBase 16
To specify the location of the HTTPS certificate:
1. Open the obunity.exe.config file.
2. In the Hyland.Canvas.Automation.Services node, locate <HttpsAutomation enabled="false" port="15425" certificateLocation="" />.
3. Set enabled to "true".
4. Change the port setting, if required.
5. Set certificateLocation to the file path of the HTTPS certificate.
6. Save and close obunity.exe.config.
Installation Using ClickOnce
ClickOnce Deployment
To install a ClickOnce deployment of the Unity Client:
1. Launch the installer using setup.exe. This file is typically located in the In the
\ClickOnce\Unity Client
folder of your source installation files. The Welcome... dialog box is displayed.
2. Click Next. The Ready to install... dialog box is displayed.
3. Click Install. The deployment setup is installed.
©
2016 Hyland Software, Inc.
398
OnBase 16 Unity Client
4. Click Launch or Finish, depending on the module being installed. The Welcome to
the Deployment Creation Wizard
dialog is displayed.
Select Advanced Mode to enable the ability to update certain aspects of the installation where the default values are populated by the installer. Not selecting this option automatically uses the default values populated by the installer.
Caution:
Any necessary changes to the files in the deployment folder or the contents of the deployment folder, such as custom changes to the *.config file for the module, must be made before clicking Next at the Deployment Signing dialog box. If you are in Advanced
Mode, you still have the option to edit files in the deployment folder at the File Edit
Notification
dialog box that is displayed after the Deployment Signing dialog box.
Note:
If your servers are configured to use an HTTPS binding, or you are going to enable
Active Directory or LDAP Authentication, you should enable Advanced Mode in order to be able to configure these options in your deployment.
©
2016 Hyland Software, Inc.
399
Unity Client
5. Click Next. The Instance Settings dialog is displayed.
OnBase 16
6. Select the name of the application instance from the drop-down select list under the Instance Name section. To create a new instance name: a.Click the Add button to the right of the drop-down select list. The Create New
Instance
dialog box is displayed.
Note:
If you create a new instance name for an existing deployment, the package must be redeployed to client machines under the new instance name.
b.Enter a name for the new instance in the field provided. The name entered is used to distinguish this deployment from other deployments, so it must be unique.
Note:
The instance name cannot contain any of the following characters: [ ] < > , ; : + = "
/ \ | ? * # '
©
2016 Hyland Software, Inc.
400
OnBase 16 Unity Client c. Click OK.
7. The Deployment Version Number fields can be used to manually set a new version number for this deployment. This number is used by client machines to determine if the application installed needs to be updated.
The Deployment Version Number is incremented automatically by the deployment wizard. The initial Deployment Version Number is 1.0.0.0, and there is no need to change this number.
Note:
The Deployment Version Number is not available unless Advanced Mode is selected on the Welcome to the Deployment Creation Wizard dialog. To enable the Deployment
Version Number
, click Back and select Advanced Mode on the Welcome to the Deployment
Creation Wizard
dialog.
8. Select the Require clients to upgrade to version check box to force client machines to upgrade to the current instance. This option is selected by default.
9. Click Next. The Deployment Location dialog box is displayed.
©
2016 Hyland Software, Inc.
401
Unity Client OnBase 16
10.Click Change beside the Deployment Folder field to select a different folder. The
Deployment Folder
can be a local path or network location and is the folder to which the application files are copied on the deployment server.
Note:
If you are updating an existing deployment, you cannot change the Deployment
Folder
. If you create a new instance with a different Deployment Folder, the old deployment is not updated and the package must be redeployed to client machines with the new Deployment Folder location.
Caution:
Files in the Deployment Folder selected are overwritten.
11.Click Next. The How do you want to deploy...? dialog is displayed.
©
2016 Hyland Software, Inc.
402
OnBase 16 Unity Client
12.Click the Web Server icon to deploy the application to client workstations via a
URL (e.g., https://web-server/Application/DeployedApp.application).
Note:
If IIS is not installed, you cannot select Web Server and must deploy the application via a UNC path.
Click the From a Shared Folder icon to deploy the application to client workstations via a UNC path (e.g., \\machine-name\Application\DeployedApp.application).
Note:
The From a Shared Folder option is not available if deploying to a network location
(e.g., \\MyServer\MyShare).
Select Skip this step to configure the deployment folder manually as a shared folder or a virtual directory.
13.Click Next.
• For Web Server installations, go to the Web Server Installation Steps.
• For From a Shared Folder installations, go to the From a Shared Folder
• If Skip this step is selected, go to the Manually Created Share Steps.
Web Server Installation Steps
If you are installing the deployment package to a Web server, the Web server must be added to the Local intranet zone in Microsoft Internet Explorer. Zones are configured in
Internet Explorer by selecting the Security tab of the Internet Options (available from the
Tools
menu). You must also Enable the following Security settings:
• Automatic prompting for file downloads
• File download
• Font download
Tip:
For complete details on adding and configuring sites in the Local Intranet Zone, see the Microsoft Internet Explorer help files.
©
2016 Hyland Software, Inc.
403
Unity Client OnBase 16
After selecting Web Server at the How do you want to deploy...? dialog box, the Configure
Virtual Directory
dialog is displayed:
1. Select the Web Site to create the virtual directory under from the drop-down select list.
Note:
The application generated by the deployment wizard uses the security settings from the Default Web Site in IIS.
2. Select a Protocol from the drop-down select list. This allows you to configure the installed application to use the https protocol if an HTTPS binding is available.
3. Enter the Host Name of the Web Site selected, or accept the default host name presented. In some cases, such as with an HTTPS binding, the default value may need to be changed to match the host name in the certificate.
To specify a port to use for this connection, include the port number in the host name: <host name>:<port> (e.g., DEV-007832:82).
4. Enter a name for the Virtual Directory in the field provided. This is the name of the virtual directory created under the Web server selected.
Note:
If a virtual directory with the same name already exists, the existing virtual directory is configured to point to the Deployment Folder configured. The following special characters cannot be used in the Virtual Directory name: \ ? ; : @ & = + $ , | " < >
*
.
©
2016 Hyland Software, Inc.
404
OnBase 16 Unity Client
5. Click Next. The Package Extraction dialog is displayed, which displays the progress of the installation.
©
2016 Hyland Software, Inc.
405
Unity Client OnBase 16
6. Click Next when the extraction has completed. The General Settings dialog is displayed.
Note:
The General Settings dialog is not displayed for all modules, depending on the type of application being deployed. For example, desktop shortcuts cannot be created for the
Microsoft Office add-ins so the General Settings dialog is not displayed.
Select Create Desktop Shortcuts to create a shortcut to the deployed application on the client machine when the application is first installed on the client machine.
Note:
This option is only available for new deployments.
7. Click Next.
Note:
You do not need to complete the steps under From a Shared Folder Installation Steps or Manually Created Share Steps. Proceed to the section after the Manually Created Share
Steps
section.
©
2016 Hyland Software, Inc.
406
OnBase 16 Unity Client
From a Shared Folder Installation Steps
If you selected From a Shared Folder at the How do you want to deploy...? dialog, the
Configure Folder Share
dialog is displayed:
Note: Read
access on the shared folder is required for users to be able to install and upgrade the deployed application. Shared folder permissions must be set outside of this installation for deployments installed to a UNC location.
1. Enter a Share Name in the field provided. This is the name that the Deployment
Folder
will be shared as to users.
Note:
The Share Name must be unique. You cannot enter the name of an existing share.
2. Enter the External Name of the server hosting the Deployment Folder configured, or accept the default value presented. This is the name users will use to access the server. The default value is the machine name of the machine containing the shared folder.
Note:
The External Name field is only available if Advanced Mode is selected on the
Welcome to the Deployment Creation Wizard
dialog.
©
2016 Hyland Software, Inc.
407
Unity Client OnBase 16
3. Click Next. The Folder Share Permissions dialog is displayed if you are installing the deployment to a local drive (e.g., C:):
This dialog allows you to add or remove the users and groups that have read access to the Deployment Folder. By default, the local Everyone group is given read access.
Note: Read
access is required for users to be able to install and upgrade the deployed application.
©
2016 Hyland Software, Inc.
408
OnBase 16 Unity Client
4. Click Add to add additional users or groups, or select a user or group to remove and click Remove to remove it. If the users and groups presented are acceptable, proceed to the next step.
If you click Add, the Select Users and Groups dialog is displayed:
Select the Domain or Workspace to find users and groups under from the dropdown select list, then enter a User Group or Name to search for in the field provided, and click Search. Leave the User or Group Name field empty to locate all available accounts.
Select the user or group to add from the Search Results, then click OK. Repeat as necessary to configure your Folder Share Permissions.
©
2016 Hyland Software, Inc.
409
Unity Client OnBase 16
5. Click Next. The Package Extraction dialog is displayed, which displays the progress of the installation.
©
2016 Hyland Software, Inc.
410
OnBase 16 Unity Client
6. Click Next when the extraction has completed. The General Settings dialog is displayed.
Note:
The General Settings dialog is not displayed for all modules, depending on the type of application being deployed. For example, desktop shortcuts cannot be created for the
Microsoft Office add-ins so the General Settings dialog is not displayed.
Select Create Desktop Shortcuts to create a shortcut to the deployed application on the client machine when the application is first installed on the client machine.
Note:
This option is only available for new deployments.
7. Click Next.
Note:
You do not need to complete the steps under Manually Created Share Steps. Proceed to the section after the Manually Created Share Steps section.
Manually Created Share Steps
If you selected Skip this step at the How do you want to deploy...? dialog, you must manually create the share that the deployment will be installed to.
©
2016 Hyland Software, Inc.
411
Unity Client OnBase 16
If you are installing the deployment package to a Web server, the Web server must be added to the Local intranet zone in Microsoft Internet Explorer. Zones are configured in
Internet Explorer by selecting the Security tab of the Internet Options (available from the
Tools
menu). You must also Enable the following Security settings:
• Automatic prompting for file downloads
• File download
• Font download
Tip:
For complete details on adding and configuring sites in the Local Intranet Zone, see the Microsoft Internet Explorer help files.
If you are installing the deployment package to a network share, Read access on the shared folder is required for users to be able to install and upgrade the deployed application. Shared folder permissions must be set outside of this installation.
If you selected Skip this step at the How do you want to deploy...? dialog, the Web
Deployment URL
dialog is displayed:
1. Select Configure Web URL to have the installer create the link to the deployment that will be sent out to client machines for client installations of the deployed application. This link is available to be copied at the end of the installation, if one is configured.
Tip:
Do not select this option if the deployment Web site has not been configured for external access.
©
2016 Hyland Software, Inc.
412
OnBase 16 Unity Client
2. In the field, enter the base URL of your deployment without the application name
(for example, https://web-server/virtual-directory). The application name is automatically appended to the URL at the end of the installation.
3. Click Next. The Package Extraction dialog is displayed, which displays the progress of the installation.
©
2016 Hyland Software, Inc.
413
Unity Client OnBase 16
4. Click Next when the extraction has completed. The General Settings dialog is displayed.
Note:
The General Settings dialog is not displayed for all modules, depending on the type of application being deployed. For example, desktop shortcuts cannot be created for the
Microsoft Office add-ins so the General Settings dialog is not displayed.
Select Create Desktop Shortcuts to create a shortcut to the deployed application on the client machine when the application is first installed on the client machine.
Note:
This option is only available for new deployments.
5. Click Next.
©
2016 Hyland Software, Inc.
414
OnBase 16 Unity Client
Unity Features
After clicking Next on the General Settings dialog, the Unity Features dialog is displayed.
1. Select from the following features to install:
Component
Unity Client
Application Enabler
*
Unity Client Automation API
Virtual Print Driver
*
Unity Pop Automation
*
URI Protocol Handler
*
*
Description
Installs the Unity Client.
The Unity Client is a next-generation document management system that offers the familiar look-and-feel of Microsoft® Office® 2007/2010.
Installs the Application Enabler module.
Application Enabler provides a way to seamlessly integrate an organization’s core line-of-business applications with OnBase.
Installs the Unity Client Automation API, which is used by third-party applications to automate the Unity Client.
Installs the Virtual Print Driver listener.
Installs Unity Pop.
Installs the URI Protocol Handler, which is used by the
WorkView | Case Manager module.
©
2016 Hyland Software, Inc.
415
Unity Client OnBase 16
* Because this component can only run when the Unity Client is in Service Mode, choosing to install this component automatically configures the Unity Client to run in Service
Mode.
2. Click Next.
Service Location and Deployment Configuration
After clicking Next, the Service Location dialog is displayed.
1. Click Add.
2. Enter in the Display Name field the name of the service location.
3. Enter in the Service Path field the full URL to the OnBase application or Web server service (for example, https://machinename/AppServer/Service.asmx or https://
machinename/AppNet/Service.asmx
).
Note:
URLs that use the HTTPS binding must be correctly configured on the server for secure connections.
4. In the Data Source field, enter the ODBC connection for the appropriate data source.
©
2016 Hyland Software, Inc.
416
OnBase 16 Unity Client
5. Select Use NT / LDAP Authentication if your system uses Active Directory or LDAP
Authentication.
Note:
In order to use Active Directory or LDAP authentication, the database against which Unity Client runs must also be configured for Active Directory or LDAP authentication. The installer configures Unity Client to match the authentication scheme of the database.
6. Select Use ADFS if your system uses ADFS (Active Directory Federation Services) authentication.
Note: Use ADFS
is not the same Active Directory authentication scheme as Use NT/LDAP
Authentication
. The Use ADFS option is not available for all modules. If this option is not displayed, the module you are installing either does not support ADFS or must be manually configured for ADFS authentication. You cannot enable both Use ADFS and Use
NT/LDAP Authentication
. For details on configuring OnBase to use ADFS, see the appendix in the Application Server module reference guide.
Selecting Use ADFS causes the remainder of the deployment to be run in Advanced
Mode, even if Advanced mode was not selected initially, because the configuration file for the module must be updated before signing and finalizing the deployment.
Note:
If Use ADFS is selected during installation, additional configuration is required in the obunity.exe.config file before signing the deployment.
For information on how to use the obunity.exe.config file to configure Unity Client
for ADFS, see Configuring the Unity Client, MRM Unity Client, and Office Business
Application for AD FS on page 366.
©
2016 Hyland Software, Inc.
417
Unity Client
7. Click Next. The Additional Settings dialog is displayed.
OnBase 16
8. On the General tab, in the Default Mail Client drop-down select box, select the default mail client that users will use to send external mail from within the Unity
Client.
9. Select the Enable HTTPS Web Requests if you are installing Application Enabler and you want to expose an HTTPS endpoint to allow third-party applications to perform Application Enabler context events.
Type the port number for the HTTPS endpoint in the Port field. The default value is
15425.
Tip:
For more information on HTTPS Automation requirements, see HTTPS Automation
Note:
If HTTPS Automation is selected during installation, the location of the HTTPS certificate must be specified in the obunity.exe.config file before signing the deployment.
10.Select the Enable Persistent Logon check box if users should be able to use persistent logon. When selected, the Remember me on this computer check box is displayed in the log on dialog box. When this check box is selected, the Unity
Client stores the user’s credentials and uses them to automatically log on to
OnBase during future sessions. Credentials are stored until the user manually logs off. This feature is only available with OnBase authentication.
©
2016 Hyland Software, Inc.
418
OnBase 16 Unity Client
11.Select the Enable Email Link As check box if the Send To | Mail Recipient (as Link) option should be available to users:
Select Upop URI if Unity Pop hyperlink URI files will be sent via Send To | Mail
Recipient (as Link)
. Select Upop Shortcut File if Unity Pop shortcut files will be attached via Send To | Mail Recipient (as Link). Select DocPop URL if DocPop hyperlink URLs will be sent via Send To | Mail Recipient (as Link).
Note:
The Create Integration Hyperlink privilege is required to send Upop URI links.
12.Click Next. The Default Configuration File dialog is displayed.
©
2016 Hyland Software, Inc.
419
Unity Client OnBase 16
13.You can select a default configuration file. If you don’t want to specify a file, select None.
If you want to specify a configuration file and include it with the deployment, select the Include Configuration File with Deployment option. Specify the path to the configuration file in the Configuration Path field.
If you want to specify a configuration file but not include it in the deployment, select the External Path to Configuration File option. Specify the path to the configuration file in the External Path field. The path specified must be accessible to users.
14.Click Next. The Application Enabler Options dialog is displayed.
15.On the General tab, select Enable HTTP Automation to expose an HTTP endpoint to allow third party applications to perform Application Enabler context events.
Type the port number for the HTTP endpoint in the Port field. The default value is
15412.
©
2016 Hyland Software, Inc.
420
OnBase 16
16.Click the Pop Configuration tab.
Unity Client
17.The Pop Configuration tab allows you to configure URLs for DeficiencyPop, Patient
Window
, and FolderPop.
Specify the appropriate URL in the field for each feature as needed.
• For DeficiencyPop, enter the URL for the Medical Records Login.aspx page. If
DeficiencyPop should share sessions with Application Enabler and not require a login every time a related context is triggered, select the Enable session sharing check box. In order for this to function properly, users must log into Application
Enabler using a service location which is pointing to a Medical Records
Management server. For checksum validation to occur, EnablePopChecksum must be set to true in the Medical Records Management server’s web.config file. For more information on the EnablePopChecksum setting, see the Medical Pop
Integrations documentation. If Disable navigation to other charts is selected for
DeficiencyPop, the viewMRMRMode attribute is set to deficiencyOnly. If Include
external deficiencies
is selected, the external attribute is set to true. For more information on these settings, see the Application Enabler module reference guide.
• For Patient Window, enter the URL for Patient Window Login.aspx page. If
Patient Window should share sessions with Application Enabler and not require a login every time a related context is triggered, select the Enable session
sharing
check box. For checksum validation to occur, EnableChecksum must be set to true in the Patient Window’s web.config file. For more information on the
EnableChecksum
setting, see the Medical Pop Integrations documentation. If
View patient banner
is selected for Patient Window, the showBanner attribute is set to true. For more information on this setting, see the Application Enabler module reference guide.
©
2016 Hyland Software, Inc.
421
Unity Client OnBase 16
• For FolderPop, enter the URL to the FolderPop.aspx page. Select the Open
FolderPop Results in Separate Windows
option if you want FolderPop links to be opened in separate windows. Select the Send the session ID to web server option if you want the AE - FolderPop context to reuse the active session that
Application Enabler has instead of consuming a new session. If the option is not selected, users will have to log into each FolderPop instance that is launched after logging into Application Enabler.
Note:
The Application Enabler - Retrieve Documents and Application Enabler - Retrieve
Folders
contexts still require users to log in through a standard Application Server and cannot use a Medical Records Management server.
18.Click Next. The Deployment Signing dialog box is displayed.
Note:
Do not sign the deployment until you have made any required changes to the
obunity.exe.config
file. See Before Signing the Deployment on page 422.
Before Signing the Deployment
Caution:
Any necessary changes to the files in the deployment folder or the contents of the deployment folder, such as custom changes to the *.config file for the module, must be made before clicking Next at the Deployment Signing dialog box.
If you are in Advanced Mode, you still have the option to edit files in the deployment folder at the File Edit Notification dialog box that is displayed after the Deployment
Signing
dialog box.
If you are not in advanced mode, you must access the files directly by navigating to the deployment location.
For general information about making changes to the obunity.exe.config file, see The
Unity Client Configuration File on page 343.
AD FS Configuration
For information on how to configure the Unity Client for AD FS, see Configuring the Unity
Client, MRM Unity Client, and Office Business Application for AD FS on page 366.
HTTPS Automation
If HTTPS Automation is selected during installation, the location of the HTTPS certificate to be used must be specified in the obunity.exe.config file.
To specify the location of the HTTPS certificate:
1. Open the obunity.exe.config file.
2. In the Hyland.Canvas.Automation.Services node, locate <HttpsAutomation enabled="false" port="15425" certificateLocation="" />.
3. Set enabled to "true".
4. Change the port setting, if required.
5. Set certificateLocation to the file path of the HTTPS certificate.
6. Save and close obunity.exe.config.
©
2016 Hyland Software, Inc.
422
OnBase 16 Unity Client
Deployment Signing
Caution:
Any necessary changes to the files in the deployment folder or the contents of the deployment folder, such as custom changes to the *.config file for the module, must be made before clicking Next at the Deployment Signing dialog box.
If you are in Advanced Mode, you still have the option to edit files in the deployment folder at the File Edit Notification dialog box that is displayed after the Deployment
Signing
dialog box.
If you are not in advanced mode, you must access the files directly by navigating to the deployment location before signing the deployment.
©
2016 Hyland Software, Inc.
423
Unity Client
The Deployment Signing dialog box is displayed.
OnBase 16
1. Select the appropriate signing method.
When Sign from Test Certificate is selected, a test certificate with the Common
Name localhost is used. This test certificate is packaged with all ClickOnce installers. For security purposes, it is strongly recommended that this certificate remain un-trusted. This does not mean the certificate cannot be used, simply that when users attempt to launch the ClickOnce link, they are prompted with a message stating that the publisher could not be verified.
When Sign from Certificate User Store is selected, certificates from the current user store are listed under this option. If there are any certificates in the current user store, they can be used for signing here. Only certificates purposed for code signing are valid.
When Sign from File is selected, the deployment is signed using the PFX file entered in the corresponding field. Only certificates purposed for code signing are valid.
Caution:
Any necessary changes to the files in the deployment folder or the contents of the deployment folder, such as custom changes to the *.config file for the module, must be made before clicking Next at the Deployment Signing dialog box. If you are not in advanced mode, you must access the files directly by navigating to the deployment location before clicking Next and signing the deployment.
©
2016 Hyland Software, Inc.
424
OnBase 16 Unity Client
2. Click Next. If you are in Advanced Mode, the File Edit Notification dialog box is displayed.
From this dialog box you can open the deployment folder by clicking Open
Deployment Folder
. At this time, any necessary changes to the files in the folder or the contents of the folder must be made, such as custom changes to the *.config file for the module.
3. Click OK. Upon clicking OK, the folder is signed and cannot be modified without updating the deployment instance. The application is deployed and the Summary dialog is displayed upon completion.
Clicking the link provided under Success launches the application. This is the same as the full path that external users must use to install and launch the application.
Click Copy Link To Clipboard to copy this link to the clipboard.
4. Click Finish.
Upon completing these steps, you have installed the Deployment Wizard and installed an instance. You can add additional instances and access the Deployment Wizard by selecting Start | All Programs | Hyland | Deployment | Deployment Wizard. You can also update existing instances in the same way. See the Updating or Adding a Deployment
Instance section for more information.
©
2016 Hyland Software, Inc.
425
Unity Client OnBase 16
Updating or Adding a Deployment Instance
When a change is necessary for a deployment instance, it can be updated or a new instance can be created. To update an existing instance or create a new instance:
1. Select Start | All Programs | Hyland | Deployment | Deployment Wizard. The
Welcome to the Deployment Wizard Creation Wizard
dialog is displayed.
Select Advanced Mode to enable the ability to update certain aspects of the update where the default values are populated by the installer. Not selecting this option automatically uses the default values populated by the installer.
2. Click Next. The Package Selection dialog is displayed.
3. Select the deployed module for which you are updating the instance.
©
2016 Hyland Software, Inc.
426
OnBase 16
4. Click Next. The Instance Settings dialog is displayed.
Unity Client
5. Select the name of the application instance from the drop-down select list under the Instance Name section. To create a new instance name: a.Click the Add button to the right of the drop-down select list. The Create New
Instance
dialog box is displayed.
Note:
If you create a new instance name for an existing deployment, the package must be redeployed to client machines under the new instance name.
b.Enter a name for the new instance in the field provided. The name entered is used to distinguish this deployment from other deployments, so it must be unique.
Note:
The instance name cannot contain any of the following characters: [ ] < > , ; : + = "
/ \ | ? * # '
©
2016 Hyland Software, Inc.
427
Unity Client OnBase 16 c. Click OK.
6. The Deployment Version Number fields can be used to manually set a new version number for this deployment. This number is used by client machines to determine if the application installed needs to be updated.
The Deployment Version Number is incremented automatically by the deployment wizard. There is no need to change this number.
Note:
The Deployment Version Number is not available unless Advanced Mode is selected on the Welcome to the Deployment Creation Wizard dialog. To enable the Deployment
Version Number
, click Back and select Advanced Mode on the Welcome to the Deployment
Creation Wizard
dialog.
7. Select the Require clients to upgrade to version check box to force client machines to upgrade to the current instance. This option is selected by default.
8. Click Next. The How do you want to deploy Unity Client? dialog is displayed.
9. Click the Web Server icon to deploy the application to client workstations via a
URL (e.g., https://web-server/Application/DeployedApp.application).
Click the From a Shared Folder icon to deploy the application to client workstations via a UNC path (e.g., \\machine-name\Application\DeployedApp.application).
Note:
If you are upgrading an existing instance, you can only select to deploy it in the same method as it was deployed originally. For new instances, if IIS is not installed, you cannot select Web Server and must deploy the application via a UNC path.
©
2016 Hyland Software, Inc.
428
OnBase 16 Unity Client
10.Click Next.
For Web Server installations, go to the Web Server Add or Update Steps.
For From a Shared Folder installations, go to the From a Shared Folder Installation
Web Server Add or Update Steps
If you are adding a deployment package to a Web server, the Web server must be added to the Local intranet zone in Microsoft Internet Explorer. Zones are configured in Internet
Explorer by selecting the Security tab of the Internet Options (available from the Tools menu). You must also Enable the following Security settings:
• Automatic prompting for file downloads
• File download
• Font download
Tip:
For complete details on adding and configuring sites in the Local Intranet Zone, see the Microsoft Internet Explorer help files.
If you are adding or updating a Web Server deployment, the Configure Virtual Directory dialog is displayed:
©
2016 Hyland Software, Inc.
429
Unity Client OnBase 16
1. The default Deployment Folder path is displayed. Click Change to select a different folder.
Note:
If you are updating an existing deployment, you cannot change the Deployment
Folder
. If you create a new instance with a different Deployment Folder, the old deployment is not updated and the package must be redeployed to client machines under the new Deployment Folder location.
The Deployment Folder is the folder to which the application files are copied. This folder is configured as a virtual directory, to be mounted by the selected web server.
Caution:
Files in the Deployment Folder selected are overwritten.
2. Select the Web Site to create the virtual directory under from the drop-down select list.
Note:
If you are updating an existing instance, you cannot change the Web Site.
3. Enter a name for the Virtual Directory in the field provided. This is the name of the virtual directory created under the web server selected.
Note:
If a virtual directory with the same name already exists, the existing virtual directory is configured to point to the Deployment Folder selected. If you are updating an existing instance, you cannot change the Virtual Directory.
4. Select a Protocol from the drop-down select list. This allows you to configure the installed application to use the https protocol if an HTTPS binding is available.
Note:
If you are updating an existing instance, you cannot change the Protocol.
5. Enter the Host Name of the Web Site selected, or accept the default host name presented. In some cases, such as with HTTPS bindings, the default value may need to be changed to match the host name in the certificate.
Note:
If you are updating an existing instance, you cannot change the Host Name.
©
2016 Hyland Software, Inc.
430
OnBase 16 Unity Client
6. Click Next. The Package Extraction dialog is displayed, which displays the progress of the installation.
7. Click Next when the extraction has completed. The General Settings dialog is displayed, but the Create Desktop Shortcuts option is only available for new deployments.
Note:
The General Settings dialog is not displayed for all modules, depending on the type of application being deployed. For example, desktop shortcuts cannot be created for the
Microsoft Office add-ins so the General Settings dialog is not displayed.
8. Click Next. Go to the Service Location and Deployment Configuration steps to
complete the installation.
©
2016 Hyland Software, Inc.
431
Unity Client OnBase 16
From a Shared Folder Add or Update Steps
If you are adding or updating a From a Shared Folder deployment, the Configure Folder
Share
dialog is displayed:
1. The default Deployment Folder path is displayed. The Deployment Folder is the folder to which the application files are copied. Click Change to select a different folder.
Note:
If you are updating an existing deployment, you cannot change the Deployment
Folder
. If you create a new instance with a different Deployment Folder, the old deployment is not updated and the package must be redeployed to client machines under the new Deployment Folder location.
Caution:
Files in the Deployment Folder selected are overwritten.
2. Enter a Share Name in the field provided. This is the name that the Deployment
Folder
will be shared as to users.
Note:
The Share Name must be unique. You cannot enter the name of an existing share.
If you are updating an existing instance, you cannot change the Share Name.
©
2016 Hyland Software, Inc.
432
OnBase 16 Unity Client
3. Enter the External Name of the server hosting the Deployment Folder selected, or accept the default value presented. This is the name users will use to access the server. The default value is the machine name of the machine containing the shared folder.
Note:
The External Name field is only available if Advanced Mode is selected on the
Welcome to the Deployment Creation Wizard
dialog. If you are updating an existing instance, you cannot change the External Name.
4. Click Next. The Folder Share Permissions dialog is displayed:
This dialog allows you to add or remove the users and groups that have read access to the Deployment Folder. By default, the local Everyone group is given read access.
Note: Read
access is required for users to be able to install and upgrade the deployed application.
©
2016 Hyland Software, Inc.
433
Unity Client OnBase 16
5. Click Add to add additional users or groups, or select a user or group to remove and click Remove to remove it. If the users and groups presented are acceptable, proceed to the next step.
If you click Add, the Select Users and Groups dialog is displayed:
Select the Domain or Workspace to find users and groups under from the dropdown select list, then enter a User Group or Name to search for in the field provided, and click Search. Leave the User or Group Name field empty to locate all available accounts.
Select the user or group to add from the Search Results, then click OK. Repeat as necessary to configure your Folder Share Permissions.
©
2016 Hyland Software, Inc.
434
OnBase 16 Unity Client
6. Click Next after configuring your Folder Share Permissions. The Package Extraction dialog is displayed, which displays the progress of the installation.
7. Click Next when the extraction has completed. The General Settings dialog is displayed, but the Create Desktop Shortcuts option is only available for new deployments.
Note:
The General Settings dialog is not displayed for all modules, depending on the type of application being deployed. For example, desktop shortcuts cannot be created for the
Microsoft Office add-ins so the General Settings dialog is not displayed.
8. Click Next. Go to the Service Location and Deployment Configuration steps to
complete the installation.
©
2016 Hyland Software, Inc.
435
Unity Client OnBase 16
Service Location and Deployment Configuration
After clicking Next on the Package Extraction or General Settings dialogs, the Service
Location
dialog is displayed.
1. Select an existing Service Location or click Add to create a new service location.
2. Update or enter in the Display Name field the name of the service location for the instance.
3. Update or enter in the Service Path field the full URL to the OnBase application server service. For example, https://machinename/AppServer/Service.asmx.
4. Update or enter in the Data Source field the ODBC connection for the appropriate data source.
5. Select Use NT / LDAP Authentication if your system uses Active Directory or LDAP
Authentication.
Note:
In order to use Active Directory or LDAP authentication, the database against which Unity Client runs must also be configured for Active Directory or LDAP authentication. The installer configures Unity Client to match the authentication scheme of the database.
©
2016 Hyland Software, Inc.
436
OnBase 16 Unity Client
6. Select Use ADFS if your system uses ADFS (Active Directory Federation Services) authentication.
Selecting Use ADFS causes the remainder of the deployment to be run in Advanced
Mode, even if Advanced mode was not selected initially, because the configuration file for the module must be updated before signing and finalizing the deployment.
Note: Use ADFS
is not the same Active Directory authentication scheme as Use NT/LDAP
Authentication
. The Use ADFS option is not available for all modules. If this option is not displayed, the module you are installing either does not support ADFS or must be manually configured for ADFS authentication. You cannot enable both Use ADFS and Use
NT/LDAP Authentication
.
7. Click Next to proceed to the Deployment Signing dialog box.
Note:
Depending on the module being updated or added, you may be required to complete information in additional dialogs specific to the module. See the main installation steps above for information on any additional dialogs or steps that must be completed before signing the deployment.
©
2016 Hyland Software, Inc.
437
Unity Client OnBase 16
8. At the Deployment Signing dialog, select the appropriate signing method.
When Sign from Test Certificate is selected, a test certificate with the Common
Name localhost is used. This test certificate is packaged with all ClickOnce installers. For security purposes, it is strongly recommended that this certificate remain un-trusted. This does not mean the certificate cannot be used, simply that when users attempt to launch the ClickOnce link, they are prompted with a message stating that the publisher could not be verified.
When Sign from Certificate User Store is selected, certificates from the current user store are listed under this option. If there are any certificates in the current user store, they can be used for signing here. Only certificates purposed for code signing are valid.
When Sign from File is selected, the deployment is signed using the PFX file entered in the corresponding field. Only certificates purposed for code signing are valid.
Caution:
Any necessary changes to the files in the deployment folder or the contents of the deployment folder, such as custom changes to the *.config file for the module, must be made before clicking Next at the Deployment Signing dialog box. If you are not in advanced mode, you must access the files directly by navigating to the deployment location before clicking Next and signing the deployment.
©
2016 Hyland Software, Inc.
438
OnBase 16 Unity Client
9. Click Next. If you are in Advanced Mode, the File Edit Notification dialog box is displayed.
From this dialog box you can open the deployment folder by clicking Open
Deployment Folder
. At this time, any necessary changes to the files in the folder or the contents of the folder should be made. Upon clicking OK, the folder is signed and cannot be modified without updating the deployment instance. Clicking
Cancel
returns you to the signing screen.
10.Click OK. The application is deployed and the Summary dialog is displayed upon completion.
Clicking the link provided under Success launches the application. This is the same as the full path that external users must use to install and launch the application.
Click Copy Link To Clipboard to copy this link to the clipboard.
11.Click Finish.
Automatically Launching a Deployed Application at System Startup
In order to launch a deployed application automatically at startup, Service Mode must be enabled. Unity Client is configured to start in Service Mode by default.
If the application has been redeployed, the application upgrade will automatically be downloaded at startup.
Removing a Deployed Application
Deployed applications are installed to both client workstations and the deployment server. This section describes how to remove a deployed application instance from both the client workstations and deployment server, or completely removing the deployed application and all installed instances.
Removing a Deployed Application Instance from Client Workstations
To remove a deployed application instance from a client workstation:
1. Access the Windows Control Panel by selecting Start | Control Panel on the
Windows desktop.
2. Double click Add or Remove Programs. The Add or Remove Programs dialog is displayed.
3. Locate the installed application in the list of programs (e.g., Hyland Unity Client
[Instance Name]
).
©
2016 Hyland Software, Inc.
439
Unity Client
4. Select the program and click Change/Remove. The deployed application
Maintenance
dialog is displayed.
5. Select Remove the application from this computer.
6. Click OK.
The installed application is removed from the workstation.
OnBase 16
Note:
Removing the application instance from client workstations does not remove the application instance from the deployment server. Users can re-install a removed application instance by following the original link to the instance. To completely remove
a deployed application instance, see Removing a Deployed Application Instance from the
Deployment Server or Completely Removing a Deployed Application below.
Removing a Deployed Application Instance from the Deployment Server
If a deployed application instance is removed from all client workstations, it can be reinstalled by users who follow the link to the deployed application instance, unless the instance is also removed from the deployment server.
To remove an instance of a deployed application in order to reset the version and/or reuse an instance name:
1. Access the Windows Registry (enter regedit in the Windows Start | Run dialog).
The Registry Editor dialog is displayed.
Caution:
Modify the registry at your own risk. Incorrectly editing the Windows registry can cause serious problems that may require you to reinstall your operating system. Be sure to back up the registry before making any changes to it. For more registry information, see the following Microsoft articles: http://support.microsoft.com/kb/256986 and http:// technet.microsoft.com/en-us/library/cc725612.aspx
2. Expand the following registry key:
HKEY_LOCAL_MACHINE\SOFTWARE\Hyland\Deployment
Under 64-bit systems this key may be located at:
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Hyland\Deployment
3. Expand the subkey that corresponds to the deployed application you want to remove the instance from (for example, ApplicationEnabler or ReportServices).
4. Right click the subkey that corresponds to the instance name you want to remove.
5. Select Delete.
6. Click Yes at the confirmation prompt. The deleted instance is no longer available in the Deployment Wizard.
7. Locate the files for the instance to remove on the deployment server.
The location of the files depends on the location selected during installation. In a default, 32-bit installation, the files are located at C:\Program
Files\Hyland\[ApplicationName]\[InstanceName]\
(for example, C:\Program
Files\Hyland\ApplicationEnabler\MyAppEnablerInstance\
).
©
2016 Hyland Software, Inc.
440
OnBase 16 Unity Client
8. Delete all of the files and folders contained in the instance folder, or delete the entire instance folder. The application is no longer available for installation.
Caution:
Take care to delete only the folder for the instance you are removing. Deleting the application folder will remove all instances of the deployed application.
Note:
If the instance files are not removed from the deployment server, the application instance can still be installed by users who follow the link to the deployed application.
9. Follow the steps above to remove the installed instance from all client
workstations (see, Removing a Deployed Application Instance from Client
Note:
Until the instance is removed from client workstations, the application instance can still be used by client workstations, even if it is removed from the deployment server.
Completely Removing a Deployed Application
To completely remove a deployed application:
1. Follow the steps above to remove all instances of the deployed application from
the deployment server (see, Removing a Deployed Application Instance from the
2. Access the Windows Control Panel by selecting Start | Control Panel on the
Windows desktop.
3. Double click Add or Remove Programs. The Add or Remove Programs dialog is displayed.
4. Locate the installed application in the list of programs (e.g., Hyland Unity Client or
Hyland Unity Client Deployment
).
5. Select the application and click Change/Remove. The application and deployment package is removed.
Note:
Removing the last deployed application from the deployment server also removes the Deployment Wizard from the deployment server.
6. Follow the steps above to remove all instances of the deployed application from
all client workstations (see, Removing a Deployed Application Instance from
Note:
Until all instances of the application are removed from client workstations, the application can still be used by client workstations, even if it is removed from the deployment server.
©
2016 Hyland Software, Inc.
441
Unity Client OnBase 16
Manual Installation
To install the OnBase Unity Client manually:
1. Copy the ..\apps\Unity Client folder from your OnBase Core Services build.
2. Paste this folder to a location on the workstation where you are installing the
Unity Client.
3. Navigate to the location where you pasted the Unity Client folder.
4. Open obunity.exe.config.
5. Configure the following settings in the <ServiceLocations> section:
Note:
Within the Unity Client, Unicode characters are only supported in data source names and FriendlyName contexts if the Unity Client configuration file is saved with
Unicode encoding.
Setting Name
ServicePath
DataSource
FriendlyName
UseNTAuthenticatio n
UseADFS
Description
The URL to the Service.asmx page of the Application Server.
For example, http://[Application Server]/appserver/service.asmx.
The data source name (configured at the Application Server) to connect to.
For example, OnBase.
The "friendly name" of the service location. This name is displayed in the Unity Client’s title bar.
For example, OnBase.
When set to true, the Unity Client is configured to use Active Directory or LDAP Authentication.
When set to true, the Unity Client is configured to use ADFS
Authentication.
Additional steps must be taken to configure ADFS Authentication in
information.
Note:
If UseADFS is set to true, UseNTAuthentication must be set to
false
.
7. Save and close obunity.exe.config.
©
2016 Hyland Software, Inc.
442
OnBase 16 Unity Client
Running Multiple Instances of the Unity Client
You can run multiple instances of the Unity Client when, for example, you want to test out a different Unity Client configuration. You can run multiple instances of the Unity
Client only when they are installed to different locations on the workstation. You cannot run multiple instances of the same Unity Client installation.
Note:
When running multiple instances of the Unity Client, only a single instance can run in Service Mode, across all Unity Client deployments.
Backup/Recovery
Window Settings
Unity Client window position settings are saved for each user in the window.settings file.
The default location of the window.settings file for Windows 7, Windows 8.1, and
Windows 10 is C:\Users\[user]\AppData\Local\Hyland Software,
Inc\Hyland.Canvas\window.settings
.
Upgrade Considerations
The following upgrade considerations have been compiled by OnBase subject matter experts. These upgrade considerations are general and applicable to most OnBase solutions and network environments and should be considered each time an upgrade is performed.
Carefully consider the impact of making any changes, including those listed below, prior to implementing them in a production environment.
For additional general information about upgrading OnBase, refer to the Upgrade
Guidelines reference manual, and visit the OnBase Community at: https://www.onbase.com/community.
Unity Client Upgrade Considerations
The following information should be considered or noted when upgrading Unity Client deployments. Read this information prior to upgrading your version of OnBase.
Server Machine Considerations — The following should be considered with regard to server machines:
• Ensure that the Unity Client version and the Application Server version match.
End-User Workstation Considerations — The following should be considered with regard to end-user workstations:
• Ensure that the proper compatible third party applications are installed (e.g.,
Adobe Acrobat, Microsoft Office).
• Ensure that the directory where the Unity Client is installed is added to the virus scanner white list.
©
2016 Hyland Software, Inc.
443
Unity Client OnBase 16
• Make note of any settings in the Unity Client configuration file that have been modified from their default values.
• Ensure that the Application Server URL is correct in the ServicePath field of the Unity Client configuration file and can be accessed from a web browser.
Verify the user does not receive certificate errors and is not prompted for authentication credentials.
ClickOnce Deployment Considerations — In addition to the previous considerations, the following should be considered with regards to ClickOnce deployments:
• Ensure that the environment in which the Unity Client will be deployed is not a
Terminal Services environment.
• Ensure that the workstation environment can allow ClickOnce deployments to be installed.
• Ensure that any upgrades are made to existing deployments.
Frequently Asked Questions
1. Which OnBase setting determines the time allotment for a user working within the
Unity Client?
The Enable Timeout setting, in the OnBase Configuration module, determines the time allotment for users working within the Unity Client and many modules that access OnBase through the Unity Client, such as Application Enabler.
2. How can the Unity Client be used over the Internet without the use of a Web Server license?
Use the appServerProxyOnly web.config setting. For more information on this setting, see the Web Server Admin module reference guide. The service location in the Unity Client deployment should then be configured to point to the AppNet service location. For example, http://[server name]/AppNet/service.asmx.
Troubleshooting
Note:
A poor network connection may result in general errors and performance issues in the Unity Client. When troubleshooting, begin by ensuring that your network connection is stable and of the highest quality.
©
2016 Hyland Software, Inc.
444
OnBase 16 Unity Client
Cannot Start Application
When attempting to install a module to a client machine using a ClickOnce deployment, the Cannot Start Application dialog may be displayed with the message: Application
validation did not succeed. Unable to continue.
This error occurs when a deployment file for the application is modified after the deployment was created. To resolve this error, you must create a new deployment of the application using the Deployment Wizard. See the Updating or Adding a Deployment
Instance
section of this module reference guide for details.
Note:
When updating an existing deployment, make sure you select the appropriate module, as well as the Instance Name that corresponds to the instance that generated the error.
Display
When working in a dual monitor environment and the right monitor is the primary monitor, the Unity Client displays the title bar partially off screen.
Resolution:
Use the left monitor as the primary monitor. After opening the Unity Client, drag it to your left monitor. The next time you launch the Unity Client, it will be displayed in the left monitor.
External Email
The Body of Notifications is Blank
If the Use Native Mail Dialog option is not selected, meaning the OnBase Mail Message dialog box is used, and HTML is the default format for messages, the body of notifications may not be populated correctly. It is a best practice to set the default format to Plain Text or Rich Text to ensure that notification messages from OnBase are populated correctly.
©
2016 Hyland Software, Inc.
445
Unity Client OnBase 16
Exception Has Been Thrown by the Target of an Invocation
When attempting to send an external email in the Unity Client using Microsoft Outlook, the following message is displayed: Exception has been thrown by the target of an
invocation.
Clicking Show Details displays the following:
System.Reflection.TargetInvocationException: Exception has been thrown by the target of an invocation. ---> Hyland.Canvas.Controls.MissingPrerequisiteException: Microsoft Office and the Microsoft Office Primary Interop Assemblies must be installed to use this feature. Please install the required prerequisites and try again.
Resolution:
The .NET Programmability Support feature was not installed with Microsoft
Outlook. Use the Windows Control Panel to modify your Outlook installation to include
.NET Programmability Support.
One or More of the Selected Documents Could Not Be Sent
When attempting to send an external email in the Unity Client using Microsoft Outlook, the following message is displayed: One or more of the selected documents could not be
sent.
Clicking Show Details displays the following: The attachment size exceeds the
allowable limit [OnBase document’s Auto-Name string].
Resolution:
This issue occurs because the size of the OnBase documents attached to the external email message exceed the mail system's attachment size limitation. When sending multiple documents, those documents with a cumulative size less than the mail system's attachment size limitation will be attached to the email message. Documents whose size will cause the email message to exceed the mail system's attachment size limitation will not be attached.
Unity Pop File Is Not Valid for the System
When attempting to open a Unity Pop file attached to an email message, a message is displayed stating that the Unity Pop file is not valid for the system.
Resolution:
This issue occurs because the Unity Pop file is being launched against a different database than it was sourced from. For example, a Unity Pop file was created in database 1. A user logged on to database 2 will not be able to open this file. Because
Unity Pop files do not include database information, if users will be accessing multiple
OnBase databases with one Unity Client, consider using DocPop instead of Unity Pop.
You Do Not Have Privileges to View This Document
When attempting to open a Unity Pop file, the following message is displayed: You do not
have privileges to view this document.
An object reference not set to an instance of an object message is logged in the Diagnostics Console.
Resolution:
The document no longer exists in OnBase.
Open or Save an EML Document
No prompt to open or save an EML document is presented.
Resolution:
Ensure a mail client is correctly installed. Without the mail client, the EML file type is not recognized.
Logging On
Microsoft SQL Server Compact Edition (CE)
©
2016 Hyland Software, Inc.
446
OnBase 16 Unity Client
When using a machine that previously had Microsoft SQL Server Compact Edition (CE) installed, you are unable to log on to the Unity Client.
Resolution:
Remove the legacy registry entries for Microsoft SQL Server CE.
Caution:
Modify the registry at your own risk. Incorrectly editing the Windows registry can cause serious problems that may require you to reinstall your operating system. Be sure to back up the registry before making any changes to it. For more registry information, see the following Microsoft articles: http://support.microsoft.com/kb/256986 and http:// technet.microsoft.com/en-us/library/cc725612.aspx
These registry entries are located at
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server Compact
Edition\v3.5 (32-bit operating systems) or
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Microsoft SQL Server
Compact Edition\v3.5 (64-bit operating systems).
Initialization Error
An Initialization Error WMI (Windows Management Instrumentation) corruption error message is displayed when attempting to log on to the Unity Client.
Resolution:
Navigate to the ..system32\wbem\ folder on the workstation and delete the
Repository
directory. Restart the Windows Management Instrumentation Windows
Service as, and well as any dependent Windows Services.
Scanning
When issues arise during scanning in the Unity Client, the LowTwainMode setting can be used in troubleshooting.
When enabled, this setting allows the following scanner settings to be saved at the local workstation level: Duplex, autofeed, color format, brightness, contrast, paper size, orientation, rotation, threshold, xres, and yres. Other settings are retained only for the duration of the scan session.
When LowTwainMode is disabled, the Unity Client attempts to configure all scanner settings at once.
To enable LowTwainMode, add the following to the appSettings section of the Unity Client configuration file:
<add key="lowTwainMode" value="true" />
To disable this setting, change the lowTwainMode key’s value to false.
Note:
Once LowTwainMode is enabled, it will only take effect on newly created scan formats. Existing scan formats must be recreated to exhibit the LowTwainMode behavior.
©
2016 Hyland Software, Inc.
447
Unity Client OnBase 16
Working with Documents
Created in a Newer Version of Word
When a Microsoft Word 2007 document (.docx) is opened in the Unity Client on a machine with Microsoft Office 2003 and an older version of the Office Compatibility Pack, the following conversion warning message is displayed: Because this file was created in a
newer version of Word, it has been converted to a format that you can work with.
This conversion warning message may be displayed behind the Unity Client window, making it difficult to detect.
Resolution:
Update the Office Compatibility Pack to a version that provides the ability to suppress this message. For more information, see http://support.microsoft.com/kb/
936695.
There Was an Error Opening This File
When uploading or opening a document, the following message is displayed: There was
an error opening this file
.
Resolution:
Ensure that the document is in the Document Type’s default file format.
Excel Ribbon Is Reset to the Home Tab
When multiple Microsoft Excel documents are open in the Unity Client, the Excel ribbon is reset to the Home tab each time you switch between documents.
Resolution:
This is a known issue when working with multiple Microsoft Excel documents simultaneously in the Unity Client.
Opening a Modal Dialog Box
When multiple Microsoft Word or Excel documents are open in the Unity Client, opening a modal dialog box (e.g., Word’s Font dialog box) in one document does not allow you to perform work on the other document. Closing the modal dialog box allows you to perform work on the other document.
Resolution:
This is a known issue when working with multiple Microsoft Word or Excel documents simultaneously in the Unity Client.
Unable to Use Microsoft Excel Outside of the Unity Client
Viewing a Microsoft Excel document in the Unity Client takes focus away from the
Microsoft Excel application. When an Excel document is open in the Unity Client, you are unable to use Microsoft Excel outside of the Unity Client.
Resolution:
This is a known issue when working with Excel documents in the Unity Client.
When an Excel document is open in the Unity Client, you are unable to use Microsoft
Excel outside of the Unity Client until the Excel document in the Unity Client is closed.
Attempt to Access Invalid Address
When a cell in the Microsoft Excel application is being edited, opening a Microsoft Excel document in the Unity Client displays the following message: Attempt to access invalid
address.
Resolution:
Click Ignore and close the Microsoft Excel document in the Unity Client. In the Microsoft Excel application, navigate to a different cell. In the Unity Client, reopen the Microsoft Excel document.
©
2016 Hyland Software, Inc.
448
OnBase 16 Unity Client
Exception Has Been Thrown by the Target of an Invocation
When attempting to view a document in the Unity Client, the following error is displayed: Exception has been thrown by the target of an invocation.
Resolution:
Ensure the Unity Client is the same version and build as the Application
Server. The Unity Client version and build is displayed in the login screen’s Build Version field. You can also view the version and build by right-clicking the Unity Client executable file and selecting Properties. The version and build is displayed in the Product
version
field on the Details tab.
Characters Appear Cut Off in Text Documents
Text documents viewed in the Unity Client may display a different number of characters per line than those viewed in the OnBase Client.
Resolution:
This inconsistency occurs because text documents are rendered as images in the Unity Client. In the OnBase Client, text documents are rendered as text. In the Unity
Client, the number of characters displayed per line is controlled by the Characters per line setting for the Document Type. For example, if the Characters per line setting is 132, only characters 1-132 are displayed for text documents in the Unity Client. The
Characters per line
setting is accessed by clicking View/Print from the Document Types dialog box in the Configuration module.
Notes, Redactions, Burned Markups, and Deficiencies on
Documents with Overlays
Notes, redactions, burned markups, and deficiencies on documents that have an overlay applied may encounter unexpected behavior. The position of notes, redactions, burned markups, and deficiencies may shift when the document is rendered.
The position shift may occur in the following instances:
• Text documents that contain overlays with an offset configured
• Text documents accessed using modules that render text documents as an image for display
• Image documents with overlays that do not have the same DPI or dimensions as the document
Caution:
If a redaction, burned markup, or deficiency appears in a shifted position, do not save or sign the document until the shift has been corrected. Saving or signing the document will permanently place the redaction, burned markup, or deficiency in the shifted position. The position shift of notes that do not permanently alter the document can be corrected at any time.
When setting up overlays for documents that may also include notes, redactions, burned markups, or deficiencies:
• Ensure the dimensions of the overlay match the dimensions of the document.
• Do not use offsets with overlays if the document may also contain notes, redactions, burned markups, or deficiencies.
• For text documents, use 96 DPI for overlays.
• For image documents, ensure the DPI of the overlay matches the DPI of the document.
©
2016 Hyland Software, Inc.
449
Unity Client OnBase 16
A position shift can be corrected through the following methods:
• For text documents, recreate the overlay to match the dimensions of the document instead of using an offset. For example, add empty space to the margin of the overlay instead of using an offset to account for this space.
• For text documents, it is considered a best practice to set the DPI of the overlay to 96 DPI. Some OnBase modules render text documents as an image for display, and in most cases, the image is rendered at 96 DPI.
• For image documents, recreate the overlay to match the DPI and dimensions of the document.
If the issue still occurs, contact your first line of support.
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: 15.0.0.10).
• The type and version of the connected database, such as Microsoft SQL Server
2008 or Oracle 11g, 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.
©
2016 Hyland Software, Inc.
450
Preuzimanje
Javni link je ažuriran
Javni link do vašeg ćaskanja je ažuriran. You may view and manage your chat links after registration here.
Javni link dokumenta
Reklama
