SmartHub with Elasticsearch Prerequisites

Elasticsearch and SmartHub Versions

Multiple Product Installations:

  1. SmartHub v5.6+ supports Elasticsearch v7-8.x as a search backend.

  2. SmartHub Analytics is a separate component with separate requirements.

  3. SmartHub v5.6+ Analytics specifically requires Elasticsearch v7.10.

  4. For Connectivity Hub users of Elasticsearch, Connectivity Hub v2.2+ supports Elasticsearch v7-8.x, including v8.1.2. (Connectivity Hub also supports other search engines).

  5. If you upgrade your Elasticsearch instance(s) from v7 to v8, you must upgrade your BA Insight products accordingly.

Installation Prerequisite Checklist

Requirement

Description

Completed 
SmartHub Server


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

¨ (Complete)
Windows Roles and Features The following Web Server (IIS) roles must be enabled with the following options 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

¨ (Complete)
.NET Framework
  • .NET Framework v4.7.2 required for Windows Server versions: 2012, 2016, 2019
  • .NET Framework v4.8 required for Windows Server 2022 (included with Windows and used automatically, by default)

¨ (Complete)

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)

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, such as:

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

These browsers are not officially supported by BA Insight.
Analytics Index 


Elasticsearch v7.10

Secured or non-secured Elastic configurations supported.

Note: The Elasticsearch index used for the SmartHub data does not have to be the same instance use for the search index (backend).

For assistance installing a single-node instance of elastic, see the topic "How to Install Elasticsearch for Analytics" in How to Install Analytics Applications

Elasticsearch URL:

Elasticsearch Username:

Elasticsearch Password:
Kibana v7.10

Kibana must be configured to use the above Elasticsearch index. 

Supports secured or non-secured Kibana configurations

For assistance installing Kibana and running as a Windows service, see the topic "How to Install Kibana for Analytics" in How to Install Analytics Applications

Kibana URL:

Kibana Username:

Kibana Password:
NLQ Services (Optional)

  • LUIS (v2 API)

  • RASA v1.9

  • Amazon Lex

Only one NLQ service should be configured.

Supported NLQ/AI Engines:

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

For more information see:

Service Endpoint:


Service Key (LUIS only):
Search Engine 

Elasticsearch v7-8.x

SmartHub v5.6+ supports Elasticsearch v7-8.x as a search index.

Note: The same Elasticsearch instance used for the Analytics Index above can be used for the Search index.

This is not required: they can also be separate instances, as suits your needs. 

Elasticsearch  URL:

Elasticsearch Username:

Elasticsearch Password:
Network Requirements




DNS entry for SmartHub site

This 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:
SSL Certificate If running SmartHub over SSL (recommended), a signed SSL certificate for that DNS name (or appropriate wildcard cert) is required.

Certificate name:

Passphrase (if required):

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)
External Network Connectivity Network connectivity from the SmartHub server to the following Microsoft Azure services is required if you use the service(s):

Verified:

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