White Labeling

The white labeling feature allows you to completely rebrand the product with your own branding. You can apply white labeling by using a set of APIs in accordance with branding guidelines. You can white label the following components:

  • The logo that appears in the user interface and in the email reports.
  • The color scheme in the user interface and in the email reports.
  • Login splash screen for IPRO Search.
NOTE
Even if you choose not to white label the product, you can still customize the Search login screen—see Customizing the Login Screen.

To change the branding of a given tenant, you need to create and apply a set of graphics and configuration files specific to the new brand. You can apply white label settings using Windows or Linux scripts.

  • Visit one of the following:
  • Windows: C:\ProgramFiles(x86)\Messagin Architects\NetmaiWebAdmin\sbin\apid\scripts\branding
  • Linux: /opt/ma/netmail/sbin/apid/scripts/branding
  • Create a disk folder on your storage device.
  • Copy the contents of the script file and paste into the folder.
  • In the folder are nine files for white labeling. Of these, you can edit the first seven (7). The .json and .css should not be edited.

File

Description

Scaled (px)

Recommended Size (px)

icon.png

Small favicon icon with transparent background.

Top node in Admin UI tree view.

16 x 16

256 x 256

logo.png

Logo image with transparent background.

Use against white backgrounds such as reports.

44 px tall (any width)

555 x 111 (not mandatory)

logo-white.png

Logo image with light colors (preferably white) and transparent background.

Used against darker backgrounds such as the top bar of the Admin UI.

Scaled to be 2 lines of text tall (any width).

555 x 111 (not mandatory)

netmailsearch.png

Product-specific logo image with transparent background.

Used at the top bar of Search UI for eDiscovery and Audit.

48 px tall (any width)

48 x 260 (not mandatory).

netmailarchive.png

Product-specific logo image with transparent background.

Used at the top bar of the Search UI for end-user access and in the Search Lite UI.

48 px tall (any width)

48 x 260 (not mandatory).

search_login_bg.png

Splash screen image on transparent background.

Used for Search login screen.

271 x 705

271 x 705

test.html

Lets you test locally to see how changes to other files look.

 --- ---

 

branding.json

Configuration file to capture the brand label and color.

Brand label: Lowercase string used for page titles.

Brand color: HTML color code (hex) used for report color theme.

NOTE
Do not edit this file as it will adversely affect the branding.
 --- ---

style.css

This is the stylesheet.

Branding text and background color (top bar background in Admin UI).

Hyperlink colors (default, active, hover, visited).

NOTE
Do not edit this file as it will adversely affect the branding.
 --- ---

Windows

Localhost, no API key:

  • Copy the script (Set-Branding.ps1) in the graphics folder along with the branding files.
  • Remote into the master node and copy the graphics folder to the local drive.
  • Run the Set-Branding.ps1 script to apply the new branding, including logoware and styling. For example:
  • ./Set-Branding.ps1
  • In a multi-tenant scenario, run the above procedure for each tenant from its corresponding master node.

Remote, using an API key:

  • Copy the script (Set-Branding.ps1) in the graphics folder along with the branding files.
  • Generate an API—see How to generate an API key.
  • Run the Set-Branding.ps1 script to apply the new branding logoware and styling by providing the IP of the master node and the API key. For example:
  • ./Set-Branding.ps1 -TenantHost '<master_node_IP>' -APIKey '<apikey>'
  • In a multi-tenant scenario, run the above procedure for each tenant by providing the corresponding master node IP and API key.

Linux

Localhost, no API key:

  • Copy the script (Set-Branding.sh) in the graphics folder along with the branding files.
  • Remote into (one of) the Linux platform node(s) and copy the graphics folder to the local drive.
  • Run "Set-Branding.sh" to apply the new branding, including logoware and styling. For example:
  • ./Set-Branding.sh
NOTE
Branding multiple tenants is not supported on Secure nodes. If you are using Secure nodes to change the branding, you can only update the branding on the default Secure tenant. If you have additional Secure tenants, they will follow suit.

Remote, with API key:

  • Copy the script (Set-Branding.sh) in the graphics folder along with the branding files.
  • Generate an API key for the tenant using the "apikeys" API. Point your browser to the following URL:
  • //localhsot:444/docs/#!/apikeys/createKey
  • You can create the key directly from any cluster node using the default tenantID, or from the Archive master node in multi-tenant scenario.
  • Run "Set-Branding.sh" to apply the new branding, including logoware and styling, by providing the IP of the master node and the API key. For example:
  • ./Set-Branding.ps1 -h '<master_node_IP>' -k '<apikey>'
  • In a multi-tenant scenario, run the above procedure for each tenant by providing the corresponding master node IP and API key.

