Overview - API Server - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

API Server

Platform
OnBase
Product
API Server
Release
Foundation 23.1
License
Standard
Essential
Premier

There are two methods for installing the API Server: 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.

Note:

The installer automatically installs the ASP.Net Core Hosting Bundle v2.1.26 if it detects that it is not cureently installed.

The installation executable validates that all prerequisites are met before proceeding with the installation. If any missing prerequisites are identified, the installer alerts the user.

Note:

The Microsoft .NET Framework prerequisite must always be installed separately before running the installer.

For instructions on interactively installing the API Server, see Installing the API Server.

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. If you are running a silent installation, you must use a command prompt with elevated permissions.

Silent Installation

If you are running the installation executable silently from the command line you must include the /silent command in addition to any required command-line parameters and flags, as in the following example:

Hyland.ApiServer.Setup.exe /silent "WEB_SITE_ID=1" "APPNAME=ApiServer"

Note:

You should check the return value of the process. A return value of 0(zero) indicates success. Any other value returned may indicate that an error was encountered and the installation failed.

The following command-line parameters are available for use:

Command-Line Parameter

Description

APIROOT

The file path to the root folder where the API Server will be installed.

If this command-line parameter is not present, the default root folder path is .\Program Files\Hyland\ApiServer.

APPNAME

The name of the API Server application in IIS.

If this command-line parameter is not present, the default name for the application is ApiServer.

APPPOOL

The name of the application pool in IIS that you want to be created to run the API Server.

If this command-line parameter is not present, the name of the default application that is created is ApiServerAppPool.

WEB_SITE_ID

The ID of the site in IIS that you want to host the API Server application.

Note:

This is a required command-line parameter if the WEB_SITE_NAME command-line parameter is not present.

WEB_SITE_NAME

The name of the site in IIS that you want to host the API Server application.

Note:

This is a required command-line parameter if the WEB_SITE_ID command-line parameter is not present.

USE_APPPOOL_IDENTITY

Determines whether you want to specify the application pool identity. The value is either true or false.

If this command-line parameter is not present, the default value is false.

APPPOOL_USER

The user name of the identity that will be used for the application pool.

Note:

This is only required if the USE_APPPOOL_IDENTITY command-line parameter is present and the value is true.

APPPOOL_USER_PASS

The password of the identity that will be used for the application pool.

Note:

This is only required if the USE_APPPOOL_IDENTITY command-line parameter is present and the value is true.

CONFIGURATIONDIRECTORY

The directory containing the configuration files for the API Server. This parameter preserves existing configuration files during repair and upgrade installs.

REQUIRESSL

Sets the Require SSL property in IIS to true if any value is provided.

SKIPCONFIGUREIIS

Prevents the installer from modifying IIS if any value is provided.

Note:

IIS must be configured manually if this parameter is included.

SKIPDOTNETBUNDLE

Can be set to skip installation of the hosting bundle.

The following flags are available for use:

Command-Line Flag

Description

-layout

This flag is used to make the API Server installer download the ASP.Net Core Hosting Bundler installer in advance. As long as the installer is kept next to the actual API Server installer, the local copy of the hosting bundle installer will be used instead of attempting to download it.