How to configure Environment Indicator

You can configure to display the environment name and the color indicator next to the Customer logo in the application header. These provide a visual cue of the current environment. For example, Sandbox, Performance, Testing, and so on.

Note: By default, the Environment Indicator is disabled in the application.

The color indicators that can be configured for the Environment Indicator are as follows:

Supported Colors	RGB Code
darkGreen	#00857D
green	#33EA18
lightBlue	#00C5F3
blue	#009DC0
darkBlue	#003087
purple	#8E51A8
orange	#FF8F1C
yellow	#FFCD00
red	#E03C31

Sample JSON configuration

Sample JSON to configure the Environment Indicator.

{
  "metaInfo": {
    "dataIndex": "config",
    "collectionName": "configObjects",
    "responseObjectName": "response"
  },
  "configObjects": [
    {
      "id": "global-settings_commerceUXConfig",
      "name": "global-settings",
      "version": "1.0",
      "type": "commerceUXConfig",
      "properties": {
        "createdByService": "system",
        "createdBy": "system"
      },
      "data": {
        "contexts": [
          {
            "context": {
              "component": "global-settings",
              "role": "_DEFAULT",
              "user": "_DEFAULT"
            },
            "jsonData": {
              "config": {
                "environmentIndicator": {
                  "indicatorVisible": true,
                  "color": "blue",
                  "envName": "Sandbox"
                }
              }
            }
          }
        ]
      }
    }
  ]
}

To configure the Environment Indicator:

Download the attached JSON file.

global-settings_environmentIndicator_commerceUXConfig

975 Byte

Open the global-settings_environmentIndicator_commerceUXConfig.json file and specify the following:

Parameters		Details
context	component	Specify the name of the component to be configured.
	role	Specify the role for which the component is to be configured, else _DEFAULT.
	user	Specify the user for which the component is to be configured, else _DEFAULT. Note: By default, _DEFAULT is specified for role and user parameters, which implies the component is configured for all roles and users.
config	Specify the following parameters.
	color	Specify a supported color indicator for the Environment Indicator. For example, ‘blue’.
	envName	Specify a name to be displayed in the Environment Indicator. For example, ‘Sandbox’.
	indicatorVisible	Show or hide the Environment Indicator. true – implies the indicator is displayed. false - implies the indicator is hidden.

Upload the JSON configuration file in the Classic UI. For more information, see How to upload UI Configurations.
In the application header, you can view the Environment Indicator based on the configuration.