qbeeq

Report Studio

Installing Report Studio

Step-by-step instructions for installing both Report Studio plugins — the front-end plugin and the server-side (external) plugin — including enabling server-side plugins, uploading the plugin folders, verifying the installation, and troubleshooting common issues.

Report Studio is made up of two plugins, and both must be installed before you can use the product:

  • The server-side (external) plugin: This plugin runs in the background to handle scheduling, delivery, storage, and rendering. Without it, the Report Studio UI will load, but scheduling and delivery won't work. It installs slightly differently from a standard QBeeQ plugin.

Install the QBeeQ Framework

Both plugins depend on the QBeeQ Framework already being installed and compiled. If you haven't installed the Framework yet, follow the steps in Installing the QBeeQ Framework before continuing here.

Download the Report Studio plugin files

  1. Navigate to the QBeeQ Framework Tab
  1. Click the link for Report Studio
  1. Unzip/extract the file to expose the folders

Enable server side (external) plugin

Before installing the folders/files, server side plugins must be enabled on your Sisense environment.

  1. Navigate to Admin > Server & Hardware > System Management
  1. Click the System Configuration button
  1. Scroll to the bottom and click Show Advanced
  1. Toggle the Server Side Plugins to enabled

Install the plugins

Open File Manager and Add-on pages

From Admin, open two browser tabs or windows:

  • Admin > Feature Management > File Management
  • Admin > Server & Hardware > Add-ons

Upload the plugin folders

  1. Click the upload icon from the toolbar
  1. Select the external-plugins and plugins folders
  1. Confirm the upload
  1. Monitor the build on the Add-ons page
    1. The build process should start automatically, but may take a few minutes to begin. It is recommended to wait 1-2 minutes.
🛑

Do not refresh or close the File Management or Add-on page until the build has completed.

  1. Once it has completed, you will be prompted to refresh the page

Verify the installations

Server side plugin

  1. Navigate to Admin > REST API > 1.0
  1. Expand the QBeeQ API and open GET /qbeeq/status
  1. Click Try it out
  1. Click Execute
  1. Verify the response
  1. If the response is not "ok" follow the steps in the Troubleshooting section 
{
  "status": "ok",
  "db": "ok"
}

Plugin

  1. Go to the .bin folder inside the plugins directory.
  1. The files should show a recent modified date
  1. If the file dates haven’t changed, follow the steps in the Troubleshooting section

Troubleshooting

ℹ️

If any issues persist or you are encountering an issue not covered in the documentation, please open a support ticket. We recommend opening a support ticket through the QBeeQ Framework, but you can also open a ticket via email.

Add-on build is not starting

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

Plugin not displaying in Add-ons

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

ℹ️

Only the QBeeQReportStudio will display on the Add-ons page. You will not see the server side (external plugin)

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 that 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
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
Server-side plugin doesn't appear to be working after installing

If the /qbeeq/status endpoint is not returning a success message, the external plugin service may require a restart. This action will restarts the Report Studio backend.

  1. Go to Admin > Server & Hardware > System Management > Configuration
  1. Click 5 times on the Sisense logo to view additional configurations
  1. Click on External Plugin Service from the left menu
  1. Toggle reportManager.logDebugMsg off, save, then toggle it back on and save again.
ℹ️

The QBeeQ Report Studio is not affiliated with the Sisense Report Manager, but the controls for the external plugin service are in the same area

  1. Wait a few minutes, then recheck using the /qbeeq/status endpoint.
 
 
 
 
 
Did this answer your question?
😞
😐
🤩
Overview Roles and access