Prerequisites: Other Search Engines

In addition to the information in the table below.

See the topic of the search engine you are using for additional information about its Prerequisites.

About

  • The search engines listed under Connect SmartHub to Other Search Engines are domain-specific search engines.

  • These search engines have specific characteristics.

  • Supported and Unsupported functions are listed here:

Supported Functions include, but are not limited to:

  • Pagination
  • Sorting

Unsupported Functions include:

  • Query translation
  • Refiners

For this reason, Domain-specific search engines are typically used with content-by-search components. 

Note:

Be sure to install all the prerequisites 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.

Smart Previews Support

For those integrating BA Insight Smart Previews with SmartHub v6.x, SmartHub v6.x supports only Smart Previews v3.0 and above.

Installation Prerequisite Checklist

Important!

If you have already installed BA Insight SmartHub and a search engine, skip to the "Search Engine" portion of the Requirements table below


Prerequisites

 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:
    • 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: Installation
 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 use for the search index (backend).

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: How to Install Elasticsearch for Analytics

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

  • For assistance installing Kibana and running as a Windows service, see: How to Install Kibana for Analytics

Kibana URL:

Kibana Username:

Kibana Password:
Haystack Service (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

  • 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: Bing







 Bing News
  • Bing API Access Key
    • The subscription key that you received when you signed up for this service.
















See your specific search engine topic for complete information, including limitations, requirements, and configuration settings.







Search Engine: Bing Bing Search
Search Engine: Egnyte Egnyte
  • Egnyte Egnyte Prerequisites required
  • Egnyte Domain
    • The Egnyte domain you want to search.
      • For example: myegnyteapp.egnyte.com
  • Egnyte Impersonation Property
    • 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).
  • Access Token
    • Generated during the configuration of the Egnyte search engine.
    • See the Egnyte search engine topic for details.
Search Engine: Expertise Expertise

Expertise Locator application .zip file:
Search Engine: iManage iManage Server
  • Network service account

  • A service account can only be used with a single SmartHub instance at any one time.
Search Engine: Microsoft Microsoft Academic Knowledge
  • Academic API Subscription Key:
Search Engine: Microsoft Microsoft Search Items



  • Microsoft Graph API permissions
    • See the specific documentation topic of your Microsoft search engine for details.
Search Engine: Microsoft Microsoft Search Calendar
Search Engine: Microsoft Microsoft Search External Items
Search Engine: Microsoft Microsoft Search Message
Search Engine: NetDocs NetDocuments
  • 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.

  • Cabinets

    • The cabinets you access must be in the same repository.

    • To search cabinets from multiple repositories you must configure a separate SmartHub NetDocs search engine for each repository
Search Engine: PubMed PubMed
  • (Search Engine) API Key
    • When you register a new PubMed account, you are given the option to create a key.
Search Engine: RightFind RightFind
  • RightFind Domain
    • The RightFind domain you want to search.
    • For example: www.myrightfinddomain.rightfind.com
  • User Email
    • The email of the user account that has access to all items
  • Password
    • The password for the email above.
  • Access Token
    • The access token obtained after authenticating.
    • For detailed instructions, see the RightFind topic.
  • Refresh Token
    • The refresh token obtained after authenticating, used to refresh the access token when it expires.
    • For detailed instructions, see the RightFind topic.

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 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):
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):

Verified:

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