Install the HotDocs Hub UI

The Hub UI provides a user interface for the Template Hub. This interface enables users to access the functionality of the Template Hub through a web browser. This functionality includes:

Create Template Groups
Assign Templates to Template Groups
Remove Templates from the Template Hub

The Hub UI is also used by other Hub components, such as the User Hub and Interview Hub. When these components are installed, their user interface components are added to the Hub UI, creating a single, unified user interface.

Prerequisites

HotDocs Template Hub API

Install the Hub UI

These steps require the Hub UI installer. If you do not have the installer, please contact your HotDocs Sales Representative.

To install the Hub UI:

Extract files from the installer zip onto your server machine.
Right click installUI.bat and select Run as Administrator.
Click Next.
Optional: you can select which components and settings of the Hub UI to install. However, it is recommended to install all of the components and settings.

Template Hub Web Files – the web application files.

Optional: click Browse to select the installation directory. If you skip this step, HotDocs uses the default installation directory.
Click Next and then click Install.
Click Finish. HotDocs has now installed the Hub UI and opens the Configuration Wizard.
Click Next.
Select the relevant Database option, either I want to use an existing database that has already been created or I want the installer to create the database. Then enter the following information:

You must use the same database you selected when you installed the Template Hub API.

Database Server – type the name of the machine where the database is installed.
Name of Database – type the name of the database for the Template Hub
Select an authentication type – the type of authentication the Template Hub uses to connect to the database. Select either:

Windows authentication credentials of current user – uses the login credentials of the current user to log into the database.
SQL Server authentication using the Login ID and password below – uses the supplied Login ID and Password to log into the database:

If you choose to use SQL Server authentication you cannot use the login ID "sa" in your authentication details.

Enter a Login ID
Enter a Password

Click Next.
Select appropriate option to install the application in IIS, either:

I do not want the application to be installed in IIS – the application is not installed in IIS
I want to install the application under the following Website in IIS – HotDocs installs the application under the default website in IIS.

If you choose to install the application in IIS, click Default Web Site drop-down menu to change site.
Choose to Use the following AppPool (click DefaultAppPool drop-down to change AppPool) or Create a new AppPool.
If you choose to create a new AppPool enter the following information:

Pool Name – the name of the new Application Pool.
Domain for Application Pool – the domain under which the new Application Pool runs.
Login for Application Pool – the login for the new Application Pool.
Password for Application Pool – the password for the new Application Pool.

Click Next.
Select how the application connects to the database. Either:

I want to use the app pool identity to connect the application to the database- uses the AppPool identity to connect to the database.
I want to enter SQL credentials for the application to the database- uses the supplied Login ID and Password to log into the database:

If you choose to use SQL Server authentication you cannot use the login ID "sa" in your authentication details.

Enter a Login ID
Enter a Password

Click Next.
Type in the Hub UI Application Settings:

Enter the Template Hub Api URL – installed with the Template Hub API; by default, the URL is http://localhost/HotDocsTemplateHubAPI/
Enter the Interview Service Api URL – by default,, the URL is http://localhost/HotDocsInterviewServiceAPI/
Enter the Public facing base URL of the Hub UI – This is the URL that HotDocs Developer uses to upload to the Template Hub. Normally it is the machine name where you have installed the UI but if you are using proxy/load-balancer middleware then you must use the address of the proxy/load-balancer. This URL should not contain any paths, like the Template Hub Api URL, i.e. http://localhost.
Enter the Public facing name for the Hub UI – HotDocs Developer uses this name in the upload menu. You can edit this name later from the Options dialog within HotDocs Developer.

Click Next, then click Finish. The Hub UI is now ready to use.

Silent Install

To silently install the Hub UI, use the supplied .msi file.

Open the Windows Command Prompt as an Administrator.
Change the directory to the location of the installer.
Type msiexec /i, the name of the Hub UI .msi file, and the /quiet option for silent installation. The full command is msiexec /i TemplateHubUI_Setup.msi /quiet.
Enter any additional parameter information. You can see the parameters available to use in the section below.
Press Enter. The installation begins>

Parameters

You can use the following parameters during a silent install to change the installation settings.

File Location Parameters

TARGETDIR — the root directory for the installation. The default value is *C:*.
INETPUB — the name of the IIS public folder. The default value is inetpub.
IISROOT — the name of the IIS root folder. The default value is wwwroot.
INSTALLFOLDER — the name of the folder to which the Template Hub installs. The default value is TemplateHub.

You should use the parameters above in combination. For example, the default values install the Template Hub to C:\inetpub\wwwroot\TemplateHub.

Database Parameters

SQLSERVER — the name of the SQL Server where HotDocs created the Template Hub database. The default value is (local).
SQLDATABASE — the name of the database used by the Template Hub. The default value is HDToolboxTemplateStore.

Using Parameters during Installation

When performing a silent install using msiexec, add parameters to the msiexec command. For example:

msiexec /i TemplateHub_Setup.msi /quiet SQLDATABASE=TemplateHub

Log the Installation Process

You can also add logging to the installation process:

msiexec /i TemplateHub_Setup.msi /quiet /log C:\log\install.log