Introduction

The Sisense Analytics add-on is no longer being offered, and will be replaced by a native feature in 2018.
Sisense Analytics provides you with comprehensive data regarding how Sisense is used in your company and who is using it.

With Sisense Analytics, you can:

  • Identify which users are leveraging Sisense and how often for better license management
  • Improve performance by removing unused ElastiCubes
  • Verify which fields are used across various dashboards
  • Analyze which KPIs are being used to optimize your dashboards
  • Manage users and groups by tracking which users belong to specific groups

For example, you can improve performance by determining which dashboards and widgets are creating performance bottlenecks based on query frequency and response time and remove those unneeded dashboards or widgets.

Overview

Sisense Analytics leverages data from MongoDB saved on your Sisense server.

There are two parts to Sisense Analytics, an ElastiCube and +dashboards created by Sisense that expose how Sisense is used in your company.

The ElastiCube is built on a star schema with a central fact table called Trace_Widget_Dash_Users, which contains the logs of every action taken in the Sisense Web Application. This data includes information such as:

  • User data
  • Action types (view, create, edit, delete)
  • Specific API calls made
  • Response time
  • Timestamps of actions
  • Dashboard usage (if applicable)
  • Widget usage (if applicable)
  • Hierarchies, Filters and Groups

The following dimensions are available to help analyze the Trace_Widget_Dash_Users table:

  • Users: Contains display names, along with information about when the user has logged in
  • Roles: (only available after 5.7)
  • Dashboards: Includes creation date, title, owner, etc.
  • Dashboard Owner: The owner of a specific table.
  • Widgets: Includes creation date, title, last used date.

For a description of each table, see Sisense Analytics Tables.

By importing the ElastiCube and dashboards created by Sisense and reconfiguring them to your Sisense server, you can analyze how Sisense is used in your company.

Sisense Analytics includes a set of six predefined dashboards. You can modify these dashboards to meet your requirements or implement them as is and rebuild the ElastiCube with your data. The predefined dashboards are:

  1. Overview
  2. Dashboards
  3. Users
  4. Actions
  5. Widgets
  6. Performance

These dashboards provide you with insights regarding who is using Sisense, what are the dashboards and widgets that are mostly active/inactive, trends of usage, performance and much more. See Sisense Analytics Dashboards for examples of predefined dashboards.

For users with Sisense version 6.5 and above, you can skip to Step 4.

Setting Up Sisense Analytics

To leverage Sisense Analytics, you must meet the following requirements:

  • .Net version 4.5.2 or above.

Before the ElastiCube can be built on top of your data, you must save your current data in the Sisense MongoDB, install the latest version of Sisense, and then import that data back into the Sisense MongoDB just installed.

Once you have imported your data and set up Sisense, you can install the Sisense Analytics connector and download the Sisense Analytics ElastiCube, which is the key component of Sisense Analytics. This ElastiCube maps Sisense usage data and enables you to quickly and easily display that data in custom or predefined dashboards.

To access your data through the Sisense Analytics connector, you must redefine the connectivity settings for the Sisense Analytics ElastiCube to connect to the Sisense Analytics connector installed on your machine. After the ElastiCube is connected to Sisense Analytics, you can build the ElastiCube with your data and use Sisense’s pre-defined dashboards or your own.

How Sisense is configured in your company determines which steps need to be performed on your web and ElastiCube servers or both servers if your server’s configuration is separated into two servers.

Perform the following steps on the relevant servers:

Steps 1: Sisense Web Application
Step 2: Sisense Web Application and ElastiCube Server
Steps 3-7: ElastiCube Server
Step 8: Sisense Web Application

Note: If you are not upgrading Sisense, you can skip to Step 3.

If your web and ElastiCube servers are on the same machine then these steps should all be performed on that machine.

Step 1. Backing Up your Sisense Analytics Data

Before getting started, it is important to backup your data as upgrading to the latest version of Sisense deletes data older than 30 days in your Sisense MongoDB. The data stored in the Sisense MongoDB is the data exposed by Sisense Analytics and is necessary for providing a complete picture of how Sisense is used in your company.

After installing the latest version of Sisense, you will add this data back to your Sisense MongoDB for Sisense Analytics.

To backup your Sisense MongoDB:

  1. Download and install MongoDB.
    When installing MongoDB, if this is your first time perform a Complete installation.
    If you are upgrading, select Change.
  2. In Windows, open the Command Prompt as an Administrator.
  3. In the Command Prompt, navigate to the MongoDB \bin directory by running the command:
    cd C:\Program Files\MongoDB 2.6 Standard\bin
  4. From the \bin directory in the Command Prompt, run the command:
    mongodump --host localhost:27018 --db monitor --out monitorDump
  5. Leave the Command Prompt open and continue to the next step.

Step 2. Downloading and Installing Sisense

Sisense Analytics is built on the Sisense Custom REST API, which requires Sisense 6.5 or later.

Note: To install Sisense, you must have administrator privileges on the machine where you are installing Sisense and your environment must meet the minimum requirements.

To download and install the latest version of Sisense:

When working side by side with V4 dashboards, download Sisense v6.5.1.

