Installing BA Insight modules

Satisfy the prerequisites applicable to your environment before proceeding.

Installing Connectivity Hub

To install Connectivity Hub, use the following procedure:

  1. To install the Connectivity Hub, download the BA Insight Connectivity Hub .zip file from the Upland Community.

    Make sure to unblock the .zip file by right-clicking on the file, selecting Properties and clicking the Unblock button.

  2. Extract the "Upland BA Insight Connectivity Hub-4.x.x-xx" .msi installer package from the downloaded zip file.
  3. Run the downloaded .msi with Administrator privileges.
    Use the steps here or perform a silent installation described in the topic below.
    1. Run a command prompt as an Administrator.
    2. Navigate to your Connectivity Hub installation directory.
    3. Enter the following command: msiexec /i "Upland BA Insight Connectivity Hub-4.x.x-xx.msi"
    4. Press Enter.
  4. Follow the instructions in the installation wizard.

  5. When you are prompted to select an installation folder, note the path of the folder

    Typically, the program is installed in either the default path - C:\Program Files\Upland BA Insight\ConnectivityHub\ - or to a path on an alternate local disk drive such as the D:\ drive.

  6. When you are prompted to specify a service account, be sure to include the user account domain in the "User Name" field.
    1. For example, "DomainName\Username" 

Note: The default port number: 55001. If you specified a different port number, record this number for later use.

Backend Services - Text Extraction

Backend services, including the Tika Text Extraction service in BA Insight Connectivity Hub v4.0+, are installed via the installation wizard.

  1. In the Job Service Port field, accept the default value or enter a new port number.

  2. In the Full Path to java.exe field, Confirm the full path to your java.exe file.

  3. In the Text Extraction Service Port field, accept the default value or enter a new port number.

How to Perform a Silent Install

  1. To perform a silent installation, open a command prompt with Administrator privileges and enter the commands in the example below.

  2. Use the parameters listed below.

Parameters

  • INSTALLDIR:
    • This is the directory in which to install Connectivity Hub.
  • AUTHORIZEDROLE:
    • Optional
    • This is the security group allowed to access the web admin.
    • Default: Administrators
  • SERVICELOGIN:
    • This is the service account that Connectivity Hub runs under.
  • SERVICEPASS:
    • Password for the account.
  • WEBPORT:
    • Optional
    • This is the port number for the admin website.
    • Default: 55001
  • SERVICEPORT:
    • Optional
    • This is the port number for the job scheduler service.
    • Default port: 555

Silent Install Example

Example Code
Msiexec  /i "Upland BA Insight Connectivity Hub-4.0.0.0-10255.msi" 
INSTALLDIR="c:\CH" SERVICELOGON="domain\sp_user" 
SERVICEPASS="xx" WEBPORT=5555 SERVICEPORT=556 AUTHORIZEDROLE=Administrators /qn

Post-installation

Adjust your authentication method

In Connectivity Hub 4.0, support was added for the Azure Application Gateway V2 load balancer. This load balancer does not support NTLM authentication, which was the default mechanism for Connectivity Hub 3.x and earlier. As a result, the default authentication mechanism when you install Connectivity Hub has been changed from Windows Authentication to Basic Authentication.

If you don't want to use a load balancer for Multi-Server Configuration, and you want to use Windows authentication, you must perform the following steps:

  1. Open IIS and click on your Connectivity Hub website.

  2. In the middle panel, click Authentication.

  3. In the Authentication list, do the following:

    • Click Windows Authentication, then select Enable from the Actions panel.

    • Click Basic Authentication, then select Disable from the Actions panel.

Installing AutoClassifier

  • About the AutoClassifier engine

  • Installing the AutoClassifier Engine

  • AutoClassifier post-installation configuration

About the AutoClassifier Engine

The AutoClassifier Engine enables content from other source systems to be classified such as:

  • File shares

  • Email/chat sources

  • Databases

  • etc.

  • For a list of potential source systems, see Connectors Help.

