OnBase Module Deployment
Mike Maxson
Introduction
• Mike Maxson
• Solutions Engineer Databank / OSAM
– 8 years
• OCI – OnBase Certified Installer
2013 ECM Training Conference
#dbwestECM
Agenda
•
•
•
•
•
New Hyland Client Components Installer in 12.0
Hyland Office Product Installations
Installation using Click-Once
Installation Using the Standard (MSI) Installer
Controlling the Installer from the Command Line
2013 ECM Training Conference
#dbwestECM
Client – Side Installers
Version 12
Client Components Installer version 11.0
Client Components Installer version 11.0
Client – Side Installers 12.0
• In OnBase 12, the Hyland Client Components
Installer was deprecated and replaced with
individual stand-alone installers. A separate
installer was created for each of the modules
previously installed using the Hyland Client
Components Installer.
#dbwestECM
Version 11.0
Version 12.0
Client Components Installer version 11.0 vs 12.0
Application
Enabler
Disconnected
Scanning
Desktop
Front Office
Scanning
Express
Scanning
Individual Installers 12.0
Unity Client
Report
Services
11.0
Client Components Installer version 11.0
12.0
Client Components Installer version 12.0
Client – Side Installers 12.0
• This change was made to allow for parallel,
incremental upgrades of the modules installed. It
also reduces the overall size of the installers by
allowing system administrators to only deploy
the MSIs for modules they want to install.
#dbwestECM
Hyland Office Product
Installations
Hyland Office Product Installations
• The Hyland Office Products installers are used to
install the Office Business Application for 2007
or Office Business Application for 2010 modules.
#dbwestECM
Hyland Office Product Installations
• The following functionality is included in the installers and can be
installed independently of each other:
–
–
–
–
–
–
–
Office Add-In for Microsoft Word 2007/2010
Document Composition Configuration for Microsoft Office 2007/2010.
Office Add-In for Microsoft PowerPoint 2007/2010
Office Add-In for Microsoft Excel 2007/2010
Report Services Excel Add-In for Microsoft Office 2007/2010
Integration for Microsoft Outlook 2007/2010
WorkView Integration for Microsoft Outlook 2007/2010
#dbwestECM
Hyland Office Product Deployment Options
• The Hyland Office Products installer is distributed
as a ClickOnce deployment installer or as a
standard executable installer (MSI).
#dbwestECM
Standard MSI
Hyland Office Product Deployment Options
Click-Once
Hyland Office Product Deployment Options
• While either installer can be used to install the
same functionality, the following differences
should be considered when deciding which
installation option is best for your organization:
#dbwestECM
Standard MSI
• Prerequisites are installed
automatically as long as the
setup.exe executable is used for
installation.
Click-Once
• Prerequisites are not included in
the deployment packages and
cannot be deployed using
ClickOnce.
• A separate Hyland Office
Integration Dependencies installer
must be run on each workstation
before the packages are deployed
to those workstations.
Hyland Office Product Deployment Considerations
Standard MSI
• The installer must always be run
on the local workstation by a
user who is an Administrator on
that workstation.
Click-Once
• Deployment packages can be
installed on the local workstation
by any user with rights sufficient
to access the deployment package
on the deployment server.
Hyland Office Product Deployment Considerations
Standard MSI
• In order to upgrade to a new
version, the old version must be
uninstalled from each
workstation before the new
version can be installed.
Click-Once
• Deployment packages can be
updated to a new version without
first uninstalling the module from
each workstation. The new
version is automatically updated
on each workstation the next time
the module is accessed.
Hyland Office Product Deployment Considerations
Standard MSI
• Microsoft Office documents
opened using the Web Client
can be revised using the Office
Business Application for 2007
or 2010 modules if they were
installed using the standard
(MSI) installer.
Click-Once
• Microsoft Office documents
opened using the Web Client
cannot be revised using the Office
Business Application for 2007 or
2010 modules if they were
deployed using ClickOnce.
Hyland Office Product Deployment Considerations
Standard MSI
• Document Templates can only
be used in the Web Client with
the Office Business Application
for 2007 or Office Business
Application for 2010 when
those modules are installed
using the standard installer
(MSI).
Click-Once
• Document Templates cannot be
used in the Web Client with the
Office Business Application for
2007 or Office Business
Application for 2010 if those
modules are installed using the
ClickOnce installer.
Hyland Office Product Deployment Considerations
Standard MSI
Click-Once
• The 64-bit versions of the
Hyland Office add-ins for
Microsoft Office 2010 can be
installed using the standard
installer (MSI) for 64-bit
environments.
• The ClickOnce installer cannot be
used to install the 64-bit Hyland
Office add-ins.
Hyland Office Product Deployment Considerations
Installation using Click-Once
Installation using Click-Once
• ClickOnce is a technology developed by Microsoft to
allow software to be easily deployed to client
machines. To install a ClickOnce application, the user
clicks on a UNC or URL link to the deployment files
and the software is automatically downloaded and
installed. In most instances, the software is installed
in the user’s profile.
#dbwestECM
Click-Once
Deployment Wizard
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
Click-Once Deployment Unity Client
Unity Client
Deployment Options
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
Click-Once Deployment Unity Client
Unity Client
Click-Once
Deployment
http://36ZQ3R1/UnityClientProduction/UnityClientProduction.application
Click-Once Deployment Unity Client
Unity
Click-Once Client
Installation
Click-Once Deployment Unity Client
Unity
Click-Once Client
Installation
Click-Once Deployment Unity Client
Unity
Click-Once Client
Installation
Click-Once Deployment Unity Client
Click-Once Deployment Advantages
• Previously installed versions of the module can be
easily and automatically updated to the latest
version with little or no user interaction.
• The module is installed on a per-user basis and does
not require administrator privileges for local
installation.
#dbwestECM
Click-Once Deployment Advantages
• There can be multiple instances of the module
deployed, allowing for different versions of the
module to be installed on a per-user basis.
#dbwestECM
Click-Once Deployment Disadvantages
• Installation Directory
– [UserHomeDir]\Local
Settings\Apps\2.0\DX5PBPBP.P73\2T01TTZQ.309\abcd…app_2
6d83178f0280887_0001.0003_948d4c8470e680c3
#dbwestECM
Click-Once Deployment Disadvantages
• Installation for Current User only, no option to install for
All Users.
#dbwestECM
Click-Once Deployment Disadvantages
• If a ClickOnce-deployed application is used within a
Remote Desktop environment, the following items must
be considered:
– Each user connecting to the server using a remote session
must click on the provided URL or UNC to download and install
the application.
#dbwestECM
Click-Once Deployment Disadvantages
• If a ClickOnce-deployed application is used within a
Remote Desktop environment, the following items must
be considered:
– If roaming profiles are not being used, users will have to click
on the provided URL or UNC for each different server they
connect to in the server farm.
#dbwestECM
Installation Using the Standard
(MSI) Installer
Installation using Standard MSI
• EXE and MSI Installers
– Most commonly used
– May consist of both an executable file (.exe) and a
Windows Installer Package file (.msi)
– Two methods for running OnBase installers:
Interactive and silent
#dbwestECM
Installation using Standard MSI
• Interactive
– Requires user interaction with dialog boxes during
the installation process
• Silent
– Does not require user interaction during the
installation process
#dbwestECM
Standard Installation
(MSI) Unity Client
Interactive Installation (MSI) Unity Client
Standard Installation
(MSI) Unity Client
Interactive Installation (MSI) Unity Client
Standard Installation
(MSI) Unity Client
Interactive Installation (MSI) Unity Client
Standard Installation
(MSI) Unity Client
Interactive Installation (MSI) Unity Client
Standard Installation
(MSI) Unity Client
Interactive Installation (MSI) Unity Client
Standard Installation
(MSI) Unity Client
Interactive Installation (MSI) Unity Client
Standard Installation
(MSI) Unity Client
Interactive Installation (MSI) Unity Client
Standard Installation
(MSI) Unity Client
Interactive Installation (MSI) Unity Client
Standard Installation
(MSI) Unity Client
Interactive Installation (MSI) Unity Client
Standard Installation (MSI) Advantages
• Prerequisites are installed automatically as long as
the setup.exe executable is used for installation.
– Exception: .NET Framework
#dbwestECM
Standard Installation (MSI) Advantages
• Remote Desktop deployments such as Citrix or Terminal
Server.
– Standard Installation for all users
– Published application
#dbwestECM
Standard Installation (MSI) Disadvantages
• The installer must always be run on the local
workstation by a user who is an Administrator on
that workstation.
#dbwestECM
Controlling the Installer from
the Command Line
Command Line Installations
• 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.
#dbwestECM
Feature Names
Component
Feature Name
Unity Client
Unity_Client
Application Enabler
ApplicationEnabler
Client Automation API
UnityClientAutomation
Virtual Print Driver Listener
VirtualPrintDriverListener
Unity Pop Automation
UpopAutomation
msiexec /i "Hyland Unity Client.msi“ADDLOCAL=Unity_Client,ApplicationEnabler
Command Line Installer Features
Command Line 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 properties. If a property is not
included, the default value is configured for that
property.
#dbwestECM
Properties
Property
Description / Example
AE_DEFAULTFILE
AE_DEFAULTFILE="\\FileServer\Apps\Applicat
ionEnabler\DefaultFile.xml"
CREATE_DESKTOP_SHORTCUTS
CREATE_DESKTOP_SHORTCUTS="1" or
CREATE_DESKTOP_SHORTCUTS=""
CREATE_MENU_SHORTCUTS
CREATE_MENU_SHORTCUTS="1" or
CREATE_MENU_SHORTCUTS=""
SERVICE_LOCATION_DATA_SOURCE
SERVICE_LOCATION_DATA_SOURCE="ODBC
source name"
Command Line Installer Properties
Properties
Property
Description / Example
SERVICE_LOCATION_DISPLAY_NAME
SERVICE_LOCATION_DISPLAY_NAME="My
Service Location"
SERVICE_LOCATION_NT_AUTH
SERVICE_LOCATION_NT_AUTH="false"
SERVICE_LOCATION_SERVICE_PATH
CREATE_MENU_SHORTCUTS="1" or
CREATE_MENU_SHORTCUTS=""
SERVICE_LOCATION_DATA_SOURCE
SERVICE_LOCATION_SERVICE_PATH="http://
MachineName/AppServer/Service.asmx"
Command Line Installer Properties
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"
Command Line Installer Unity Client Example
Resources
https://www.hyland.com/community/
https://www.hyland.com/community/customer_central/p/mrg.aspx
Click-Once Deployment Unity Client
Questions?
Thank You