Step 3. Setting Up the Sisense MongoDb

By default, the MongoDB is set to save the last 30 days of Sisense usage data, so you need to increase this to 365 days before importing your data.
Once the MongoDB is reconfigured, you can import your data through the Command Prompt open during Step 1.

To change the default settings:

Note: Steps 6 and 7 are not required if you are upgrading Sisense.

  1. Download the latest version (Version 2) of the Sisense MongoDB ODBC. The data extracted from your earlier version of Sisense needs to be imported back into this version. For more information about the Sisense MongoDB ODBC, click here.
  2. Navigate to C:\Program Files\Sisense\PrismWeb\vnext\config on the server where Sisense was installed.
  3. In a text editor, open the file default.yaml as an Administrator.
  4. Change the values of the following parameters as shown below:
    maxSize: 1000000000
    maxDaysTime: 365
  5. Save the file.
  6. In the Command Prompt that was opened during Step 1, run the command:
    mongorestore --host localhost:27018 monitorDump
  7. After the process is complete, close the Command Prompt.

Step 4. Installing Sisense Analytics

Sisense Analytics acts as a standalone data source that you can add to your configuration. After installing Sisense Analytics, it will appear in your list of Web Services in the ElastiCube Manager.

Once Sisense Analytics is installed, you can import the Sisense Analytics ElastiCube as described in the following step.

To download and install Sisense Analytics:

  • Download and install Sisense Analytics.

Step 5. Configuring the Sisense Analytics Elasticube

With the latest version of Sisense installed, you can now download the Sisense Analytics ElastiCube and import into your ElastiCube Manager.

While Sisense has already created the ElastiCube for Sisense Analytics, the Sisense Analytics ElastiCube connectivity settings need to be changed to connect to your data.

As there are 14 tables included in Sisense Analytics, Sisense has developed a small program to automatically configure all of your ElastiCubes for Sisense Analytics.

By downloading and running the program through the Command Prompt, you can update all the connectivity settings for all of your Sisense Analytics ElastiCubes with your settings and credentials.

After changing the connectivity settings for each table in the Sisense Analytics ElastiCube, the program then builds the ElastiCube.

Note: The ElastiCube should not be open while performing this step.

To change the connectivity settings for each table:

  1. Download the Sisense Analytics ElastiCube.
  2. Create the directory C:\SisenseAnalytics and save the Sisense Analytics ElastiCube in the directory.
  3. Download the Sisense Analytics Connectivity Settings Update file.
  4. Save the file in the directory C:\SisenseAnalytics.
  5. To access the Sisense Analytics Connectivity Settings Update file, you should open the Command Prompt as an Administrator:
  6. Navigate to C:\SisenseAnalytics with the following command:
    cd C:\SisenseAnalytics
  7. In a text editor, copy the command below and replace the bolded values with your settings and credentials.
    ModifySisenseAnalyticsConnectivity.exe -username:[email protected] -server:localhost:8081 -password:Sisense -psmPath:"C:\Program Files\Sisense\Prism\Psm.exe" -ecubeServerAddress:localhost -buildCube:true -ecubePath:"C:\SisenseAnalytics\SisenseAnalytics.ecube"

    Mandatory Arguments:
    -username: Your Sisense Administrator user name.
    -password: Your Sisense Administrator password.
    -server : New server for Sisense Analytics.
    -psmPath: Local psm.exe directory. By default, this directory is located at …\Program Files\Sisense\Prism\
    Optional Arguments:
    -buildCube: Should build the ElastiCube after changes or not. If set to true, it is mandatory to set argument -ecubeServerAddress.
    -ecubeServerAddress: Sisense Analytics ElastiCube server. Relevant only when setting -buildCube to true.
    -ecubePath: Path for the Sisense Analytics .ecube file. Not needed if -ecubeName is defined.
    -ecubeName: Sisense Analytics ElastiCube name. In case this argument and -ecubePath are not set, the application will set ecubeName=”Sisense Analytics”.

  8. Paste the edited command with your credentials and press Enter to run the command.
    Note: This script may take several minutes to complete.

After running the program, Sisense builds the ElastiCube with your connectivity settings.

You can verify that the Sisense Analytics ElastiCube is running in the Sisense Server Console, (In the ElastiCube Manager, Servers > Manage Servers).

Step 6. Scheduling Automatic Builds

After the ElastiCube is built successfully, you can schedule Sisense to automatically run future builds. For more information, see Scheduling Data Loads.

To build the Sisense Analytics ElastiCube:

  1. From the ElastiCube Manager menu bar, select Build.
  2. In the Build Sisense Analytics dialog box, select Build Entire ElastiCube and click Build.
  3. The Sisense Analytics ElastiCube is built.

Note: If you have made any custom changes to the Sisense Analytics ElastiCube, consult with your CSM.

Step 7. Setting the Time

In Sisense Analytics the time zone for each action is logged in GMT time. To sync the time with your own time zone, you can manually change the time in the ElastiCube. For example, if you are in GMT-4, you will need to reduce 4 hours from the current hour.