Before making changes to the current branding, it may be useful to retrieve the brand configuration files that are currently installed. You can use those as a starting point for creating new brand graphics, or simply to validate the existing configuration. To retrieve the current branding configuration, follow the steps below:

Windows

Localhost, no API key:

  • Remote into the master node and create a new destination folder where the branding files will be extracted to.
  • Copy "Get-Branding.ps1" script into the new folder.
  • Run "Get-Branding.ps1" to retrieve the current branding configuration. For example:
  • ./Get-Branding.ps1
  • Inspect the downloaded files in the current folder.

Remote - with API key:

  • Create a new destination folder where the branding files will be extracted to.
  • Generate an API—see How to generate an API key.
  • Run "Get-Branding.sh" to retrieve the current branding, including logoware and styling, by providing the IP of the master node and the API key along with the destination folder name where the files will be extracted to. For example:
  • ./Get-Branding.ps1 -BrandingFolder <folder_name> -TenantHost '<master_node_IP>' -APIKey '<apikey>'
  • Inspect the downloaded files in the destination folder.
  • In a multi-tenant scenario, run the above procedure for each tenant by providing the corresponding master node IP and API key. Use a different destination folder for each tenant.

Linux

Localhost, no API key:

  • Remote into (one of) the Linux platform node(s) and create a new destination folder where the branding files will be extracted.
  • Copy "Get-Branding.sh" script into that folder.
  • Run "Get-Branding.sh" retrieve the current branding configuration. For example:
  • ./Get-Branding.sh
  • Inspect the downloaded files in the current folder.
NOTE
Branding multiple tenants is not supported on Secure nodes. If you are using Secure nodes to change the branding, you can only update the branding on the default Secure tenant. If you have additional Secure tenants, they will follow suit.

Remote, with API key:

  • Create a new destination folder where the branding files will be extracted to.
  • Generate an API—see How to generate an API key.
  • Run "Get-Branding.sh" to retrieve the current branding, including logoware and styling, by providing the IP of the master node and the API key along with the destination folder name where the files will be extracted to. For example:
  • ./Get-Branding.sh -f <folder_name> -h '<master_node_IP>' -k '<apikey>'
  • Inspect downloaded files in the destination folder.
  • In a multi-tenant scenario, run the above procedure for each tenant by providing the corresponding master node IP and API key. Use a different destination folder for each tenant.

IPRO branding is required when restoring to default branding. You can remove the branding that is currently installed by following the steps below:

Windows

Localhost, no API key:

  • Remote into (one of) the Linux platform node(s) and copy the "Remove-Branding.ps1" script.
  • Run "Remove-Branding.ps1" to remove the branding that is currently configured.
NOTE
Branding multiple tenants is not supported on Secure nodes. If you are using Secure nodes to change the branding, you can only update the branding on the default Secure tenant. If you have additional Secure tenants, they will follow suit.

Remote, with API key:

  • Generate an API—see How to generate an API key.
  • Run "Remove-Branding.ps1" to remove the current branding, including logoware and styling, by providing the IP of the master node and the API key. For example:
  • ./Remove-Branding.ps1 -TenantHost '<master_node_IP>' -APIKey '<apikey>'
  • In a multi-tenant scenario, run the above procedure for each tenant by providing the corresponding master node IP and API key. Use a different destination folder for each tenant.

Linux

Localhost, no API key:

  • Remote into (one of) the Linux platform node(s) and copy "Remove-Branding.sh" script.
  • Run "Remove-Branding.sh" to remove the branding that is currently configured.
NOTE
Branding multiple tenants is not supported on Secure nodes. If you are using Secure nodes to change the branding, you can only update the branding on the default Secure tenant. If you have additional Secure tenants, they will follow suit.

Remote, with API key:

  • Generate an API—see How to generate an API key.
  • Run "Remove-Branding.sh" to remove the current branding, including logoware and styling, by providing the IP of the master node and the API key. For example:
  • ./Remove-Branding.sh -h '<master_node_IP>' -k '<apikey>'
  • In a multi-tenant scenario, run the above procedure for each tenant by providing the corresponding master node IP and API key. Use a different destination folder for each tenant.

In order to use the scripts, and consequently, the API remotely across the network, you must generate an API key. You can create the key directly from any cluster node using the default tenant ID, or from the Archive master node in multi-tenant scenario.

  • Remote into a cluster node or the master node
  • Start a browser session and point the browser to the following URL:
  • //localhost:444/docs/#!/apikeys/createKeys
  • Enter the default tenant ID ("-"), a key ID ("tempkey") and press the "Try Out" button
  • Retrieve the "apikey" from the Response Body.