White Labeling Sisense in Linux

Applicable to Sisense on Linux

If you want to white label Sisense in a Windows environment, see White Labeling Sisense in Windows.

You can white label (rebrand) Sisense to fit into your native application or site through the Configuration Manager or the Sisense REST API, and replace existing icons and images with your own.

White labeling must be enabled in your license. Contact your Sisense representative or open a request through the Sisense Support Portal. In addition, Sisense now 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.

There are two steps to white labeling Sisense:

  1. Place your branded content into the Sisense branding directory where Sisense is installed. For a list of the files you can rebrand and their specific dimensions, see White Labeling Configuration Options.
  2. Update your Sisense configuration through the Configuration Manager or through the Sisense REST API, where you can embed your content directly into Sisense and modify text displayed to customers.

White Labeling Sisense in the Configuration Manager

To white label Sisense through the Configuration Manager:

  1. Create a subfolder with your brand name in this directory (on the computer where Sisense is installed): /branding/<YourBrand>/
    See Uploading Files through the File Manager and upload the files to the branding folder.
  2. Open the Sisense Configuration Manager. You can access it by opening the Admin tab, and then selecting System Management > Configuration.
  3. In the Configuration Manager, open the Branding tab.
  4. Under the Branding tab, enter the updated details for the following fields. For an explanation of each field and how it modifies Sisense, see White Labeling Configuration Options.
    • Favicon
    • Forum URL
    • Home Page
    • Homepage Config Documentation Link
    • Homepage Config Hide Search in Navver
    • Homepage Config Marketing Part
    • Homepage Config Tutorials Link
    • Login Subtitle
    • Login Title
    • Logo Desktop Large
    • Logo Desktop Small
    • Logo Phone Large
    • Logo Phone Small
    • Logo Tablet Large
    • Logo Tablet Small
    • Page Title
    • Show Powered by Sisense
  5. Click Save.

White Label Sisense in the REST API

To white label Sisense through the REST API:

Note: Go to the REST API playground to explore some of the REST API calls.

  1. Create a subfolder with your brand name in this directory (on the computer where Sisense is installed): /branding/<YourBrand>/
    See Uploading Files through the File Manager and upload the files to the branding folder.
  2. Save 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
  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 Sisense, see White Labeling Configuration Options.
    Note: Make sure you delete parameters you don't want to change before running the call. Leaving "string" values will overwrite the Sisense default configuration.

  7. Click RUN.

  8. Refresh the Sisensepage to view your changes.

White Labeling Configuration Options

The following table provides a list of the features you can rebrand within Sisense and the JSON code that must be modified to rebrand 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":"/branding/<YourBrand>/logoDesktopSmall.png",

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

},

"phone":{

"small":"/branding/<YourBrand>/logoPhoneSmall.png”,

"large":"/branding/<YourBrand>/logoPhoneLarge.png”

},

“tablet”:{

"small":"/branding/<YourBrand>/logoTabletSmall.png”,

"large":"/branding/<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" : "/branding/<YourBrand>/fav.ico"

"pageTitle": "Sisense",

Homepage

The home screen when your users log into Sisense. Rebranding the homepage doesn't affect the view of the Administrator. Administrators see the default homepage, while all other users see the rebranded 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 rebranded 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.

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” : “/branding/<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” }