Prerequisites

Universal prerequisites

Note the following prerequisites that are common across all BA Insight products:

Requirement Description
Operating System

The following software must be installed and running:

  • Microsoft Windows Server 2016, 2019, or 2022.

Microsoft is ending support for Windows Server 2016 on January 12, 2027. As a result, you must upgrade to Windows Server 2019 or 2022 after the end of life date.
User accounts and permissions

The following user accounts and permissions are required in all BA Insight products

  • Installation account

    • The installation account must be a local administrator and must be entered in the following format: domain\user.

  • Service account

    • The service account must be a domain account if either of the following is true:

      • You are connecting to a database on a remote server using Windows Integrated Authentication.

      • You have more than one server running Connectivity Hub in your server farm.

    • This account must have the permissions to log on as a service.

    • This account must be entered in the following format: domain\user

  • Installation account:

    • The installation account is used to install BA Insight and must be in the following format domain\user.

    • Additionally, this account must be the local admin on the machine and requires read/write access to the directory SmartHub is installed in.
Windows Server roles and features

The following Windows features are required:

  • Server roles

    • Application Server

    • Web Server IIS

      • Web Server

        • Security

        • Application development

          • .NET Extensibility 4.7

          • ASP

          • ASP.NET 4.6

            • ISAPI extensions

            • ISAPI filters

            • WCF services

              • HTTP activation

        • Common HTTP features

          • Default Document

          • Directory Browsing

          • HTTP Errors

          • Static Content

        • Health and Diagnostics

          • HTTP Logging

        • Performance

          • Static Content Compression

  • Features

    • Microsoft Internet Information Services (IIS)

    • .NET Framework 4.7 Features

      • WCF services

        • HTTP activation

        • TCP port sharing

    • Enhanced storage

    • Windows Defender features

      • Windows Defender

      • GUI for Windows Defender

    • Windows PowerShell

      • Windows PowerShell X.x

      • Windows PowerShell ISE

    • Windows Process Activation service

      • Process Model

      • Configuration APIs
.NET Framework

  • .NET Framework v4.7.2 Required for Windows Server versions: 2012, 2016, 2019

  • .NET Framework v4.8 is required for Windows Server version: 2022 Included with Windows (used automatically, by default)
Java

BA Insight support Java v11. For more information, see https://adoptium.net/temurin/releases/?version=11.

Java v11 must be set as a system variable, and not a user variable.

BA Insight develops and tests using Adoptium. BA Insight does not guarantee support of Oracle Java, but it may function in your environment.

Web Browser support

The following web browsers are officially supported:

  • Google Chrome

  • Chromium-powered Edge

The following web browsers are not officially supported, but they may work with Connectivity Hub:

  • Microsoft Edge

  • Firefox

  • Safari

  • Etc.
Database support

BA Insight requires SQL server 2019. In large environments where a database team is responsible for creating and maintaining databases, BA Insight recommends following your standard internal practice for database creation, and assigning the appropriate user account the appropriate permissions as defined below:

  • Enable BA Insight to create the repository databases:

    • The Windows user account must have dbCreator permissions on the SQL Server Instance.

  • Create your own database:

    • This options requires that your Windows user account have dbOwner permissions to the database.
License You must add a valid BA Insight license to the /License/ folder in the relevant sub-product installation package. For example, "<Program Files>\Upland BA Insight\Upland BA Insight <product>\License".

Connectivity Hub

Additional Connectivity Hub prerequisites

Search engine Details
Azure AI Search In Connectivity Hub, there is one index created per content source for Azure AI Search. The search index is populated when you perform your first target sync in Connectivity Hub.
Elasticsearch

For Connectivity Hub users on Elasticsearch, Connectivity Hub v4.0 and later supports Elasticsearch v7 to v8.x.

In Connectivity Hub, there is one index created per content source for Elasticsearch. The search index is populated when you perform your first target sync in Connectivity Hub.
Microsoft Search Microsoft Search requires access to the internet from your Connectivity Hub server.
Solr

Solr cloud

  • Connectivity Hub is only compatible with Solr version 7.x, configured with SolrCloud.

  • Basic authentication is supported. If Solr is secured, a username/password to read/write/delete to and from the collection

Solr Standalone

  • Connectivity Hub is only compatible with Solr v7.x and v8.x in Stand Alone Mode

  • Basic authentication is supported. If Solr is secured, a username/password to read/write/delete to and from the collection

  • Access to the Solr user interface, to create collections, if necessary (if using Manual Index creation option). You must be able to create one collection per Content Source. Solr in Standalone mode does not have an API to create indexes without first configuring the index

