Installation - Electronic Plan Review - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Electronic Plan Review

Platform
OnBase
Product
Electronic Plan Review
Release
Foundation 23.1
License
Standard
Essential
Premier

Standard (EXE or MSI) Installers

There are two methods for running OnBase installers: Interactive and silent. An interactive installation requires user interaction with dialog boxes during the installation process. A silent installation does not require user interaction during the installation process.

OnBase installers may consist of both an executable file (.exe) and a Windows Installer Package file (.msi). When performing an interactive installation, and both an executable file and MSI are available, use the executable file to ensure a complete installation. The executable validates that all prerequisites are met before proceeding with the installation. If any missing prerequisites are identified, the installer alerts the user. Most missing prerequisites can be installed directly from the installer before continuing the installation process.

Note:

The Microsoft .NET Framework prerequisite must always be installed separately before running either the EXE or MSI installer.

When performing a silent installation, and both an executable file and MSI are available, use the MSI. Since the MSI package does not validate prerequisites, you must ensure that Windows Installer 3.0 or greater is installed on each workstation and that all other prerequisites are met before running the MSI. If any prerequisites are not met, a silent installation from the MSI will fail without alerting the user.

For more information about configuring a silent installation, see 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.

Note:

ClickOnce-deployed applications are not supported by Microsoft within a Remote Desktop environment.

OnBase modules that are deployed using ClickOnce should either take advantage of the ClickOnce deployment method as an alternative to a Remote Desktop deployment, or the module should be installed using a standard installer and deployed using the Remote Desktop methodology.

Note:

Not all OnBase modules that support ClickOnce have a standard installer available. Contact your first line of support if you are unsure how to install and deploy a specific module.

User Account Control (UAC)

If Windows User Account Control (UAC) is enabled, the installer must be run with elevated administrator privileges, even if an administrator is currently logged on. This can be accomplished by right clicking on the installer executable and selecting Run as Administrator from the right-click menu. MSI files cannot be run using the Run as Administrator option. Instead, you must launch the MSI package using the command line. For more information on installing files through the command line, refer to your Microsoft support information or see 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\"".

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.