Configure the Analytics Component

• Overview
• Initialize Kibana
• Configure the Analytics Component
  • Limitations and Other Important Mentions
• How to Access the Analytics Reports
• Analytics Settings
• How to Modify the Analytics Settings

Overview

To configure Analytics for SmartHub you perform the following:

1. Install all necessary third-party applications
2. Complete the SmartHub Analytics prerequisites
3. Configure the Analytics Component

Initialize Kibana

Use the following steps to initialize Kibana v8.x:

1. Go to your Kibana Dev Tools.
   
   1. URL (or similar): http://localhost:5601/app/dev_tools#/console?_g=()
2. Enter this command and run it:
   PUT test/_doc/1
{}
   

   

3. Open Stack Management → Index Patterns:
   

   

   1. URL: http://localhost:5601/app/management/kibana/indexPatterns
4. Create an index pattern based on index:
   1. Click "Create Index pattern."
   2. In the Index Pattern text box, enter "test". NOTE: The field is case-sensitive.
   3. Click the Next step button.
   4. Click "Create index pattern" .

Configure the Analytics Component

To configure analytics, use the following steps:

1. Navigate to the SmartHub Administration page by going to http(s)://[SmartHub-web-app-url]/_admin.
2. In the General Settings section, click Edit next to Storage Settings.
   
3. Complete all the following fields:
   
   1. Elastic Server Address: This is the URL of your Elasticsearch server, including port number. The default value is http://localhost:9200.
   2. Kibana Server Address: This is the URL of your Kibana server, including port number. The default value is http://localhost:5601.
   3. Bot Index Name: This is the name of your bot index. The default name is bot-index.
   4. Unanswered User Questions index name: This is the name of your unanswered user questions index. The default value is unanswered-user-questions-bot-index.
   5. Analytics Index Name. This is the name of your analytics index. The default value is paxindex.
   6. Auto QnA Index Name: This is the name of your auto QnA index. The default value is auto-qna-index.
   7. Elastic Authentication: Choose and configure the desired authentication mode.

   Optional

   The Kibana server address, configured during step 3-b, is used when displaying reports to end users.

   • Typically, you provide your Kibana service address here, however that address may not be accessible to end users. 
   • If the Kibana address domain or HTTP settings are different from SmartHub, you may have difficulty displaying the reports in the browser.

   As a solution, you may wish to configure Kibana behind a reverse proxy; to do so, see the FAQ "How Do I Configure the Kibana URL for Reporting Behind a Reverse Proxy?"

   Optional

   When using Kibana and Elastic cloud, you have to add the following setting to the kibana.yml file: xpack.security.sameSiteCookies: "None". For more information, see embedded content authentication.

4. Scroll down and click OK to save your changes.
   

5. From the left-side navigation list, click Analytics Settings.

6. In the newly opened page verify/configure the following:

   1. Kibana Configuration Settings:
      When you access the page, you will see a message which describes the Kibana configuration status:

      • "Kibana is not configured" → This means that the Kibana objects are not imported and the mappings of the Analytics index are not created.

        • The configuration of Kibana is performed upon clicking the "Save Configuration" button.

      • "Kibana already configured" → This means that the Kibana objects have already been imported and the Analytics Index mappings have already been created.

   2. Advanced Settings:

      1. Recommended Results Configuration JSON: You can leave this field as it is (default).

      2. Query Suggestion Settings Configuration JSON: You can leave this field as it is (default).
         

         Note: These fields can be customized at any time.

   1. Tools: You can delete items from the Analytics index using the provided tool.

Limitations and Other Important Mentions

• SmartHub Analytics can only be configured with Elasticsearch/Kibana version 8.7.1 and earlier. Elasticsearch/Kibana version 8.8.0 and later is not compatible with SmartHub Analytics.

• When using Elasticsearch / Kibana 8.6.x, after completing the configuration of the Analytics Component, you need to restart the Kibana service in order for the Analytics reports to be created and displayed.

• When using a version later than 7.10 of Elasticsearch / Kibana, a "Cannot load panels from a URL created in a version older than 7.3" warning message is displayed in the Analytics reports. The warning message disappears after 10 seconds and doesn't affect the functionality of Analytics.

How to Access the Analytics Reports

To access the Reporting Site, use the following steps:

1. Navigate to the SmartHub Administration page by going to http(s)://[web-app-url]/_admin

2. Under the ADMINISTRATION section, click on Analytics Reports.
   

3. A new page with the analytics reports will be opened.
   

Analytics Settings

{
    "Default": {
        value: "0",
        label: "Default".toLocaleString()
    },
    "RecentlyViewed": {
        value: "1",
        label: "Recently viewed".toLocaleString(),
        lastDays: "5",
        maxResults: "100"
    },
    "MostUsedByMe": {
        value: "2",
        label: "Most used by me".toLocaleString(),
        lastDays: "5",
        maxResults: "100"
    },
    "WhatOthersAreViewing": {
        value: "3",
        label: "What others are viewing".toLocaleString(),
        lastDays: "5",
        maxResults: "100"
    },
    "NewResults": {
        value: "4",
        label: "New results".toLocaleString(),
        lastDays: "5",
        maxResults: "100"
    },
    "CuratedResults": {
        value: "5",
        label: "Curated results".toLocaleString(),
        lastDays: "5",
        maxResults: "100", 
        "SmartAnalyticsIndex.[AccountName]": "AdditionalProperty.[AccountName]"
    }
}

{
    "PreferredName": "User".toLocaleString(),
    "AccountName": "AccountName".toLocaleString(),
    "Department": "Department".toLocaleString(),
    "Office": "Office".toLocaleString(),
    "SPS-JobTitle": "JobTitle".toLocaleString(),
    "Title": "Title".toLocaleString(),
    "SPS-Location": "UserLocation".toLocaleString(),
    "SPS-Birthday": "Birthday".toLocaleString(),
    "SPS-TimeZone": "TimeZone".toLocaleString(),
    "Manager": "Manager".toLocaleString(),
    "SPS-Skills": "Skills".toLocaleString(),
    "SPS-HireDate": "HireDate".toLocaleString(),
    "YearsWithCompany": "YearsWithCompany".toLocaleString()
}

How to Modify the Analytics Settings

To modify the analytics settings, you need to access the UI Builder. For more information, see How to Use the UI Builder.

1. Select the page that youwant to add/modify the analytics settings for.

2. Select the Advanced mode.

3. Select the Advanced settings edit tab.

4. Locate the analytics settings section around line 147.

5. Add/Modify your setting(s) under the SH.AnalyticsSettings.CustomSettings block.

   Note: When clicking on the See Default Settings button from the upper right corner, a new tab opens that displays all the default settings for the SmartHub modules.

   Locate the analytics settings section to see the default values that are used to control how analytics behaves on your web page.

6. Save changes.

In the example below, a custom setting is added to disable the GeolocationTracking option.