AutoClassifer uses text analytics and machine learning to create metadata, aiding you in organizing and finding data quickly and efficiently.

When installation is complete, you will see the following in your IIS Manager:

  • If you installed to run on a single server, a single AutoClassifier site is shown.
  • If you installed for scale, both the AutoClassifier and Lucene sites are shown (shown in the screenshot below):
     

Installing the AutoClassifier Engine

Use the following steps to install AutoClassifier.

Procedure:                                             

  1. Double-click the BA Insight AutoClassifier<version>.msi to run the installer.
  2. Read and accept the End User License Agreement and click Next to continue.
  3. Continue to the Components to be installed dialog and select any of the following options:
    • Install AutoClassifier Admin Site and Engine: Select this option to install the base AutoClassifier Admin Site and Engine. This includes a single Lucene site, and can be installed on a single server or multiple servers behind load balancing. If you are installing AutoClassifier on a single server, a separate Lucene Site is not required as the needed functionality is embedded in the engine. 
    • Install AutoClassifier Adapter Crawler (optional): Select this option only if you are using AutoClassifier Adapters to crawl and tag content. For example, AutoClassifier can crawl and tag Elastic in-place. This option can be installed with or without the AutoClassifier Engine.
    • Install AutoClassifier Lucene site (optional): Select this option only if you are installing in a scaled environment. When selected, this Lucene site overrides the default site included in the Install AutoClassifier Admin Site and Engine option.
      • If the AutoClassifier Admin Site is to be installed on multiple servers for load balancing, install exactly one Lucene Site.
        • The Lucene Site cannot be scaled.
        • It is used for development purposes only.
      • If AutoClassifier is being installed on a single server, a separate Lucene Site is not required, as the needed functionality is embedded in the engine. 
      • If you set up a custom binding to your AutoClassifier Engine site, you must update it in the Lucene Site web.config file. To do so, set the new value in the AutoClassifierServiceUrl setting. For example: <value>http://company.contoso.com:8080 </value>
    • Configure Existing AutoClassifier Lucene Site: When scaling AutoClassifier, the installer can point to an existing Lucene Site.
    • Install AutoClassifier Python Script Runner Rest API (optional): Select this option if you want to use Python script capabilities in your AutoClassifier Pipelines with the AutoClassifier Python Script component. If you select this option, you must have Python 3.9.0 or later installed on your server.
      Note the following:
      • The AutoClassifier Python Script Runner Rest API runs as a Windows Service under the service account provided.
      • After Installing the AutoClassifier Python Script Runner Rest API, a new Python Script Runner Service folder is added to your installation folder under /Upland BA Insight/Upland BA Insight AutoClassifier/.
      • If you do not install the AutoClassifier Python Script Runner Rest API in your instance during the installation process, then decide later that you would like to install it, you must uninstall and reinstall your AutoClassifier instance.
    • Configure Existing AutoClassifier Python Script Runner Rest API (optional): When scaling AutoClassifier, select this option to point the installer to an existing AutoClassifier Python Script Runner Rest API.
  4. Click Next and the Specify running account dialog appears. In the Domain\User Name field, enter the account credentials that will run the installed Application Pools and Windows Services. This account must have standard privileges. In the Password field, enter the password for the account.
  5. Click Next.
  6. If you selected Install AutoClassifier Python Script Runner Rest API, the Specify the Python settings dialog appears. In the Full Path to python.exe field, enter the path to your python.exe file. If you are unsure of the path, open the Windows Command prompt and type the following command: where python. The system will display the paths where Python is installed.
  7. Click Next to continue.
  8. On the Specify the configuration ports window, accept the default configuration ports or enter your own values. Note these values in the Installation Prerequisite checklist. You must ensure that these ports are free. If another application is already using a specified port, stop that process or use a different available port for your services.
  9. Click Next to continue.
  10. Database and Logging Setup 

    If you use Microsoft Azure SQL, you can initialize and configure your database. The following authentication methods are supported:

    • SQL authentication

    • Microsoft Azure Active Directory username and password authentication

    • Microsoft Azure Active Directory Integrated authentication

    • Microsoft Azure Active Directory Service Principal authentication

    • Microsoft Azure Active Directory Managed Identity or Managed Service Identity (MSI) authentication

    Important: of the modes listed above, only Microsoft Azure Active Directory Managed Identity or Managed Service Identity (MSI) authentication requires additional managed identity configuration. If you are planning to use managed identity authentication, see enable managed identities. The remaining modes require that you specify the appropriate authentication connection property in your connection string. For more information, see Connect to Azure SQL with Microsoft Entra authentication and SqlClient in the Microsoft documentation.
    1. Database Connection String
      1. Configure the AutoClassifier database connection string, including:
        • Server
        • Database
        • Trusted Connection
        Due to a vulnerability fix on the SQL Client, the default encryption flag for SQL Connections has been changed to true. As a result, you must specify Encrypt=false in your connection string if you do not support encryption in your database. For example, Data Source=.;Initial Catalog=AutoClassifier_DB;Integrated Security=True;Encrypt=False
    2. Logging Files Path
      1. The path to the directory that will store AutoClassifier's logging files.
      2. Accept the provided default path or set to a different path as desired.
    3. File Storage Path
      1. The path to the directory that will store AutoClassifier's recorder and Lucene index files.
      2. Accept the provided default path or set to a different path as desired.
  11. Click Next to continue.
  12. If you selected Configure Existing AutoClassifier Python Script Runner Rest API, In the Python Site field, enter the address of your existing AutoClassifier Python script runner site. For example, http://<server address>:1969.
  13. Java Settings: Specify the full path to your java.exe file
    1. Full Path to java.exe:
      1. Specify the full path to your java run time environment (JRE) executable (.exe) file.
      2. For example: C:\Program Files\AdoptOpenJDK\jdk-8.0.202.08\jre\bin\java.exe
    2. Default value:
      1. JAVA_HOME environment variable (if configured)
  14. Click the buttons Next > Install > Finish sequentially, to complete your installation.
