How to set Context path

Prev Next

The Context settings defines coalesce path, order or the inheritance path for which the UI configurations are applied. The most frequently used coalesce path is - "component>>tenant>>domain>>app>>dockingPanel>>entityType >>relationship>>role>>user".

The following illustrates the recommended coalesce path:

Sample JSON configuration

{
  "metaInfo": {
    "dataIndex": "config",
    "collectionName": "configObjects",
    "responseObjectName": "response"
  },
  "configObjects": [
    {
      "id": "config-context-settings_commerceUXConfig",
      "name": "config-context-settings",
      "version": "1.0",
      "type": "commerceUXConfig",
      "properties": {
        "createdByService": "system",
        "createdBy": "system"
      },
      "data": {
        "contexts": [
          {
            "context": {
              "component": "config-context-settings"
            },
            "jsonData": {
              "config": {
                "coalescePath": "component>>tenant>>domain>>app>>dockingPanel>>entityType>> relationship>>role>>user",
                "contextSchema": {
                  "component": "_DEFAULT",
                  "tenant": "_DEFAULT",
                  "domain": "_DEFAULT",
                  "app": "_DEFAULT",
                  "dockingPanel": "_DEFAULT",
                  "entityType": "_DEFAULT",
                  "relationship": "_DEFAULT",
                  "role": "_DEFAULT",
                  "user": "_DEFAULT"
                }
              }
            }
          }
        ]
      }
    }
  ]
}

To configure context settings for a tenant:

  1. Download the attached JSON file.

  2. Open the config-context-settings_commerceUXConfig.json file and specify the following:

    Parameters

    Details

    context

    component

    Specify the name of the component to be configured.

    config

    Specify the following:

    coalescePath

    Specify the inheritance path in which the UI configurations must be applied.

Note:

You must not override the “id” and “name” parameters in the configuration.

  1. Upload the JSON configuration file in the Classic UI. For more information, see How to upload UI Configurations.

Once you load the context settings, you can further configure different components of the user interface.