AutoClassifier

Additional AutoClassifier prerequisites

prerequisite Description
Python

Python 3.9.0 and later is supported.

If you are planning to use Python script capabilities, you must install Python for all users. You can have multiple versions of Python installed on your server, and specify the version you wish to use in the Python script component.

Additionally, when installing AutoClassifier, you must Install the AutoClassifier Python Script Runner Rest API.
Adoptium JDK v11

Select the Custom Setup options shown below:
Adapter crawler support
Elasticsearch

AutoClassifier v7.2 and later supports Elasticsearch version 7 and later. Authentication must be done via username and password.
SharePoint Online

AutoClassifier v7.2 and later supports SharePoint Online.

SharePoint must be able to register a SharePoint app and have permissions to access the term store. See the SharePoint Online add-in Prerequisites topic for specific requirements.
SharePoint On-prem AutoClassifier v7.2 and later supports SharePoint 2016/19/SPSE.
Database Requirements
SQL Server

AutoClassifier uses a SQL Server database as a backend repository.

  • AutoClassifier creates the (empty) database after the installation.

  • AutoClassifier later connects to the database and populates it.

  • Alternatively, you can create the repository database after installation, but before configuration.
Azure SQL

An SQL account with dbOwner permissions on the SQL database for use with AutoClassifier.

  • When using Azure SQL, it is strongly recommended to connect to an already existing database (empty or not).

    • If the database does not exist, AutoClassifier automatically creates the database for you with optimum database parameters (these are not under your control and may generate unexpected costs).

    • To correctly control the database dimensions and costs for the AutoClassifier database, manually create the database and configure AutoClassifier to connect to it.

Account requirements
SharePoint Account (for SharePoint backends/integrations) If you are using AutoClassifier with SharePoint (Online or On-Premise), the SharePoint App user account (app@sharepoint) must be added to the SharePoint Term Store (under Site Settings).

SmartHub

Additional SmartHub prerequisites

Search engine Prerequisite Details
Amazon Kendra Elasticsearch Index

Elasticsearch v7.10-8.x is supported.

SmartHub supports secured or non-secured Elastic configurations.

The Elasticsearch index used for the SmartHub data does not have to be the same instance used for the search index (search engine).

Java: The SmartHub Analytics component requires Elasticsearch Java JDK. Elasticsearch v7.x and later bundles Java with the software (OpenJDK). A separate Java download/install is NOT required. For more information see Elasticsearch documentation.

For assistance installing a single-node instance of elastic, see Install Elasticsearch for Analytics.
Kibana

Kibana v7.10-8.x is supported.

  • Kibana must be configured to use the above Elasticsearch index.

  • SmartHub supports secured or non-secured Kibana configurations

  • You must use the same version of Kibana that is used for your Elasticsearch index (Example: v7.10 for each application)

  • For assistance installing Kibana and running as a windows service, see Install Elasticsearch for Analytics.
Haystack (Optional)

Haystack Service is required for the Questions and Answers feature.

Upland BA Insight recommends Haystack be deployed to a separate server/resource so SmartHub performance is not negatively impacted.
NLQ Services (Optional)

RASA v1.9, Amazon Lex, and CLU are supported. Only one NLQ service should be configured.

For more information, see:
Amazon Kendra

You must have an Amazon Kendra instance and know the following:

  • Kendra index name

  • Kendra access key

  • Kendra secret key

  • Kendra region
Azure AI Search Elasticsearch Index

Elasticsearch 8.1.2 is supported.

SmartHub supports secured or non-secured Elastic configurations.

The Elasticsearch index used for the SmartHub data does not have to be the same instance used for the search index (search engine).

Java: The SmartHub Analytics component requires Elasticsearch Java JDK. Elasticsearch v7.x and later bundles Java with the software (OpenJDK). A separate Java download/install is NOT required. For more information see Elasticsearch documentation.

For assistance installing a single-node instance of elastic, see Install Elasticsearch for Analytics.
Kibana

Kibana 8.1.2 is supported.

  • Kibana must be configured to use the above Elasticsearch index.

  • SmartHub supports secured or non-secured Kibana configurations

  • You must use the same version of Kibana that is used for your Elasticsearch index (Example: v7.10 for each application)

  • For assistance installing Kibana and running as a windows service, see Install Elasticsearch for Analytics.
Haystack (Optional)

Haystack Service is required for the Questions and Answers feature.

Upland BA Insight recommends Haystack be deployed to a separate server/resource so SmartHub performance is not negatively impacted.
NLQ Services (Optional)

