Beta License Agreement

This product is still in beta and may undergo further changes.

The following are instructions for using various equipment with Sisense’s BI Everywhere software functionality (the equipment and the BI Everywhere software is collectively referred to herein as the “Product”). This notice is to remind users that the Product is a beta release offering and is not warranted to be at the level of performance of a commercially available product offering. In addition, the Product may be substantially modified prior to first commercial release, or at Sisense’s option may not be released commercially in the future. As such, by using the equipment along with the Sisense Software, each user agrees (i) to follow all instructions provided by Sisense with respect to the installation and use of the equipment with the Sisense Software, including the below, and (ii) that such use continues to be for testing and evaluation purposes only.

The Product and Documentation are provided “AS IS” without warranty of any kind, and Sisense and its licensors and suppliers disclaim all warranties, express, implied or statutory, including without limitation any implied warranties of title, non-infringement of third party rights, merchantability, or fitness for a particular purpose. The entire risk arising out of the use or performance of the Product remains with the user.

For the sake of clarity, the provisions in the license agreement between the licensee of the Sisense Software and Sisense (the “License Agreement”), providing any representations, warranties or indemnities shall not apply to the Product. For purposes of the limitation of liability provisions of the License Agreement, no amount has been paid or is payable to Sisense in connection with the Product. However, the license provisions continue to apply to the Sisense Software and the confidentiality provisions of the License Agreement shall continue to apply to those portions of the information shared with you by Sisense that are Confidential Information as defined in the License Agreement or any confidentiality agreement in effect between the licensee and Sisense.

Introduction

Traditional dashboards provide comprehensive access to vast amounts of data, however, sometimes you need quick, actionable insights. The Sisense-Enabled Bulb provides an immediate visual representation of a KPI. Sisense recommends choosing a KPI that is meaningful to your business and with conditions that you expect might change frequently. KPIs that are relatively static are less meaningful to monitor with the Sisense-Enabled Bulb.

The Sisense-Enabled Bulb reflects a metric you define in the Sisense Web Application. For example, let’s say a certain KPI has failed to meet a predefined condition, you can set the Sisense-Enabled Bulb to reflect this by dynamically changing the bulb’s color to red. As the ElastiCube refreshes its data, your Sisense-Enabled Bulb reflects your KPI’s current situation according to conditions you define.

To see how Sisense’s Marketing department has implemented the Sisense-Enabled Bulb, click here.

If you have not purchased a bulb, for US customers you can purchase one from the LIFX US site and for European customers, you can visit the LIFX Europe site.

This page provides the following information:

How does it Work?

The Sisense-Enabled Bulb is connected to your Wi-Fi connection and dynamically updates the color of its light according to conditions you define in an indicator widget in your dashboard. As the ElastiCube refreshes its data, the dashboard is refreshed, which then updates the bulb.

ebulbflow

To set up your Sisense-Enabled Bulb, you need one ElastiCube, one dashboard with an indicator widget, and a Wi-Fi connection to support your bulb.

Preparing Your Numeric KPI

Before setting up your Sisense-Enabled Bulb, let’s ensure that you have set up your metric properly.

  1. First, define a build schedule for the ElastiCube behind your dashboard. By scheduling your builds, you can automatically refresh your data so your Sisense-Enabled Bulb reflects the most up-to-date data. Click here for more information on scheduling builds.
  2. Build the ElastiCube.
  3. In the Sisense Web Application, display your data as an indicator widget, such as one of the following:
    indicatorwidgets
    The main indicator value determines the color of your Sisense-Enabled Bulb. For more information about indicator widgets, click here.
  4. Set your widget’s colors. Your widget’s conditions should be represented by meaningful colors. For example, Green can represent a positive condition and Red a negative condition. These colors will be the colors of the Sisense-Enabled Bulb. To set up conditions, you need to edit the widget and define each condition. For instructions on how to set up conditions and choose their colors, click here.
    conditionssteps
  5. Share the dashboard with the user who will own the lamp.

Connecting the Sisense-Enabled Bulb to Your Wi-Fi

After you have created your dashboard, the next step is to connect your Sisense-Enabled Bulb to your Wi-Fi connection. To connect to the Sisense-Enabled Bulb, you must download the LIFX app. The LIFX provides an interface in Apple or Android-based mobile devices for defining your bulb’s color and connections settings.

