Sisense enables you to rebrand (white label) the Sisense Web Application into your native application or site by using the Sisense REST API to replace existing icons and images with your own.

In addition, you can rebrand the automated emails Sisense sends to match your company’s branding.

White labeling must be enabled in your license. To enable this feature, please contact your Sisense representative or open a request through our Help Center.

Rebranding Sisense

You can rebrand the Sisense Web Application and the automated emails sent by Sisense through Sisense’s REST API.

There are two steps to rebranding the Sisense Web Application. 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 rebrand and their specific dimensions, see White Labeling Configuration Options.

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

To rebrand the Sisense Web Application:

  1. Create a subfolder with your brand name in this directory (on the machine where Sisense is installed): “C:\Program Files\Sisense\PrismWeb\Resources\<YourBrand>”.
    Put your branded files in this directory. The following files are supported:
  • Desktop Logo (for example: Logo-Desktop.png) – This is the main icon that is visible at the top left of the Sisense Web Application.
  • Tablet Logo (for example: Logo-Tablet.png)
  • Mobile Logo (for example: Logo-Mobile.png)
  • Favicon (for example: favicon.ico)
    Note: Optimal dimensions for logo images: 92×26
  • In the Sisense Web Application, click ADMIN at the top right, and then REST API, followed by REST API Reference.
    admin_api
  1. Click /branding and then click the POST operation /branding.
    branding
    To get the required JSON format for the request, click the sample model schema to place the sample text in the body parameter.
    brandingpaste
  2. Replace the sample values with your required values. For an explanation of each parameter and how it modifies the Sisense Web Application, see White Labeling Configuration Options.
  3. Click RUN. Refresh the Sisense Web Application page to view your changes.
    Note: You can change just some of the parameters by leaving out those you do not want to update.

White Labeling Configuration Options

The following table provides a list of the features you can rebrand within the Sisense Web Application and the JAQL 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
Page Title and FaviconSisenseFav 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/branding/fav.ico”

“pageTitle”: “Sisense”,

Sisense LogoSisenseDeskicon 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 table with the ideal logo dimensions (pixels):

Small Large
Desktop 92×26 204×60
Tablet 92×24 163×74
Phone 92×24 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/branding/logoDesktopSmall.png”,

“large”:”/resources/branding/logoDesktopLarge.png”

},

“phone”:{

“small”:”/resources/branding/logoPhoneSmall.png”,

“large”:”/resources/branding/logoPhoneLarge.png”

},

“tablet”:{

“small”:”/resources/branding/logoTabletSmall.png”,

“large”:”/resources/branding/logoTabletLarge.png”

}

},

HomepageSihomeoage The home screen when your users log into Sisense.

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

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

Login Pagelogionpagetitles The Login page title and subtitles.
“loginTitle” : “WELCOME TO SISENSE”,”loginSubtitle” : “Sign in & start exploring”
Copyright Textcopyrighttitle The copyright text that appears in Sisense.
“copyrightText”:”copyright © 2014 sisense inc. All rights reserved”,
Activation Titlesactivateemail The titles on the activation page for new users signing in to Sisense.
“activationTitle”: “Welcome”,”activationSubtitle”: “Welcome”,
Contact Us contactus 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 Supportusersupport The User Support text is displayed in the top right corner of the Sisense Web Application.

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.

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

}