This document provides a step-by-step guide to installing upgrading and troubleshooting QBeeQ plugins. QBeeQ plugins are designed for seamless integration, making installation quick and straightforward.

Installing the QBeeQFramework

ℹ️

See the Before you start section in the Getting Started documentation.

⚠️

Follow the instructions below to install the QBeeQFramework first. This plugin must be installed and compiled prior to installing any additional plugins. Download links for additional plugins are only available on the QBeeQ Framework dashboard

In order to ensure our plugins are all installed and configured properly, QBeeQFramework needs to be the first plugin installed.

To install the QBeeQFramework plugin:

Download the zip file here

Unzip the file

⚠️

After unzipping, make sure you select the correct root folder. The folder structure should be:

plugins/<PluginName>/files and NOT plugins/<PluginName>/<PluginName>/files.

Double-check that there is only one folder inside plugins before proceeding.

Copy the entire folder:

If using Linux, navigate to the Admin > Server & Hardware > System Management > File Management

If using Windows, use File Explorer to place the extracted folder in /opt/sisense/storage/plugins/

ℹ️

Sisense will automatically rebuild the list within a few seconds. Do not refresh or exit the page until you see a confirmation popup.

Once you have confirmed that the plugin is installed, enabled and completed the compilation process, you can then proceed with the installing additional plugins.

Installing additional plugins

To install plugins, the user must be in an Admin role.

Navigate to the QBeeQ Framework Tab

ℹ️

The QBeeQ Framework tab will be visible after clicking on the Analytics Tab

Click the download link for the plugin you are trying to install

Follow the steps listed above.

Updating plugins

QBeeQ will inform customers when a new version of plugins are available. Customers are responsible for upgrading their plugins to the latest version. To update a plugin:

Navigate to the QBeeQ Framework Tab

ℹ️

The QBeeQ Framework tab will be visible after clicking on the Analytics Tab

Click the download link for the plugin you are trying to install

Follow the steps listed above.

Troubleshooting

Plugin not displaying

Following installation, if plugins are not displaying in the displaying as expected, follow the troubleshooting steps below.

Follow the Previous Steps

Ensure that you have installed the QBeeQFramework plugin using the installation steps above

Ensure that you have installed any additional plugins using the installation steps above

Verify the QBeeQFramework has been installed successfully

Return to the Add-ons and verify the QBeeQ Framework is set to enabled

Navigate to the QBeeQ Framework tab

Verify the dashboard and plugins is visible

Click on one of the icons in the dashboard (ex. Info icon)

Navigate to another tab or close the QBeeQ Framework tab

Clear Browser Cache

Open Developer Tools (Press F12 in Google Chrome)

Right-click the browser’s page reload icon and select "Empty Cache and Hard Reload"

Check if the Plugin Appears on the Add-ons Page

If the plugin is listed, proceed to the next step

If the plugin is missing, verify that:

The uploaded folder matches the one inside the zipped file and is not nested

The folder name does not contain a date reference (e.g., avoid qbeeqExpandablePivot_exp_09-09-2022)

If necessary, delete the previously uploaded folder and re-upload the correct one—renaming alone won’t work

Check the .bin folder

If you see files with a timestamp longer than a few seconds/minutes ago, the build may have failed.

Disable and Re-enable the Plugin

Go to the Add-ons page, disable the plugin, then enable it again.

Wait for the build process to complete before exiting or refreshing the page

Contact Support If the Issue Persists

Email support@qbeeq.io for assistance

Include your Sisense version in the email to help our support team troubleshoot effectively

Plugin showing expired

Sometimes, license information needs to be refreshed or the plugin will show as “Expired”. If you see an expiration message for the plugin, follow these steps to refresh your licensing information.

Check Licensing Status

Click the Check Licensing button

After the page refreshes, go to the QBeeQ Framework tab again

If the list is still empty, there may be an issue retrieving licensing details

Manually Refresh Licensing Data

Go to Admin > REST API > 1.0

Find the GET /custom_data/query endpoint

Click the Try it out button

In the query parameter field, enter {"isQBeeQFramework": true}

Click Execute and check the response

Clear and Refresh Licensing Data

Go to DELETE /custom_data/query

In the query field, enter {"isQBeeQFramework": true}

Click Execute to delete outdated licensing records

Reload the Add-ons Page

Open the Add-ons page

Upon loading, the system will retrieve updated license details and restart the QBeeQ licensing service

Test the Plugin

Navigate to the QBeeQ Framework tab

Verify the dashboard and plugins is visible

Click on one of the icons in the dashboard (ex. Info icon)

Navigate to another tab or close the QBeeQ Framework tab