To connect to the Sisense-Enabled Bulb:

  1. Before plugging the lamp into the power outlet, screw the bulb into the lamp.
  2. Plug the lamp into the power outlet and turn it on.
    Note: You can reset the lamp by turning the lamp on and off 5 times. When you reset the lamp you must complete this procedure again.
  3. Download and install LIFX. For Apple-based mobile devices, click here and for Android, click here.
  4. Open the LIFX app lifxapp.
  5. In LIFX, tap Register and create an account.
    lisignin
  6. Enter an email address and password to be used for your LIFX account and tap Sign In.
  7. In the top-right corner, tap + and then Connect light. LIFX locates the bulb.
  8. Tap the name of the bulb located by LIFX.
    liconnect1
  9. Connect the bulb to your Wi-Fi.
    liconnect2
    LIFX will connect to your Sisense-Enabled Bulb, and display a list of all your Sisense-Enabled Bulbs. The current color of your bulb is displayed.
    Liconnected

Retrieving a Sisense-Enabled Bulb Token

To allow Sisense to communicate with your LIFX bulb and display your KPI’s color as defined by your conditions in the Sisense Web Application, you must provide Sisense with access to your LIFX bulb. After you provide access to Sisense, LIFX returns a token that you provide to Sisense that enables your bulb to authenticate requests from Sisense when updating your bulb’s color.

To retrieve a token:

  1. In your web browser, open the Sisense LIFX authorization site located here.
    lifxsign
  2. Enter your LIFX account email address and password in the relevant fields.
  3. Click Sign in. The Authorization page is displayed.
    authapp
  4. In the Authorization page, click Authorize. Your Sisense BulbiToken is displayed.

Connecting Your Bulb to Sisense

There are two methods for connecting your bulb to Sisense, the first method is to use Zapier webhooks and the second method uses a plugins defined by Sisense.

Configuring Zapier and Sisense-Enabled Bulbs

Your Sisense-Enabled Bulb can be configured to work with Zapier to change the colors of your bulb when an alert is triggered. Following a build, Sisense sends a webhook to Zapier who adds several fields you define and fires its own webhook to LIFX. This webhook defines how your bulb responds to an alert, such as what color to display and how many times the bulb pulsates when a new alert is triggered.

Note: To leverage your Sisense-Enabled Bulb through Pulse, you should have Sisense V6.5 or later and a Zapier account. If you do not have a Zapier account, you can make one for free here.

To configure Zapier to work with the Sisense-Enabled Bulb:

  1. Log in to your Zapier account.
  2. Open this Zap template prepared by Sisense.
  3. Click Create this Zap.
  4. Click Continue. The Webhook Setup options are displayed.
  5. Click Continue. The Test Webhooks page is displayed.
  6. In the Test Webhooks page a webhook generated by Zapier is displayed, click Copy to clipboard to copy this URL.
  7. Test the webhook by pasting the it into your browser and add ?data= to the end of the URL to verify that the webhook works. For example:
    https://hooks.zapier.com/hooks/catch/1779449/5f9jj7/?data=
    If the webhook is working as expected, you should see “status”: “success” and some additional IDs in your browser. Keep the URL saved in your clipboard as you need to paste it again later.
  8. In the Test Webhooks page, click I did this to confirm that you have tested the webhook. A message is displayed confirming that the test was successful.
  9. Open the Sisense Web Application.
  10. Create a new Pulse data alert or edit an existing alert. For more information, see Creating Data Alerts.
  11. In the Notifications Options of your alert, select Zapier and paste the webhook URL copied from Step 6 into the URL field (without the ?data= parameter included in the URL).
  12. In the bottom left corner of the window, click Additional Options and select Notify only once after a condition is met to limit how many times your bulb refreshes itself after an alert is triggered.
  13. Return to Zapier and click Continue.
  14. Create a new webhook by clicking Continue. The Set Up Webhooks page is displayed.
  15. In the URL field, enter your LIFX URL. The URL has the following structure: https://api.lifx.com/v1/lights/BULB_ID/effects/pulse.Replace BULB_ID with the token from your LIFX bulb. The token should be written in lowercase letters.
  16. Select Show advanced options. Additional fields are displayed.
  17. From the Payload Type list, select JSON.
  18. In the Data section you need to add several key-value pairs that determine the behavior of your bulb when an alert is triggered. The values of these keys are passed as parameters through your webhook to the bulb. Click + to add five fields. Entering the following details into the fields:
    Key 1: Enter color in the Key field and in the Value field, enter the color you want the bulb to be when an alert is triggered.
    Key 2: Enter power_on in the Key field, and in the Value field, enter true. When true, Sisense turns the bulb on even if it is not already on.
    Key 3: Enter cycles in the Key field and in the Value field enter the number of cycles. Cycles are the number of times a light pulsates when an alert is triggered.
    Key 4: Enter period in the Key field and in the Value field enter the number of seconds for each period. Periods are the time in seconds for a single cycle to complete.
    Key 5: Enter persist in the Key field and in the Value field, enter true. When true, the last color displayed in the bulb is the color displayed until your next alert.
    For example:
  19. In the Unflatten field, enter yes to convert fields with underscores into nested dictionaries.
  20. In the Headers section, enter the following key-value pair:
    • In the Key field, enter Authorization.
    • In the Value field, enter Bearer and your LIFX token with a space in between, for example, Bearer 23Sk5fj23934fLMNs. Click here to retrieve your LIFX token.
  21. Click Continue. The Test Webhook page is displayed.
  22. Click Create & Continue. The next time the alert is triggered, Sisense fires a webhook that activates your Sisense-Enabled Bulb.