If you are installing the AutoClassifier Python Script Runner Rest API, note that your installation will take significantly longer to complete.

After you have installed AutoClassifier, you must add your license in order to be able to use AutoClassifier functionality.

AutoClassifier Engine Post-Installation Configuration

If your company policy prevents service accounts from having db_creator permissions, the database can be manually created by a database administator. If this applies to you, perform the steps in the Setup AutoClassifier Database Manually section, then return to this section and perform the steps in the topics below.

Configure your HTTPS bindings for Identity provider authentication

As part of the AutoClassifier installation process, you automatically create both HTTP and HTTPS bindings. If you wish to use an identity provider to provide access to the AutoClassifier administration portal, you must configure it using HTTPS.

Use the following steps to configure your AutoClassifier site in IIS to enable IdP authentication:

  1. In IIS, select your AutoClassifier website.
  2. select the Bindings... entry from the Actions panel.
  3. In the Site Bindings window, select our HTTPS binding and click Edit.
  4. In the SSL certificate field, you must provide an SSL certificate. This should be the certificate that is used in your BA Insight app registration.
  5. Click OK.
  6. Port: Enter a port that is not used by another site from IIS. For HTTPS, port 8443 is commonly used
  7. Host name: Enter the host name in your BA Insight app registration to restrict access to the host name (address your users enter into a web browser).
  8. Click Save.
  9. On the IIS page for your AutoClassifier website, click Authentication.
  10. On the Authentication page, enable Anonymous Authentication. Ensure that Basic Authentication is disabled.

