Installing QBeeQ Plugins

This document provides a step-by-step guide to:

ℹ️

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

⚠️

The QBeeQFramework 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.

Installing the QBeeQFramework

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

Download the zip file here.

Unzip/extract the file

⚠️

Sometimes, unzipping/extracting creates a nested file structure. Verify that you are selecting the root folder that contains the files directory.

The folder structure should look like:

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

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

Open two browser tabs:

One for the Add-ons page

Admin > Server & Hardware > Add-ons

One for the File Management page

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/

In File Management, drag and drop the extracted plugin folder into the top level of the /plugins/, not inside another plugin folder

🛑

Do not refresh or close the File Management page.

Switch back to the Addons page. Adding new files to the /plugins/ folder will trigger the compilation process to start automatically.

ℹ️

The compilation process should start automatically, but may take a few minutes to begin. It is recommended to wait 1-2 minutes.

If the compilation doesn't start automatically, manually trigger it by disabling and enabling any plugin.

🛑

Do not refresh or close the Addons page until you receive a confirmation message.

Verify the compilation:

Go to the .bin folder inside the plugins directory.

The files should show a recent modified date.

The compilation did not run successfully if the file dates haven’t changed

Follow the steps in the Troubleshooting section

👤 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 link for the plugin you are trying to install

Unzip/extract the file

⚠️

Sometimes, unzipping/extracting creates a nested file structure. Verify that you are selecting the root folder that contains the files directory.

The folder structure should look like:

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

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

Open two browser tabs:

One for the Add-ons page

Admin > Server & Hardware > Add-ons

One for the File Management page

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/

In File Management, drag and drop the extracted plugin folder into the top level of the /plugins/, not inside another plugin folder

🛑

Do not refresh or close the File Management page.

Switch back to the Addons page. Adding new files to the /plugins/ folder will trigger the compilation process to start automatically.

ℹ️

The complication process should start automatically, but may take a few minutes to begin. It is recommended to wait 1-2 minutes.

If the compilation doesn't start automatically, manually trigger it by disabling and enabling any plugin.

🛑

Do not refresh or close the Addons page until you receive a confirmation message.

Verify the compilation:

Go to the .bin folder inside the plugins directory

The files should show a recent modified date

The compilation did not run successfully if the file dates haven’t changed

Follow the steps in the Troubleshooting section

Updating QBeeQ plugin versions

QBeeQ will notify customers when a new versions of plugins are available using the notification indicator. New versions are also communicated through our QBeeQ Connect newsletter.

‼️

Customers are responsible for upgrading their plugins to the latest version.

To update a plugin by installing a new version:

Navigate to the QBeeQ Framework Tab

Click Check Licensing on the QBeeQ Framework dashboard to ensure you have access to the latest versions

Follow steps 2 through 4 in Installing QBeeQ Plugins above

In File Management, drag and drop the extracted plugin folder into the top level of the /plugins/, not inside another plugin folder

💡

You should be prompted to replace existing files. If not, you're likely copying it to the wrong location.

🛑

Do not refresh or close the File Management page

Switch back to the Addons page. Adding new files to the /plugins/ folder will trigger the compilation process to start automatically.

ℹ️

The complication process should start automatically, but may take a few minutes to begin. It is recommended to wait 1-2 minutes.

If the compilation doesn't start automatically, manually trigger it by disabling and enabling any plugin.

🛑

Do not refresh or close the Addons page until you receive a confirmation message

Verify the compilation:

Go to the .bin folder inside the plugins directory

The files should show a recent modified date

The compilation did not run successfully if the file dates haven’t changed

Follow the steps in the Troubleshooting section

Verify the plugin by going to a dashboard where the plugin has been used, and check to make sure all features are working as expected.

ℹ️

If you notice bugs or issues post-upgrade, please contact support@qbeeq.io and provide the following information:

Sisense version

Plugin name,

Plugin version,

Details about the issue

Providing screenshots and videos can help expedite a resolution.

Troubleshooting

Plugin not displaying

Following installation, if plugins are not displaying in the Add-ons 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

ℹ️

If the issue persists, please contact support@qbeeq.io and provide the following information:

Sisense version

Details about the issue

Reproduction steps

Providing screenshots and videos can help expedite a resolution.

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

ℹ️

If the issue persists, please contact support@qbeeq.io and provide the following information:

Sisense version

Details about the issue

Reproduction steps

Providing screenshots and videos can help expedite a resolution.