To set the time:

  1. From the Sisense Analytics ElastiCube in the ElastiCube Manager, open the Trace table and edit the Timestamp field.
  2. Add or reduce the time from GMT according to your time zone using the Addhours formula. For example, if your timezone is GMT-4, you will need to reduce 4 hours from the current hour.
  3. The Syntax:Addhours(todatetime(SubString([timestamp_old],0,10) + ‘ ‘ + SubString([timestamp_old],12,8)),-4)
  4. Close the TIMESTAMP window and save your changes.
  5. Perform a schema change on the ElastiCube. For more information, see Build ElastiCubes.

Step 8. Importing Sisense Analytics Dashboards

Sisense has created pre-defined dashboards you can import to view your Sisense usage data.

Click here to view examples and descriptions of these dashboards.

You can use these dashboards and update them by building your ElastiCube, or modify them to create your own.

Note: If you had Sisense Analytics before, these are the same dashboards, therefore, you can skip this step.

To import Sisense Analytics dashboards:

  1. Download Sisense’s pre-designed dashboard files.
  2. In the Sisense Web Application, create a new Sisense Analytics folder. Previous dashboards can be deleted if you haven’t made any changes to them.
  3. Import all Sisense Analytics dash.files to the Sisense Analytics folder. For more information see, Importing Dashboards.
  4. The Sisense Analytics dashboards use the Accordion add-on for all six indicators widgets on the top of the “1.Overview” dashboard. The Accordion add-on enables your dashboard users to click an Indicator widget to expand or collapse a sub-dashboard.
  5. Open the Indicator widget’s script editor.
  6. In the script editor, paste the dashboard URL you would like to set as the sub-dashboard (The dashboard name is written in the script as a comment)
    widget.on('ready', function(se, ev){
      Accordion({
      element: element,
      widget: widget,
      dashboard: dashboard,
      //filters: ['[<table name>.<table field>'],
      default: false,
      dashboardUrl: 'http:// 192.168.6.120:8081/app/main#/dashboards/5774e50b9f2beac41c000038'
      //Dashboard: 2.Dashboards
      });
    })

    You can retrieve the Dashboard URL when sharing a dashboard. The Dashboard URL is displayed at the bottom of your Sharing window.

    Note: Make sure that the URL address you are implementing in the Accordion add-on is using the Server’s Address and not the localhost.

  7. Click Save and close the window (Go back to the Widget Editor)
  8. Refresh the Widget Editor page.
  9. Click Apply.
  10. Repeat the steps above for the rest of the sub-dashboards.

Sisense Analytics Tables

The following is a list of Sisense Analytics tables and their descriptions included when you import the Sisense Analytics ElastiCube.

  • Trace: The trace table contains all the logs from the Sisense System Usage (All clicks within the system) not including creating hierarchies and dashboard shares.
  • Trace_Widget_Dash_Users: A custom table meant to calculate all the actions including dashboard shares, – separated actions into dashboard actions, widget actions.
  • Dashboards: Dashboard DIM displaying all dashboards that exist in the Sisense System.
  • Widget: Widget DIM displaying all widgets that exist in the Sisense System.
  • Widget Data: Provides additional information on calculations and data usage for each widget.
  • Groups: Groups DIM which lists all groups that exist in Sisense System other than Admin and Everyone.
  • User Actions: Users DIM which lists all users that exist in Sisense.
  • Elasticubes: ElastiCube DIM which lists of all EC that exist in Sisense System.
  • Dashboard Filters: List all Dashboard filters by used in dashboards.
  • Dashboard Shares: List all Shared Dashboards, their owners, and the users shared with.
  • Dashboard Owners: Copy of users DIM only with Dashboard’s owners.

Terminology

Timestamp: The Timestamp represents the time of the action traced in Sisense Usage. The timestamp field is set to Zulu time. To adjust the time, see Step 7.

Response Time: The response time is the time it takes for the query to return, not the time it takes for the widget to completely refresh.

Actions: Actions refer to any actions taken by users, such as deleting a widget, creating a dashboard, or exporting a PDF.
GET – View – Export a dashboard to PDF /dash file/ image
DELETE – Delete – Delete widget
POST – Create , Login, Create new widget
PUT – Edit – Filter
PATCH – Patch – Partial update – all update operations (dashboard, widget, users, etc.)

Number of Users: The number of active users (not all users).

Note: If a widget, dashboard, or ElastiCube was deleted, it is only deleted from the Dimension table. The actions made to this widget, dashboard, or ElastiCube will appear in the Trace table according to the timestamp of the action.

Sisense Analytics Dashboards

The following images show samples of Sisense Analytics dashboards you can import into the Sisense Web Application and modify to display your data.

User Usage

Users Dashboard presents Users roles, active and non-active users and other detailed analysis.

Dashboard Usage

Dashboard Usage presents top used dashboards, dashboard response time and ElastiCubes used in dashboards.

Widget Usage

Widget Usage Dashboard presents: most used widgets, number of widgets per dashboard and used aggregations.

ElastiCubes

Displays the main EC, data tables and columns used in dashboards, used aggregations and daily activity.

Actions

Displays number of actions (edit, create, view and delete) per dashboards and per day.

 

Response Time

Displays Average response time per day and per dashboard in milliseconds.