White Labeling Sisense

Applicable to Sisense on Microsoft Windows

If you are looking to white label Sisense in a Linux environment, see White Labeling Sisense in Linux.

Sisense enables you to re-brand (white label) the Sisense with your company's brand by using either the Sisense web application or the Sisense REST API to replace existing icons and images with your own. To apply your branding to automatic emails that Sisense sends, see Rebranding Sisense Automated Emails in Linux.

White labeling is a premium feature and must be enabled in your license. Contact your Sisense representative or open a request through the Help Center.

The white labeling feature is disabled by default.

To enable it:

  1. Open Sisense System Configuration. In your browser, navigate to localhost:3030.
  2. Click the Sisense logo five times to reveal Advanced Options (A).
  3. In the menu, click Base Configuration (B).
  4. Scroll down to Branding and click it to expand the section (C).
  5. In the branding.enabled field, enter: true (D).
    The field changes to an on/off slider.
  6. In the top-right corner of the page, click Save Base (E).


In addition, Sisense offers a premium white labeled version of the Sisense Mobile app that can be customized according to your branding, for more information see Rebranding Sisense Mobile.

Re-branding Sisense from the Web Application

You can customize Sisense directly from the Sisense web application so that it displays your own branding.

From the Admin page, select White Labeling.

Adding Logos

Add both large and small logos, which appear throughout the application. The application will automatically display the most appropriate sized logo for each location.

The recommended dimensions of the logos are:

Supported formats for both large and small logos are:

To add small or large logos, from the relevant section on the White Labeling page, either:

To apply changes, at the bottom of the page, click Save and Apply.

Note: Providing a logo to be used for accessing the web application via a mobile phone or tablet is currently only available over REST API.

Adding a Favicon

You can add a favicon to Sisense so that your own logo displays on the browser tab.

Supported formats for the favicon are:

To add a favicon, on the White Labeling page, either:

To apply changes, at the bottom of the page, click Save and Apply.

Re-branding SisenseUsing the REST API

You can re-brand the Sisense and the automated emails sent by Sisense through Sisense’s REST API.

There are two steps to re-branding the Sisense. The first step is to place your branded content into the Sisense branding directory where Sisense is installed. For a list of the files you can re-brand and their specific dimensions, see White Labeling Configuration Options.

The second step is to access the Sisense REST API, where you can embed your content directly into Sisense and modify text displayed to customers.

To re-brand Sisense:

  1. Create a subfolder with your brand name in this directory (on the machine where Sisense is installed):
    In Windows: 
    ...Program Files\Sisense\app\resources\<YourBrand>”.
    In Linux:
    /branding/<YourBrand>/
    See Uploading Files through the File Manager and upload the files to the branding folder.
  2. Put your branded files in this directory. The following files are supported:
    Desktop Logo (for example: Logo-Desktop.png/.jpg) – This is the main icon that is visible at the top left of Sisense.
    Tablet Logo (for example: Logo-Tablet.png/.jpg)
    Mobile Logo (for example: Logo-Mobile.png/.jpg)
    Favicon (for example: favicon.ico)
    Note: Optimal dimensions for logo images: 92 × 26 pixels.
    Note: Logos for viewing the Sisense web application on tablet and mobile devices are only supported via the REST API.
  3. In Sisense, click Admin, and then Rest API.
  4. Click /branding and then click the POST operation /branding.
  5. To get the required JSON format for the request, click the sample model schema to place the sample text in the body parameter.
  6. Replace the sample values with your required values. For an explanation of each parameter and how it modifies the Sisense, see White Labeling Configuration Options.
  7. Click RUN. Refresh the Sisense page to view your changes.
    Note: Make sure you delete parameters you do not want to change before running the call. Leaving "string" values will overwrite the Sisense default configuration.

White Labeling Configuration Options

The following table provides a list of the features you can re-brand within the Sisense and the JSON code that must be modified to re-brand it. Click the thumbnail image of the feature to see the default branding provided by Sisense and where your branding will appear.

Name Description

Sisense Logo

The Sisense logo can be replaced with your own. You need to supply two sizes of the logo, for each device (Desktop / Tablet / Mobile). These logos affect the following screens:

 

  • Login Screen
  • Account Activation Screen
  • ‘Forgot Password’ Screen

