Skip to main content
Mitratech Success Center

Client Support Center

Need help? Click a product group below to select your application and get access to knowledge articles, webinars, training content, and release notes or to contact our support team.

Authorized users - log in to create a ticket, view tickets status and check your success plan details.

 

Manage Color Plugin in TeamConnect Business Intelligence

  1. Last updated
  2. Save as PDF

TCBI has integrated Manage color plugin to facilitate color profile support. With the manage color plugin, users can now customize the color of their dashboards and widgets to suit their preferences.

How to Install Manage Color Plugin in TCBI?

To install the TCBI Manage Color plugin, follow these instructions:

  1. Download and install the TeamConnect plugin on your system. All files related to the Manage Color plugin will be saved in the C:\Program Files\Sisense\app\plugins\ Manage colors folder.

Note: If users already have the Manage Color plugin installed, it must be replaced with the new Manage Color plugin file. Users cannot have both the new and the old versions of this plugin installed simultaneously.

2024-07-24_13-21-43.jpg

  1. Once installed, the Manage Color plugin provides the following features:

  • Synchronize Preferred Colors on a Dashboard.
  • Ignore Widgets in the Dashboard.
  • Define Colors for Categories Based on User Preferences.

How to Manage Color Plugin in TCBI?

In TCBI, colors are automatically assigned to values in a widget according to their order and the colors in the current palette. However, users can customize these colors on their dashboards and widgets using the Manage Color plugin. 

Synchronize Preferred colors on a dashboard.

Synchronizing colors on your dashboard ensures that a specific category maintains a consistent color across all widgets. For example, if you have multiple widgets displaying information about 'New York,' all visualizations for 'New York' will use the same color. These colors are drawn from the settings specified in the Manage Color Plugin. To synchronize colors on your dashboard, follow these steps:

  1. Navigate to the TCBI dashboards page.
  2. Click on the menu icon in the upper-right corner of the dashboard widget. Select Edit Script from the menu.

  1. Open the script editor for the dashboard you wish to synchronize colors on.
  2. Insert the following lines of code into the dashboard script.

Code.png

  1. Click Save and refresh the dashboard.

If users want to exclude a widget from color synchronization, you can add its Widget ID to the ignore list. This feature is particularly useful when using conditional coloring, as it allows the widget to be bypassed by the color manager. To ignore a widget, follow these steps:

  1. Click on the Options menu at the top right corner of the selected widget. From the options, select Embed Code.


  2. A new window named Widget Embed will display on the screen with URL and HTML code. Copy the widget ID from the HTML code as shown below.

  3. Open the dashboard script editor as explained above and paste the Widget ID in the ignoreList variable with double quotes. Users have to put the id of each widget that the users would like to ignore in this dashboard into a comma separated list.

  4. Click Save once the widget ID is updated in the Edit Script, and then refresh the dashboard.

With this feature, users can assign specific colors to particular categories. If a value in the dashboard does not have an assigned color, it will automatically be assigned a color from the available color palette. It is recommended to use hexadecimal color notation for accuracy.

For example, a user can assign the color blue (#0000FF in hexadecimal) to 'New York'. Consequently, all visualizations for 'New York' will consistently display in that shade of blue.

To define colors in the TCBI Manage Color Plugin, follow these steps:

  1. Open the file colorDictionary.js located at C:\Program Files\Sisense\app\plugins\ Manage colors\ in a text editor, such as Notepad. You may need to open Notepad as an administrator to access the file.

  2. Begin adding a comma-separated list into this file, using the structure provided below. Save the File and refresh the dashboard.

Color code.png

Examples for defining the colors are given in the image below.