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 the instructions below:

  1. Download and install the TeamConnect plugin in your system. All the files related to color plugin will get saved in the C:\Program Files\Sisense\app\plugins\ Manage colors folder.
    Note: If users already have the Manage Color plugin installed, that must be replaced with a new Manage Color plugin file. Users cannot have both the new and the old version of this plugin installed at the same time.

  2. Once the plugin is installed in the system. Users need to follow the steps below to define and synchronize the preferred colors on a dashboard.

  3. To define the colors to the categories as per user preferences. They must edit the colorDictionary.js file available in the Manage Colors folder. Detailed information about this is given below.

  4.  To add the codes to Dashboards to ignore the widgets from the Manage color plugin.  Detailed information about this is given below.

How to Manage Color Plugin in TCBI?

In TCBI, colors are pre-assigned to values in a widget based on their order and the colors in the current palette. However, users can customize the colors on their dashboards and widgets using the Manage Color plugin. This plugin has three primary features, which are outlined below.

Synchronize colors on a dashboard.

By synchronizing the colors on a dashboard, you can ensure that a particular category will have a consistent color across all widgets. For instance, if a user has several widgets displaying information about 'New York', the visualizations for 'New York' will use the same color. The colors for this synchronization will be drawn from those specified in the manage color plugin. To synchronize the colors on your dashboard, please follow the steps outlined below.

  1. In the TCBI dashboards page, click on the menu over the right corner of the dashboard widget. Click on Edit script from the menu.

  2. Open the script editor for the dashboard that needs to synchronize the colors on.

  3. Put in the following lines of code into the dashboard script.

    Code.png

  4. Click on Save and refresh the dashboard.

With this feature, users are able to allocate particular colors to specific categories. In cases where a value in the dashboard does not have an assigned color, it will be automatically assigned a color from the available color palette. It is recommended to use the hexadecimal color notation.

For instance, a user can assign the color blue (#0000FF in hexadecimal) to 'New York', and all visualizations for 'New York' will appear in the same shade of blue.

To define the colors in TCBI Manage color plugin the process is given below.

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

  2. Start adding a comma separated list into this file, with the structure of as given below.

    Color code.png

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

  3. Save the File and refresh the dashboard.

Ignore Widgets in the Dashboard

If a user would like to exclude a widget from the dashboard, they can add its Widget ID to the ignore list. This is particularly useful when using conditional coloring, as the widget can be ignored through the color manager. To ignore a widget, please follow the steps below.

  1. Click on the Options menu at the top of the right corner to 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 codes. Copy the widget 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 on Save once the Widget ID is updated in the Edit Script and then refresh the dashboard.