SmartHub Analytics Prerequisites

Before installing SmartHub, the following third-party applications, listed below, for SmartHub Analytics must be installed.

Third-Party Applications

• Elasticsearch v7.x (download)
• Kibana v7.x (download)
  • Configuring Security in Kibana (instructions)

Elastic Product Prerequisites

Make sure that you follow the required prerequisites for the Elastic products.

• You must install and start (run) the following applications before you install SmartHub Analytics components.
• The server which will house Elasticsearch and Elastic Kibana A source-available data visualization dashboard for Elasticsearch must be accessible from the server containing the SmartHub Analytics Sync Tool and the SmartHub Analytics Reporting site.

Install the following:

Java Applications

Install either JRE or OpenJDK with Hotspot, if they are not already installed and configured.

Java Runtime 64-bit (JRE)

To run the install operation:

1. Download the latest Java JRE (found on the Java or Oracle site).
2. Add a new system variable: JAVA_HOME.
3. Specify the path to the Java install directory (root of /lib /bin):

OpenJDK with Hotspot

Open-source JDK: AdoptOpenJDK with Hotspot (v8)

• During installation, select the Custom Setup options shown below:
  
  
  
• Specify the path of the JAVA_HOME variable:

Install Elasticsearch v7.x

This is the search engine The search engine your SmartHub instance uses to perform queries. SmartHub can be configured to use more than one search engine. where all the recorded user activity is stored.

• Documentation: To see the Elastic documentation, go to Elasticsearch Documentation.

To run the install operation:

1. Go to Elasticsearch Downloads page and download the .msi package of Elasticsearch.
   
2. Follow the steps from the install Elasticsearch page to install Elasticsearch as a Windows service.
   
3. Set the following properties in the YML file \config\elasticsearch.yml:
   1. network.host: 0.0.0.0
      Set the value to one of the following:
      • An IP address attached to an individual network device such as NIC.
      • This IP address must resolve to your elastic server (or a DNS The system that converts website domain names (hostnames) into numerical values (IP address) so they can be found and loaded into your web browser. which does).
      • Once set, you can only access Elastic through this network interface device. 
      • 127.0.0.1 to make elastic accessible from this server only by using "localhost"
      • 0.0.0.0 to make elastic accessible from any address/IP.
   2. http.port: 9200: Leave this set at the default value of 9200
   3. discovery.type: single-node: Set this property if you are using a single server for your elastic instance.  
      
      
      
4. Go to Windows services and start the Elastic service, which is running as a Local System service.
   

5. Verify the Elastic node status by going to http://localhost:9200.
   

   Note: You must have an instance of Elasticsearch up and running.
   Make sure that JSON is loaded. For example, see the following capture:

   

   Note: Keep the Elastic window open while you install Kibana.

Kibana v7.x

• Kibana v7.x (This is the data visualization engine for Elasticsearch. SmartHub Analytics uses reports that are built on top of Elastic Kibana.)

• Use the Elastic prerequisites to install Elastic Kibana on the same server or a different server from where you install Microsoft Application Request Routing v3.0 and the SmartHub Analytics Reporting Site.

  • For more information, go to the Kibana page.

To install Kibana as a Windows service, follow these steps:

1. Go to Kibana Download page, download and unzip the file.
   

2. Go to NSSM Download page, download and unzip the file.

3. Use the command prompt with administrator permissions to navigate to the folder which contains nssm.exe using either of the following commands:
   

   1. cd path_to_nssm/nssm-2.24/win64

   2. cd path_to_nssm/nssm-2.24/win32
      

4. Run the command (version 7.0 used, for example purposes):
    nssm install kibana-7.0.0

   In the "NSSM service installer" window:

   1. Application tab: Set kibana.bat as Application Path (screenshot shown for example purposes only)
      

      
      

   2. Details tab: Enter display name, description, startup type
      
       
   3. Dependencies tab: Enter Elasticsearch service name
      
      
      
   4. Click the "Install Service" button.

Update the port, host information, and the Elastic node URL in <path_to_kibana>\config\kibana.yml.

1. server.port: 5601
2. server.host: "0.0.0.0"
3. server.host:"0.0.0.0"



Go to Windows services and start the Kibana service.

• Verify Kibana by going to http://localhost:5601/

• If you already have Elasticsearch and Elastic Kibana running, or if you have installed either of these applications, you can continue to use these Elasticsearch applications.
  This is because SmartHub Analytics creates a new Elasticsearch index.
• Kibana - Additional Steps:
  In this version of Kibana, use the following additional steps:
  
  1. Go to your Kibana console and open the Dev Tools tab: http://localhost:5601/app/kibana#/dev_tools/console?_g=()
     
  2. Enter this command and run it:

     PUT test/_doc/1
{}

     1. Go to Management → Stack Management → Index Patterns. 
        

     2. Create an index pattern based on index:

        1. Write "test" in "index pattern" text box.

        2. Click the Next step button.

        3. Click "Create index pattern"
           
           

After the installation of SmartHub Analytics, you can delete the index-pattern and index.

1. Go to Kibana address → Management → Index Pattern → delete the "test" index pattern.
   
   
   

2. Go to Kibana address → Dev Tools.

   1. Write in console "DELETE test" to delete index.

How to Secure Kibana

BA Insight requires Kibana is accessible to end users.

We further recommend securing your Kibana instance.

• For information on how to do this, see Configuring Security in Kibana.