Note: Repeat this procedure for every color you want your bulb to support. For example, if you use colors green and red to represent alerts, repeat this procedure twice, once for each color.

Configuring Your Bulb with Sisense Plugins

After you have connected the bulb to your office’s Wi-Fi connection, you must connect it to your dashboard. To connect your bulb to a Sisense widget, you must download several Sisense plugins that interface with the LIFX API to automatically update the color of the bulb following each ElastiCube build.

Note: To participate in the Smart Bulb Beta Program, your Sisense server must have access to the Internet.

To set up your Sisense-Enabled Bulb:

  1. Download and extract these files to your hard drive.
  2. Open the Command Prompt and navigate to the directory where you extracted the files in the previous step.
  3. Run the command:
    node server

    If you get the following error message:

    'node' is not recognized as an internal or external command, operable program or batch file.

    Specify the full path to the node application: [SISENSE INSTALLATION DIR]\Sisense\PrismWeb\vnext\iisnodeModule\node. For example:

    "C:\Program Files\Sisense\PrismWeb\vnext\iisnodeModule\node" server
  4. When prompted, enter the following details you received in your Introduction email from Sisense:
    BULBISERVER: Sisense server location. Make sure to include http:// or https://, for example, http://localhost:8081.
    BULBIUSER: Sisense user email when logging into the Sisense Web Application.  (not the username used for LIFX)
    BULBIPASSWORD: Sisense user password when logging into the Sisense Web Application. (not the password used for LIFX)
    BULBITOKEN: The bulb token you received when authorizing Sisense. You can follow these steps to retrieve the token.
    BULBISERIALNUMBER: The bulb serial number. This ID is located at the base of your LIFX bulb. This value must be entered in lowercase letters.
    For example:
    bulbsn
    BULBIDASHBOARD: The ID of the dashboard without the full URL. This is located in the URL of your dashboard:
    http://mysite.com/app/main#/dashboards/536f3a54d093e26c28000114/
    BULBIWIDGET: The ID of the widget without the full URL. You can get the ID from the address bar of the widget while editing the widget.
    http://mysite.com/app/main#/dashboards/536f3a54d093e26c28000114/widgets/536f3a54d093e26c2800011b
  5. Download and extract this plugin to the following directory:
    C:\Program Files\Sisense\Prism\Server\Plugins
  6. In the Plugins folder, right-click on the file BULBI_ALERTING.dll, select Properties > Unblock to allow Sisense to run the plugin.
  7. In the Elasticube Manager, open the ElastiCube associated with your dashboard.
  8. In the menu bar, select ElastiCube > Pre & Post Execution Plugins.
  9. In the Post Execution Plugins area, click Add.
  10. Enter BULBI_ALERTING as the plugin name field.
    bulbpost
  11. Open the plugin by clicking the paper icon (edit) next under the Add link. The XML Editor is displayed.
  12. In the XML Editor, paste the following code:
    <Attributes filePath="[Filepath where you extracted the files in Step 1]\server.js"></Attributes>
    bulbxml
  13. Click OK to save your changes.
  14. Click Close.
  15. To test your bulb, in the Command Prompt, navigate to the directory where you extracted the file server.js in Step 1 and run the command:
    node server.js
    If you get the following error message:

    'node' is not recognized as an internal or external command, operable program or batch file.

    Specify the full path to the node application: [SISENSE INSTALLATION DIR]\Sisense\PrismWeb\vnext\iisnodeModule\node. For example:

    "C:\Program Files\Sisense\PrismWeb\vnext\iisnodeModule\node" server.js

    The Sisense-Enabled Bulb changes colors according to the colors and conditions you defined in the dashboard’s widget. After the ElastiCube is built, the plugin automatically runs and the widget and bulb color are adjusted to reflect the current widget data. If the Sisense-Enabled Bulb does not change colors, through the LIFX app, check if your bulb is still connected. If not, you may need to disconnect and reconnect the bulb to your WIFI.

Troubleshooting the Sisense-Enabled Bulb

  • Bulbs are designed to communicate on channels 1 through 11 on the 2.4GHz (802.11 b,g,n) spectrum. If your router is in auto-channel mode, disable it and ensure you are somewhere between channels 1 through 11. We suggest channels 1, 6, or 11, as these are the only channels that are non-overlapping.
  • You can reset the bulb by turning it on and off 5 times in a row. When you reset the lamp you must reconnect the lamp as described here.