RASA v1.9, Amazon Lex, and CLU are supported. Only one NLQ service should be configured.

For more information, see:
Azure AI Search

SmartHub v6.x and later supports Azure AI Search as a search index.

Before you integrate your Azure Search Backend with SmartHub you must satisfy the following requirements:

  • Azure Cognitive Search subscription

  • Existing search service

  • Existing search index under the search service which contains fields for all metadata

Azure Index Limitation: In SmartHub you must configure one backend for every Azure Search index you intend to query.

You must know the following information about your Azure AI Search instance:

  • Azure Cognitive Search URL

  • Azure Cognitive Search Username

  • Azure Cognitive Search Password
Elasticsearch Elasticsearch Index

Elasticsearch 8.19.2 is supported.

SmartHub supports secured or non-secured Elastic configurations.

The Elasticsearch index used for the SmartHub data does not have to be the same instance used for the search index (search engine).

Java: The SmartHub Analytics component requires Elasticsearch Java JDK. Elasticsearch v7.x and later bundles Java with the software (OpenJDK). A separate Java download/install is NOT required. For more information see Elasticsearch documentation.

For assistance installing a single-node instance of elastic, see Install Elasticsearch for Analytics.
Kibana

Kibana 8.19.2 is supported.

  • Kibana must be configured to use the above Elasticsearch index.

  • SmartHub supports secured or non-secured Kibana configurations

  • You must use the same version of Kibana that is used for your Elasticsearch index (Example: v7.10 for each application)

  • For assistance installing Kibana and running as a windows service, see Install Elasticsearch for Analytics.
Haystack (Optional)

Haystack Service is required for the Questions and Answers feature.

Upland BA Insight recommends Haystack be deployed to a separate server/resource so SmartHub performance is not negatively impacted.
NLQ Services (Optional)

RASA v1.9, Amazon Lex, and CLU are supported. Only one NLQ service should be configured.

For more information, see:
Elasticsearch 8.x search engine

SmartHub supports Elasticsearch 8.x as a search index.

The same Elasticsearch instance used for the Analytics Index above can be used for the Search index, however this is not required and they can be separate instances.

You must know the following information about your Elasticsearch instance:

  • Elasticsearch URL

  • Elasticsearch Username

  • Elasticsearch Password
SharePoint On-prem Elasticsearch Index

Elasticsearch 8.1.2 is supported.

SmartHub supports secured or non-secured Elastic configurations.

The Elasticsearch index used for the SmartHub data does not have to be the same instance used for the search index (search engine).

Java: The SmartHub Analytics component requires Elasticsearch Java JDK. Elasticsearch v7.x and later bundles Java with the software (OpenJDK). A separate Java download/install is NOT required. For more information see Elasticsearch documentation.

For assistance installing a single-node instance of elastic, see Install Elasticsearch for Analytics.
Kibana

Kibana 8.1.2 is supported.

  • Kibana must be configured to use the above Elasticsearch index.

  • SmartHub supports secured or non-secured Kibana configurations

  • You must use the same version of Kibana that is used for your Elasticsearch index (Example: v7.10 for each application)

  • For assistance installing Kibana and running as a windows service, see Install Elasticsearch for Analytics.
Haystack (Optional)

Haystack Service is required for the Questions and Answers feature.

Upland BA Insight recommends Haystack be deployed to a separate server/resource so SmartHub performance is not negatively impacted.
NLQ Services (Optional)

RASA v1.9, Amazon Lex, and CLU are supported. Only one NLQ service should be configured.

For more information, see:
SharePoint 2016/19/SPSE

SmartHub supports the following versions of SharePoint On-Premise:

  • 2013 SP1 with Enterprise CAL

  • 2016

  • 2019

  • SPSE

You must know the following information about your SharePoint On-Premise instance:

  • SharePoint URL

  • SharePoint Username

  • SharePoint Password
SharePoint Online Elasticsearch Index

Elasticsearch 8.1.2 is supported.

SmartHub supports secured or non-secured Elastic configurations.

The Elasticsearch index used for the SmartHub data does not have to be the same instance used for the search index (search engine).

Java: The SmartHub Analytics component requires Elasticsearch Java JDK. Elasticsearch v7.x and later bundles Java with the software (OpenJDK). A separate Java download/install is NOT required. For more information see Elasticsearch documentation.

For assistance installing a single-node instance of elastic, see Install Elasticsearch for Analytics.
Kibana

