Sisense Add-ons

Applicable to Sisense on Linux and Microsoft Windows

Sisense add-ons/plug-ins enable you to extend the functionality and capabilities of your Sisense dashboard through standard web development languages such as JavaScript and HTML.

Sisense offers both free and premium add-ons. You can find free add-ons in the Sisense Community, and free and premium add-ons are located in the Sisense Marketplace.

The Sisense Marketplace contains add-ons that have been developed and are supported by Sisense.

If you have deployed Sisense on Linux, all certified add-ons in the Marketplace are now supported except for Embedded Images.

Keep in mind that every version upgrade in Linux will update all certified add-ons to the version compatible with the release. Any manual change that you make to certified add-ons will be overwritten. Sisense recommends not modifying certified add-ons. If you want to change them, duplicate the add-on, rename it (including the internal label), and modify the duplicate version of the add-on. The upgrade process creates a backup copy of all add-ons, which can be restored if needed

In addition to Sisense and Community add-ons, you can develop your own with the Sisense JavaScript API. For more information about developing Sisense add-ons, see JavaScript API & Plugins.

Installing Add-ons

To install add-ons in Sisense, you need to download the add-on and extract its content into the relevant location depending on what type of deployment you have, Windows or Linux.

To install an add-on:

  1. Download the add-on.
  2. Extract the contents of the .zip folder to the relevant directory below.
    In Windows:
    Note: If the folder does not exist, create it prior to extracting the .zip file.
    For V7.1 and earlier: C:\Program Files\Sisense\PrismWeb\plugins
    For V7.2 and later: C:\Program Files\Sisense\app\plugins
    In Linux:
    /opt/sisense/storage/plugins/
  3. Verify that the add-on is listed in Sisense under Admin > Plug-ins.

Enabling and Disabling Add-ons

In the Sisense Admin page, you can view a list of your current add-ons, their version as defined in your add-on script, and their status, enabled or disabled.

From the Add-ons page, you can enable or disable your add-ons. This is useful for testing new plug-ins or troubleshooting issues with your dashboard. When a add-on is disabled, its functionality is no longer available in the Sisense.

To enable or disable an add-on:

  1. In the Sisense, select Admin > Add-ons.
  2. Toggle the Enable/Disable switch to activate or deactivate an add-on.
    OR
    To activate/deactivate multiple add-ons, select the checkbox of the relevant add-ons. When you select any of the checkboxes, an Enable/Disable switch is displayed in the menu bar. Toggle the switch to enable or disable all the selected add-ons.

    After enabling or disabling an add-on, Sisense rebuilds your add-ons list. The next time you refresh your dashboard, the add-ons will be enabled or disabled as defined in the Add-ons page.