Skip to content

White Labeling

This white labeling feature allows the customization of an application's front-end appearance to align with a company's brand. The feature must be supported by the license in use. A configuration file used to specify the customization options, which include:

  • the displayed name of the product.

  • the displayed company name.

  • the whole content of the About dialog.

  • the ability to provide a Cascading Stylesheet file (css) to override the look and feel, such as colors, fonts, backgrounds used by each page of the application.

To create the Property file:

The configuration file used to white label JasperReports Web Studio needs to be specified in the main configuration file (jrws.properties) by means of the property jrws.branding.config. The name of the branding configuration file is arbitrary. This file does not exist by default, so you have to create it in the application's root folder.

The following table contains the list of properties that can be used for the white labeling. All the properties are optional.

Property Name

Type

 Description

debug

 boolean If set to 1, you see all branding properties in the console, which helps verify that your branding is applied correctly.
product.name string The product name is used in labels like About product name.
company.name string The company name is used in labels such as the copyright notice in the application's lower-right corner.
themes. enabled boolean It enables or disables the ability to switch themes. As branding css typically overrides theme styles, it is recommended to disable theme switching entirely when branding is active.
about.enabled boolean If set to 0, this property hides the link to open the "About" dialog.
about.content string HTML content for the About dialog.
css string

The URL or the web path of a css file to customize the application's look.

The URLs for custom logos and other images should be specified within this CSS file. If the path is provided, it must be relative to jrws/webapps/jrws-main/.

example: /assets/public/acme/wl_branding.css.

Branding assets

There are no specific assets required for branding, if you specify a css file in your branding configuration, you should make it accessible. The possible way to publish these assets is to copy your assets into the jrws/webapps/jrws-main/assets/public/ folder.

To set a license for white labeling

  1. Go to the location where the JasperReports Web Studio zip file is extracted.

  2. Place the provided license file, jaspersoft.jrws_wl_stats2.license, in the local path (example, C:\\Users\\username) and rename it to jaspersoft.jrws.license.

To Enable Branding Configuration

To enable branding, the server needs to load your specific branding configuration. This is achieved by setting the property jrws.branding.config to point to your configuration properties file. (i. e: wl_branding.properties).

Steps to Enable Branding:

  1. Open the jrws.properties file.

  2. Add jrws.branding.config=${ROOT_PATH}/acme_branding.properties to the jrws.properties file.

  3. Once the branding is enabled, restart the JasperReports Web Studio.

To Verify the Branding Configuration

If you have enabled the debug property by setting debug=1 in the branding configuration file, the properties for branding are displayed in the browser console when the home page is loaded and the front-end configuration is fetched from the server.

After verifying the branding configuration, you can see the branding results.

In this example, the About ACME Report Editor dialog is shown, this About dialog and the console displays the new brand information.

about dialog

homepage2