How to configure tenant logo

Prev Next

You can configure to display your business logo in the top-left corner of the application header that reflects your organizational branding.

Notes:

Sample JSON configuration

Sample JSON to configure the logo at the tenant level.

{
  "metaInfo": {
    "dataIndex": "config",
    "collectionName": "configObjects",
    "responseObjectName": "response"
  },
  "configObjects": [
    {
      "id": "rock-tenant-logo-v2_commerceUXConfig",
      "name": "rock-tenant-logo-v2",
      "type": "commerceUXConfig",
      "data": {
        "contexts": [
          {
            "context": {
              "component": "rock-tenant-logo-v2"
            },
            "jsonData": {
              "config": {
                "externalLogoURL": "",
                "logoData": {
                  "base64": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTAwIiBoZWlnaHQ9Ij+CjwvZGVmcz4KPC9zdmc+Cg=="
                }
              }
            }
          }
        ]
      }
    }
  ]
}

To configure the tenant logo:

  1. Download the attached JSON file.

rock-tenant-logo-v2_commerceUXConfig
771 Byte
  1. Open the rock-tenant-logo-v2_commerceUXConfig.json file and specify the following:

Parameters

Details

context

component

Specify the name of the component to be configured.

config > gridConfig

Specify the following.

externalLogoURL

Specify this value if the logo is hosted on any external source.

logoData > base64

Specify the Base64 string of the original image if the logo is not hosted on any external source.

Note: If both values are specified, then the value specified in the externalLogoURL parameter takes precedence over the logoData > base64.

In the application header, you can view the logo based on the configured URL.arameter.

  1. 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 logo based on the configured URL.

ui-configurations-tenant-logo.png