Single Server and Scaled Configurations

  1. Navigate to the IIS Manager:
    • If you installed IIS Manager to run on a single server, a single AutoClassifier site is shown.
    • If you installed IIS Manager for scale, both the AutoClassifier and Lucene sites are shown.

  2. Browse the BA Insight AutoClassifier Admin website.

    Info

    As of AutoClassifier v6.0, any database settings specified within the MSI are automatically applied upon launching the AutoClassifier Site (in IIS). 

    If the automated process fails due to a permissions issue, timeout, or invalid database settings specified in the MSI, the user is automatically re-directed to the Database Settings page, where they can manually correct the issue and re-apply the settings. 

    Steps 3 - 7 will not be seen when the automation succeeds.

  3. Database settings: You must update this connection string with the settings of your existing AutoClassifier database.

    • For On-Premise installations, AutoClassifier_OnPrem is the default Initial Catalog value in v5.
    • This setting must be specified regardless of whether you chose to create your own database or use the database created by AutoClassifier.
      1. If you enable AutoClassifier to create the database and standard SQL security is used, DO NOT enter the password in the Connection String.
      2. If you are using Integrated Security, the Password text box should not be used.

  4. Expand the Setup menu entry on the left side.

  5. Click Create or Connect Database.
  6. After the database has been successfully created, or connected, the page refreshes and you are prompted to configure the database if required.
  7. Click Configure to continue.

  8. Click Close to return to the AutoClassifier Management Site.

    Note: If Standard SQL Server Securing is used, the Web.config section is automatically encrypted. 
    Once encrypted, you cannot manually edit the Connection String.

Scale Configuration Only

If you are installing in a scaled environment, you must update the web configuration for the Admin Site and Lucene Site.

After you have completed step 6 above, complete the following steps to edit these files:

  1. Manually edit the Web.config file from the Admin Site installation location:

    1. Update the Lucene Site location.

      <setting name="LuceneServiceUrl" serializeAs="String">
           <!--Leave Value Empty to run In-Line -->
           <!--Point to Installed Lucene Web to Run in
           Scale Out Mode -->
           <value></value>
      </setting>

      <setting name="LuceneServiceUrl" serializeAs="String">
           <!--Leave Value Empty to run In-Line -->
           <!--Point to Installed Lucene Web to Run in
           Scale Out Mode -->
           <value>http://lucenesitename:800</value>
      </setting>

    2. Update the Lucene site connection string:

      1. Open the Lucene Site Default.aspx page.

      2. Update this connection string with the settings of your existing AutoClassifier database and click Connect Database, if necessary.

    3. Copy the Admin Site Web.config file and use this file to replace the current Web.Config file on any additional web servers where you have installed the Admin Site.

Installing SmartHub

Be sure to install all of the prerequisites listed for your SmartHub and search engine. Any issues experienced by BA Insight clients during installation are typically traced to a failure to meet the required prerequisites. You must satisfy all of the requirements listed in the Prerequisites topic for your search engine.

Use the following procedure to install SmartHub.

Overview

To install SmartHub, perform the following high-level tasks:

  1. Extract the SmartHub files to a local directory.

  2. Create a SmartHub website in IIS.

  3. Set the bindings for the new SmartHub website.

  4. Assign an application pool with the required rights to the website.

Extract SmartHub Files to a Local Directory

  1. In Windows Explorer, navigate to the location where you downloaded the SmartHub installation package.

  2. Extract the archive to a directory of your choice, such as C:\Program Files\BA Insight\SmartHub\.

  3. Continue to create your SmartHub website in IIS, set the bindings for the website, and assign an application pool to the site.

Create the SmartHub Web Site in IIS

The following steps will create a new IIS website with a new application pool named SmartHub. BA Insight recommends that you allow IIS to create this new application pool, however you will want to modify the application pool after the website is created in order to specify the application pool account.

