Running the Installer - 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

Launch the Hyland Unity Client installer by executing setup.exe. This executable is usually located in the \install\Unity Client\ folder of your source installation files.

Note:

If the installer is being copied from the source location to be run from a different location, the entire Unity Client folder and its contents must be copied to the new location.

  1. The Hyland Unity Client installation welcome dialog is displayed.
  2. Click Next. The Destination Folder dialog box is displayed.
  3. Enter the top-level installation directory in the field provided, or click Change to browse to it.
    Note:

    This location does not affect components not installed under the top-level directory. If the installer provides for the installation of multiple components, the specific installation locations of each component can be changed later in the installation process.

    If Change is clicked the Change destination folder dialog box is displayed.

    Enter a Folder name in the field provided or select it from the Look in drop-down list, then click OK.

    If the Destination Folder is not changed, the default location is used.

  4. Click Next. The Custom Setup dialog is displayed.

    The following features can be installed using the Hyland Unity Client installer:

    Component

    Description

    Unity Client

    Installs the Unity Client.

    The Unity Client is a next-generation document management system that offers the familiar look-and-feel of Microsoft® Office® 2013.

    Application Enabler1

    Installs the Application Enabler module.

    Application Enabler provides a way to seamlessly integrate an organization's core line-of-business applications with OnBase.

    Client Automation API1

    Installs the Unity Client Automation API, which is used by third-party applications to automate the Unity Client.

    Virtual Print Driver Listener1

    Installs the Virtual Print Driver listener.

    Unity Pop Automation

    Installs Unity Pop.

  5. Click the drop-down list beside the name of a component to display the installation options:

    Option

    Description

    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.

  6. Select This feature will be installed on local hard drive for each component you want to install.
    To install all components, select Entire feature will be installed on local hard drive from the drop-down list beside the top-level component.
  7. To determine the amount of space available for installation of the selected components, click Disk Usage. The Disk Space Requirements dialog box is displayed, with information on the space required for the selected components and the space available on the drives accessible by the installation machine.
  8. To change the installation location of a component, select it and click Browse. The Change destination folder dialog box is displayed.

    Enter 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 default locations listed in the following table.

  9. Click Next. TheService Location dialog is displayed.
  10. In the Display Name field, enter a user-friendly name for the service location.
  11. In the Service Path field, enter the full URL to the Service.asmx page on the OnBase Application Server. For example, https://MachineName/AppServer/Service.asmx.
    Note:

    Ensure that the Service Path reflects the configuration of the OnBase Application Server in regard to HTTPS bindings. If the Application Server is not configured to use HTTPS, setting the Service Path to HTTPS in this installer does not configure an HTTPS binding on the OnBase Application Server.

  12. In the Data Source field, enter the data source name this component will use to connect to OnBase.
  13. Select Yes from the Use NT / LDAP Authentication drop-down list if your system uses Active Directory or LDAP Authentication, otherwise select No.
    Note:

    In order to use Active Directory or LDAP authentication, the database against which the installed component runs must be separately configured for Active Directory or LDAP authentication. This installer configures the installed components to match the authentication scheme of the database but does not configure Active Directory or LDAP.

  14. Click Next. The Additional Settings dialog is displayed.

    In the Default Mail Client drop-down list, select the default email client that users will use to send external mail from within the Unity Client.

    If you chose to install Unity Pop Automation, the Additional Settings dialog includes Unity Pop options.

    In the Unity Pop option drop-down list, select the Pop integration option that will be used for document retrieval and viewing.

    Option

    Description

    DocPop Link

    Select this option to use DocPop. The DocPop URL field will become available. For more information, see the DocPop module reference guide.

    Unity Pop File

    Select this option to use Unity Pop Files. For more information, see Viewing Unity Pop Files and Links and Configuring Unity Pop.

    Unity Pop Link

    Select this option to use Unity Pop Links. For more information, see Viewing Unity Pop Files and Links and Configuring Unity Pop.

    CAUTION:

    Do not select Unity Pop Link if existing Unity Pop files are still in use by your organization.

  15. Click Next. If you chose to install Application Enabler Client, the Application Enabler Options dialog is displayed.
    1. In the Default Configuration File field, enter the full URL or UNC path to the default configuration file that Application Enabler should use (for example, \\FileServer\Apps\ApplicationEnabler\DefaultFile.xml), or click Change to navigate to the file to use. Leave this field empty to not configure a default file.
    2. Select Enable HTTP Automation to expose an HTTP endpoint to allow third-party applications to perform Application Enabler context events.
    3. If Enable HTTP Automation is selected, type the port number for the HTTP endpoint in the Port field. The default value is 15412.
    4. Select Enable HTTPS Automation to expose an HTTPS endpoint to allow third-party applications to perform Application Enabler context events.
      Note:

      HTTPS Automation requires additional configuration after installation.

    5. If Enable HTTPS Automation is selected, type the port number for the HTTPS endpoint in the Port field. The default value is 15425.
  16. Click Next. If you chose to install any of the Service Mode components, the Service Mode Options dialog is displayed.

    Select Prevent Client from launching on system startup to prevent the Client from automatically launching when the system starts.

  17. Click Next. The Unity Configuration File Location dialog is displayed:
    1. Select Deploy pre-configured Unity configuration file from specific location to select a pre-configured Unity Client configuration file to overwrite the existing configuration file in the installation directory.
    2. Enter the file path of the pre-configured Unity Client configuration file in the Unity Configuration File Path field, or click Change to browse to and select it.
  18. Click Next. The Ready to install dialog is displayed.
  19. Select Create Desktop shortcut(s) when applicable to create shortcuts to the installed components in the Windows Start | All Programs | Hyland menu, on the Windows desktop, or in both locations, when applicable.
  20. Click Install to continue with the installation, or click Cancel to cancel the installation.
  21. When the installation is complete, click Finish.
    Tip:

    In order to ensure that the required system settings take effect, it is a best practice to restart the installing machine once the installer has finished.

    Note:

    Some functionality must be configured directly in the configuration file. See Post-Installation.

1 Because this component can only run when the Unity Client is in Service Mode, choosing to install this component automatically configures the Unity Client to run in Service Mode.