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

• Installing the QBeeQ Framework
• Installing new QBeeQ Plugins
• Troubleshooting installation

Before you start

Before you start installing the QBeeQ Framework or plugins, please review the Getting Started and QBeeQ Framework documentation.

Installing the QBeeQFramework

<aside> 🛑

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.

</aside>

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

1. Download the zip file here.
2. Unzip/extract the file

<aside> ⚠️

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.

</aside>

1. Open two browser tabs or windows:
   1. Add-ons
   2. File Management
      1. If using Linux, navigate to the Admin > Server & Hardware > System Management > File Management
      2. If using Windows, use File Explorer to place the extracted folder in /opt/sisense/storage/plugins/
2. On the File Management page, drag and drop the extracted plugin folder into the top level of the /plugins/, not inside another plugin folder

<aside> 🛑

Do not refresh or close the File Management page.

</aside>

1. Switch back to the Add-ons page. Adding new files to the /plugins/ folder will trigger the compilation process to start automatically.

<aside> ℹ️

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.

</aside>