Prerequisites: SmartHub with Amazon Kendra

NOTE! You must install all of the prerequisite applications listed for your SmartHub and search engine instance.

Any issues experienced by BA Insight clients during installation are typically traced to a failure to meet the required prerequisites.

NOTE! If you are integrating BA Insight Smart Previews with SmartHub, SmartHub v6 only supports Smart Previews v3.0 and later.

Installation Prerequisite Checklist

Prerequisite Requirement Description Completed
SmartHub Server: OS

 Operating System Microsoft Windows Server
  • 2012 and 2012 R2: 64-bit
  • 2016
  • 2019
  • 2022

SmartHub Server: Windows Roles/Features Windows Roles and Features Must have Web Server(IIS) role enabled with the following Roles and Features selected:
  • Common HTTP Features
  • Health and Diagnostics
  • Performance
  • Security
  • Application Development
    • .NET 3.5
    • .NET 4.6
      • ISAPI Extensions
      • ISAPI Filters
      • WCF Services
        • HTTP Activation
  • .NET Framework 4.6 Features
    • WCF Services
      • HTTP Activation

SmartHub Server: .NET Framework .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)

Accounts: Service
 Service Account (domain\user)

Local or network service account used to run the SmartHub Application pool in IIS

  • Must be in the format domain\user
  • Requires read/write access to the directory SmartHub is installed in.
 Account credentials: (domain\user)
Accounts: Install
 Installation Account (domain\user)

Account used to install SmartHub

  • Must be in the format domain\user
  • Must be local admin on machine
  • Requires read/write access to the directory SmartHub is installed in.
 Account credentials: (domain\user)
Supported Web Browsers
  • Google Chrome

  • Chromium-powered Edge

  • Other browsers unsupported*

*Unsupported Web Browsers

Other web browsers may work with SmartHub, but are not officially supported by BA Insight, such as:

  • Microsoft Edge (legacy)
    • To check your version of Edge, go here.
  • Firefox
  • Safari

Browsers that are in incognito mode are not supported.


Analytics: Elasticsearch Index

 Elasticsearch v7.10-8.x

  • Secured or non-secured Elastic configurations supported.

Note: 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.

Elasticsearch URL: 

Elasticsearch Username:

Elasticsearch Password:
Analytics: Kibana Kibana (same version as Elasticsearch above)

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

  • 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: How to Install Analytics Applications

Kibana URL:

Kibana Username:

Kibana Password:
Haystack (Optional) Haystack Service is required for the Questions and Answers feature.

We recommend Haystack be deployed to a separate server/resource so SmartHub performance is not negatively impacted.

 
NLQ Services (Optional)

  • LUIS (v2 API)

  • RASA v1.9

  • Amazon Lex

  • CLU

Only one NLQ service should be configured.

Supported NLQ/AI Engines:

  • LUIS - Access to a LUIS instance if using the NLQ feature
  • RASA
  • Lex
  • CLU

For more information see:

Service Endpoint:


Service Key (LUIS only):
Search Engine
Amazon Kendra
Limitations

For details see the Limitations section from Connect SmartHub to the Amazon Kendra Backend.

Kendra index name:

Kendra access key:

Kendra secret key:

Kendra region:

Click here for more details

Network Requirements: DNS


 DNS entry for SmartHub site

  • Can be either an internal, or an external (public) DNS entry.

  • Entry can point to VIP / F5 / Load Balancer / other network device.

  • Requests should be routed to IIS on the SmartHub server over the chosen ports.

 DNS name / URL for SmartHub:
Network Requirements: SSL Cert SSL Certificate

  • If running SmartHub over SSL (recommended), a signed SSL certificate for that DNS name (or appropriate wildcard cert) is required.

Certificate name:

Pass-phrase (if required):
Network Requirements: Internal

Internal Network Connectivity

The SmartHub server must have network connectivity to the following:

  • Analytics Index
  • Search Index
  • RASA NLQ Service (optional)

Verified:

  • Elasticsearch service (see Analytics Index, above)
  • Kibana service (see Analytics Index, above)
  • Search Index
  • RASA NLQ Service (optional)
Network Requirements: External External Network Connectivity Network connectivity from the SmartHub server to the following Microsoft Azure services is required if you use the service(s):
  • Azure Active Directory (AAD): If you use AAD for authentication.
  • SharePoint Online/ Graph APIs: If you use SharePoint O365 as a user profile provider.
  • Access to LUIS endpoints: If you use the LUIS NLQ Service.
  • Search Index

Verified:

  • AzureAD (optional)
  • SPO / Graph API (optional)
  • LUIS NLQ Service (optional)