Note: When using the default settings below, the Application Pool account that is created does not have "Modify" permissions on the configuration folder and therefore cannot read or write configuration settings.To secure the configuration folder for the application pool account (using the default or custom account), see Give Read/Write Permissions to System User Running Application Pool.
  1. Open IIS manager.

  2. Expand <Sites>.
    1. Right-click <Sites> and select Add Website from the pop-up window.

  3. Site name: Enter your site name.
    1. For example, "SmartHub".

  4. Physical path: Enter the path to the unzipped SmartHub package.
  1. Click OK.
  2. Now that your SmartHub site is created, we recommend you modify your Application pool identity.
  3. Select an Application pool identity that has FULL permissions to your SmartHub installation directory and the files within it.
    1. The default AppPool identity (ApplicationPoolIdentity) DOES NOT have the necessary permissions.
    2. See the topic How to Change Your Application Pool Identity Account below.

Bindings

As part of the installation process you create bothHTTP and HTTPS bindings.

  • Type: http or https.
    • SmartHub must have bindings for both HTTP and HTTPS. See the graphic above.

Use the following steps to enable both bindings in your SmartHub site:

  1. The Site Creation Wizard in IIS allows only a single binding when first creating a site (either HTTP or HTTPS). After you create your SmartHub site, create a second, additional binding to the same site (either HTTP or HTTPS):
    1. In IIS, select your SmartHub website.
    2. select the Bindings... entry from the Actions panel.
    3. In the Site Bindings window, click Add.
    4. Select the binding you are missing (HTTP or HTTPS).
    5. if you select HTTPS, choose your SSL certificate.
    6. Click OK.
  2. Port:
    1. Enter a port that is not used by another site from IIS.
      1. HTTP: Port 80 or 8080 is commonly used
      2. HTTPS: Port 443 is commonly used

  3. Host name (optional): Enter a host name to restrict access to the host name (address your users enter into a web browser).
    1. The host name can be a DNS address, local machine name, localhost, and so on.

  4. Click Save.

  5. If you select Content View from the bottom of your SmartHub Content site, your folder structure should resemble the structure shown below:

IMPORTANT! To access the site, users must have READ access to the folder.

Give Read/Write Permissions to System User Running Application Pool

Your SmartHub website requires an application pool account that has both read and write permissions to the SmartHub directory on your server. To give permissions only to the system user running the application pool, assuming you are using IIS7, perform the following steps:

  1. Open IIS7.

  2. Select the website for which you need to modify permissions.

  3. Click Basic Settings... under "Edit Site" in the right side Actions pane.
  4. Note the name of the application pool identity you are using.
    1. For example, "ApplicationPoolIdentity".
    2. Note that most Administrators change this identity to a different user account, such as <domain>\<YourSmartHubUser>.
  5. Go to Application pools in the Connections panel and find the application pool from step 4.

  6. Find the system account used for running application pool (Identity column).

    Info: To change the system account that is used to run your SmartHub Application Pool, see How to Change Your Application Pool Identity Account below.

  7. Navigate to your SmartHub site in IIS, select it, and click Edit Permissions under the Actions pane on the right side.

    1. Click the Security tab and add the desired permissions for only the user account identified in step 4.

Note: If you choose to use the default identity user account ApplicationPoolIdentity in step 3, reference this system user in the format IIS AppPool\<application_pool_name>. For example, IIS AppPool\DefaultAppPool.
Note: When adding this user, make sure to set correct locations in the Select Users or Groups dialog.

This must be set to the local machine because this is a local account.

How to Change Your Application Pool Identity Account

Use the following instructions to change your Application Pool Identity account.

  1. Open IIS manager if it is not already open.

  2. Click Application Pools from the left-side Connections panel.

  3. Select the Application Pool you wish to change. Note that you can sort your Application Pools by categories such as Name, Status, Identity, Applications, and so on.

  4. In the advanced settings window, right-click the Application Pools whose identity you wish to change and select the "..." button.

  5. Select the built-in account you wish to use from the drop-down menu or click the Custom account radio button and click the Set button.

  6. Enter the credentials of the Application Pool Identity account you wish to use. Be sure to enter the account user name in the format <domain>\<name>.