Kibana 8.1.2 is supported.

  • Kibana must be configured to use the above Elasticsearch index.

  • SmartHub supports secured or non-secured Kibana configurations

  • You must use the same version of Kibana that is used for your Elasticsearch index (Example: v7.10 for each application)

  • For assistance installing Kibana and running as a windows service, see Install Elasticsearch for Analytics.
Haystack (Optional)

Haystack Service is required for the Questions and Answers feature.

Upland BA Insight recommends Haystack be deployed to a separate server/resource so SmartHub performance is not negatively impacted.
NLQ Services (Optional)

RASA v1.9, Amazon Lex, and CLU are supported. Only one NLQ service should be configured.

For more information, see:
SharePoint Online

SmartHub supports SharePoint Online as a search index.

You must know the following information about your SharePoint Online instance:

  • SharePoint Online URL

  • SharePoint Online Username

  • SharePoint Online Password
Solr Elasticsearch Index

Elasticsearch 8.1.2 is supported.

SmartHub supports secured or non-secured Elastic configurations.

The Elasticsearch index used for the SmartHub data does not have to be the same instance used for the search index (search engine).

Java: The SmartHub Analytics component requires Elasticsearch Java JDK. Elasticsearch v7.x and later bundles Java with the software (OpenJDK). A separate Java download/install is NOT required. For more information see Elasticsearch documentation.

For assistance installing a single-node instance of elastic, see Install Elasticsearch for Analytics.
Kibana

Kibana 8.1.2 is supported.

  • Kibana must be configured to use the above Elasticsearch index.

  • SmartHub supports secured or non-secured Kibana configurations

  • You must use the same version of Kibana that is used for your Elasticsearch index (Example: v7.10 for each application)

  • For assistance installing Kibana and running as a windows service, see Install Elasticsearch for Analytics.
Haystack (Optional)

Haystack Service is required for the Questions and Answers feature.

Upland BA Insight recommends Haystack be deployed to a separate server/resource so SmartHub performance is not negatively impacted.
NLQ Services (Optional)

RASA v1.9, Amazon Lex, and CLU are supported. Only one NLQ service should be configured.

For more information, see:
Solr

SmartHub supports SOlr 7.5 as a search index.

Solr required the following:

  • Java Runtime Environment (JRE) v1.8 or later.

  • A Solr v7.5.0 instance running with at least a collection within it (a collection created through Connectivity Hub is recommended).

You must know the following information about your SharePoint Online instance:

  • Solr URL

  • Solr Username

  • Solr Password
Other search engines Bing News You must have a Bing API Access Key. This is the subscription key that you received when you signed up for this service.
Bing Search
Egnyte

  • You must create your own app registration against Egnyte. For more information, see create your Egnyte app registration.

  • You must have an Egnyte domain that you want to search. For example, myegnyteapp.egnyte.com.

  • You must have an Egnyte impersonation property. This is the name of a property that will be added in the client context properties that will hold the user name of the user to be impersonated (this will be done with a script, in a Query Scripting Processor stage, later).

  • You must have an access token. This is generated during the configuration of the Egnyte search engine. For more information, see the instructions in the Egnyte setup topic.
Expertise To configure yout expertise locatotr, you need to download the Expertise location application. zip file. This can be downloaded from the Upland Right Answers portal.
iManage Server You must have a network service account. A service account can only be used with a single SmartHub instance at any one time.
Microsoft Academic Knowledge You must have an academic API subscription key. This key is found on your "Microsoft Research APIs" account page. See the Microsoft Academic Knowledge search engine topic for details.
Microsoft Search Items

You must have Microsoft Graph API permissions. See the specific documentation topic of your Microsoft search engine for details:
Microsoft Search Calendar
Microsoft Search Emails
Microsoft Search Chat Message
Microsoft Search Persons
NetDocuments

You must have user access to the NetDocuments cabinets being searched. SmartHub requires the Admin user to have the following permissions:

  • Permission to retrieve cabinets.

  • Permission to READ other user's details.

The cabinets you access must be in the same repository. To search cabinets from multiple repositories, you must configure a separate SmartHub NetDocuments search engine for each repository.
PubMed You must have a PubMed search engine API Key. When you register a new PubMed account, you are given the option to create a key.
RightFind

  • You must have a RightFind domain that you want to search. for example, www.myrightfinddomain.rightfind.com.

  • You must have an email address and password of the user account that as access to all items.

  • You must have an access token for your RightFind instance. The access token obtained after authenticating. For detailed instructions, see the RightFind topic.

  • You must have a refresh token for your RightFind instance. The refresh token obtained after authenticating, used to refresh the access token when it expires. For detailed instructions, see the RightFind topic.