- 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.
The Microsoft .NET Framework prerequisite must always be installed separately before running either the EXE or MSI installer.
When performing a silent installation, and both an executable file and MSI are available, use the MSI. Since the MSI package does not validate prerequisites, you must ensure that Windows Installer 3.0 or greater is installed on each workstation and that all other prerequisites are met before running the MSI. If any prerequisites are not met, a silent installation from the MSI will fail without alerting the user.
For more information about configuring a silent installation, see https://docs.microsoft.com/en-us/windows/win32/msi/command-line-options.
- ClickOnce Installers
Some OnBase modules are installed for deployment using ClickOnce. ClickOnce is a Microsoft technology that installs a deployment package to a central server. This package can then be accessed by users to install the application on their local workstations. The application is installed entirely under the user's profile, ensuring that it cannot interfere with other applications installed on the workstation.
ClickOnce deployments also have the following advantages:
Previously installed versions of the module can be easily and automatically updated to the latest version with little or no user interaction, as long as the deployment server and deployment instance name are not changed.
The module is installed on a per-user basis and does not require administrator privileges for local installation.
There can be multiple instances of the module deployed, allowing for different versions of the module to be installed on a per-user basis, to match the version requirements of the workstation it is being installed to.
For more information on Microsoft's ClickOnce technology see https://docs.microsoft.com/en-us/visualstudio/deployment/clickonce-security-and-deployment.
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.
Not all OnBase modules that support ClickOnce have a standard installer available. Contact your first line of support if you are unsure how to install and deploy a specific module.
- User Account Control (UAC)
If Windows User Account Control (UAC) is enabled, the installer must be run with elevated administrator privileges, even if an administrator is currently logged on. This can be accomplished by right clicking on the installer executable and selecting Run as Administrator from the right-click menu. MSI files cannot be run using the Run as Administrator option. Instead, you must launch the MSI package using the command line. For more information on installing files through the command line, refer to your Microsoft support information or see https://docs.microsoft.com/en-us/windows/win32/msi/command-line-options.
- Silent Installation Using setup.exe
If you are running setup.exe silently from the command line you must use the /q switch and the /CompleteCommandArgs switch, followed by the required command-line arguments.
The q switch specifies quiet mode and is required to suppress the GUI. The CompleteCommandArgs switch must be followed by the command-line parameters required to configure and install the desired components.
The complete string of command-line parameters must be included in double quotes after the CompleteCommandArgs switch. If a parameter in the string also requires double quotes, those quotes must be escaped using \. For example: setup.exe /q /CompleteCommandArgs "INSTALL_PROPERTY=\"my value\" INSTALL_PROPERTY_2=\"my value 2\"".
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.
To install the Integration for RightFax:
It is recommended that the Integration for RightFax be installed on the same machine as the fax server.
- Launch the Integration for RightFax.msi installer. This file is located in the \install\Integration for RightFax\ directory of your Core Services build.
Click Next at the welcome screen. The Custom Setup screen is displayed.
If you are modifying, repairing, or removing a previous installation, the Program Maintenance dialog is displayed instead. See Change, Repair, or Remove an Installation.
Click the drop-down list beside the name of a component to display the installation options:
Will be installed on local hard drive
Installs the selected feature and does not install any dependent, optional functionality. To view optional functionality, click the + icon next to the feature to expand the sub feature list.
Entire feature will be installed on local hard drive
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.
Entire feature will be unavailable
Select this option to remove a feature from the list of features to install.
Select This feature will be installed on local hard drive for each component you want to install. By default, both the RightFax Connector Service and RightFax Connector Service
Configuration are selected for installation. Both components are required in order to fully install and configure the Integration for RightFax.
Only one Connector Service should be installed per environment, even in load-balanced environments. If multiple Connector Services are installed in the same environment, faxes may be processed multiple times by OnBase.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.
To change the installation location of a component, select it and click Browse. The Change destination folder dialog box is displayed:
Type a Folder name in the field provided or select it from the Look in drop-down list. If the destination folder is not changed, components are installed to the following default locations:Note:
64-bit systems should use the Program Files (x86) folder.
Fax Connector Service:
C:\Program Files\Hyland\Services\Fax Connector\
Fax Connector Service Configuration:
C:\Program Files\Hyland\Integration for Fax\Fax Connector Configuration\
It is recommended that both components be installed on the same machine as the fax server.
Click Next at the Custom Setup screen. The NT Service User Account screen is displayed.
If you would like to specify a domain account under which to run the installed services, select Specify domain account to run NT Service.
If you do not specify a service account, the service runs under the Local System account.Note:
In the User Name field, enter the domain and user name to use to run the installed services. This must be entered in the domain\username format.
In the Password field, enter the password that corresponds to the user name provided.
In the Confirm Password field, re-enter the password that corresponds to the user name provided. This is used to ensure that the password is typed correctly.
The domain account specified must have sufficient privileges under the domain to install and run services. Contact your first line of support to ensure that the domain account specified has the required privileges. These privileges are set within the domain and in most cases the Log on as a service privilege is all that is required.
- Click Next. The Ready to install Integration for RightFax Screen is displayed.
- Select Create Desktop shortcut(s) when applicable to create a shortcut to the Fax Connector Service Configuration on the Windows desktop.
- Click Install to install the selected components, or click Back to return to the previous dialogs to change configuration options. Click Cancel to close the installer without installing any of the selected components.
When the Completed screen is displayed, select Launch Fax Connector Service
Configuration to automatically launch the Fax Connector Service Configuration utility.
It is a best practice to select this option and configure Integration for RightFax immediately. The Integration for RightFax must be configured using this utility before it can be used.
- Click Finish to complete the installation.
- Use the Fax Connector Service Configuration utility to complete the configuration of the Integration for RightFax. For more information, see the Configuration chapter of this manual.