Properties - Unity Client - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Premier - Essential

Unity Client

Platform
OnBase
Product
Unity Client
Release
Foundation 23.1
License
Standard
Premier
Essential

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

Description

AE_DEFAULTFILE

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\ApplicationEnabler\DefaultFile.xml"

CREATE_DESKTOP_SHORTCUTS

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=""

CREATE_MENU_SHORTCUTS

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=""

SERVICE_LOCATION_DATA_SOURCE

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"

SERVICE_LOCATION_DISPLAY_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"

SERVICE_LOCATION_AUTHENTICATION_TYPE

Set to one of the following values depending on which type of authentication your system uses:

  • Standard(if using OnBase credentials)

  • NTAuthentication(if using Active Directory or LDAP authentication)

  • Idp(if using Hyland Identity Provider)

  • ADFS(if using Microsoft Active Directory Federation Services)

For example: SERVICE_LOCATION_AUTHENTICATION_TYPE="NTAuthentication"

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.

Note:

Configuring the Unity Client to use other authentication schemes must be done after installation. For more information, see the Legacy Authentication Methods documentation.

SERVICE_LOCATION_SERVICE_PATH

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"

UNITYCLIENT_ADDTOPATH

Set to 1 to add the Unity Client directory to the Windows Path system variable. By default, this property is empty.

For example:

UNITYCLIENT_ADDTOPATH="1" or UNITYCLIENT_ADDTOPATH=""

UNITYCLIENT_AE_HTTPAUTOMATION

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=""

UNITYCLIENT_AE_HTTPSAUTOMATION

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.

UNITYCLIENT_AE_HTTPS_PORT

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.

UNITYCLIENT_AE_PORT

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.

UNITY_CONFIG_SOURCE_PATH

The installation directory for the Unity Client.

UNITYCLIENT_DEFAULT_MAIL_CLIENT

The default mail client for Unity Client. By default, this property is set to outlook.

Note:

Valid values are outlook, lotus, groupwise, and gmail.

Note:

When Microsoft Outlook and Novell GroupWise are installed on the same machine, using GroupWise as the Default Mail Client for the Unity Client may result in unexpected behavior and is not supported.

For example: UNITYCLIENT_DEFAULT_MAIL_CLIENT="outlook" or UNITYCLIENT_DEFAULT_MAIL_CLIENT="lotus"

UNITYCLIENT_DOCPOP_URL

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.

Note:

To use this property, the ADDLOCAL property must be set to UpopAutomation and the UNITYCLIENT_POP_OPTION property must be set to weblink.

For more information on DocPop links, see the DocPop module reference guide.

UNITYCLIENT_FILES

The installation location that will be used instead of the default directory. By default, the installation location is C:\Program Files (x86)\Hyland\Unity Client.

For example:

UNITYCLIENT_FILES="C:\OnBase\InstallFiles\UnityClient"

UNITY_OVERWRITECONFIGFILE

Selects a pre-configured Unity Client configuration file to overwrite the existing configuration file in the installation directory. To enable this setting, set it to 1.

Note:

Requires the installation directory to be defined in the UNITY_CONFIG_SOURCE_PATH setting.

UNITYCLIENT_POP_OPTION

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"

UNITYCLIENT_SERVICEMODE_DISABLEAUTORUN

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_DISABLEAUTORUN="1" or UNITYCLIENT_SERVICEMODE_DISABLEAUTORUN=""

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"