Below is a list with the ideal logo dimensions (pixels):

 

Small

  • Desktop: 120x48
  • Tablet: 92×24
  • Phone: 92×24

 

Large

  • Desktop: 204×60
  • Tablet: 163×74
  • Phone: 198×168

 

Important Notes:

  1. Images must be in URI format (web address)
  2. No spaces are allowed in the address of the images
  3. Transparent .png format is preferred

"logo":{

"desktop":{

"small":"/resources/<YourBrand>/logoDesktopSmall.png",

"large":"/resources/<YourBrand>/logoDesktopLarge.png"

},

"phone":{

“small”:”/resources/<YourBrand>/logoPhoneSmall.png”,

“large”:”/resources/<YourBrand>/logoPhoneLarge.png”

},

“tablet”:{

“small”:”/resources/<YourBrand>/logoTabletSmall.png”,

“large”:”/resources/<YourBrand>/logoTabletLarge.png”

}

},

Page Title and Favicon
The page title that appears in the browser tab/page and the Sisense favicon.

 

Note:

  1. Image must be in URI format (web address)
  2. .ico format is preferred

You can modify these images by updating the values of the following JAQL parameters in the REST API:

"favicon" : "/resources/<YourBrand>/fav.ico"

"pageTitle": "Sisense",

Homepage

The home screen when your users log into Sisense. Re-branding the homepage does not affect the view of the Administrator. Administrators see the default homepage, while all other users see the re-branded page.

Note: The prefix http:// or https:// must be included.

“homePage” : “http://www.mysite.com”,

Homepage Config

The Welcome banner of the homepage displayed when users log into Sisense.

You define the following properties in the homePageConfig object: 

hideSearchInNavver: Indicate if you want to display the Search bar below or hide it. By default, the Search bar is displayed.

marketingPart: The URL of the Marketing Banner iFrame. This iFrame is displayed on the top part of the Analytics and Data pages where the Welcome message and Sample Dashboards and ElastiCubes are displayed. You can replace this iFrame with your own content by defining the URL as the value of this key.

tutorialsLink: The Tutorials button. Enter a URL that opens your site.

documentationLink: The Documentation button. Enter a URL that opens your documentation site.

Login Page

The Login page title and subtitles.

“loginTitle” : “WELCOME TO SISENSE”,”loginSubtitle” : “Sign in & start exploring”

 

Copyright Text

The copyright text that appears in Sisense.

“copyrightText”:”Copyright © 2018 Sisense inc. All rights reserved”,

Activation Titles

The titles on the activation page for new users signing in to Sisense.
“activationTitle”: “First Time Activation”,”activationSubtitle”: “Please choose a password to begin using Sisense”,

Contact Us

The Contact Us text is displayed when you request a password and enter your email on the Recover Password page. This text displays a message and provides a link to your Support services.
“contactUsText” : “For further assistance, please contact our success management team!: <a href=’mailto:[email protected]’>[email protected]</a>”,

User Support

The User Support text is displayed in the top right corner of the Sisense.

Be default, the links redirect customers to the Sisense user forums and documentation site. You can modify these URLs to redirect users to your user forums or documentation. This is useful for example when providing OEM services or if you have special forums or instructions to display to your users.

“documentationUrl”: “string”,

“forumUrl”: “string”

Replace the string with the URL to the relevant locations to redirect your users to your support sites.

Powered by Sisense

This string is displayed by default in the User Profile for re-branded servers. You can remove this string by setting the boolean PoweredBySisense value to false.

Emails

The sender information and subject line text displayed in automated emails.

For further customization, see Rebranding Sisense Automated Emails in Windows.

Note: Branded emails (for example, using the senderEmail and senderName paramaters) will be used for new user/group invitation emails and password recovery emails. When sharing a dashboard report, or for subscription emails, the email will be sent without the original name and email of the dashboard’s creator.

“emails” : {“senderEmail”:”[email protected]”,”senderName”:”sys-admin”,”templates_directory” : “/resources/<YourBrand>/emails”,”passwordRecoverySubject” :

“Sisense password recovery”, “newUserInviteSubject” :

“Sisense account activation”, “shareWithNewUserSubject” :

“A Dashboard has been shared with you:”, “shareWithExistingUserSubject” : “A Dashboard has been shared with you:”

“transferOwnership“: “string” }