How to define attributes for Catalog Readiness widget

You can track the status summary of your product catalog by defining the relevant readiness score attributes, such as Pricing Readiness Score, Logistics Readiness Score, Marketing Readiness Score, or Compliance Readiness Score.

This chart displays a quick status summary of product-level readiness scores for each category that helps you to track the overall status for each category at a glance. For more information, see Dashboard.

Sample JSON configuration

Sample JSON that defines readiness score attributes for the Catalog Readiness widget.

{
  "metaInfo": {
    "dataIndex": "config",
    "collectionName": "configObjects",
    "responseObjectName": "response"
  },
  "configObjects": [
    {
      "id": "sys_rock-catalog-readiness-base_commerceUXConfig",
      "name": "sys_rock-catalog-readiness",
      "version": "1.0",
      "type": "commerceUXConfig",
      "properties": {
        "createdByService": "system",
        "createdBy": "system"
      },
      "data": {
        "contexts": [
          {
            "context": {
              "component": "rock-catalog-readiness",
              "sysRole": "_DEFAULT",
              "sysUser": "_DEFAULT"
            },
            "jsonData": {
              "config": {
                "pstdpricingdatascorenumber": {
                  "name": "pstdpricingdatascorenumber",
                  "label": "{[ComUXPriTxt]}",
                  "enabled": true,
                  "visible": true
                },
                "pstdlogisticdatascorenumber": {
                  "name": "pstdlogisticdatascorenumber",
                  "label": "{[ComUXLogTxt]}",
                  "enabled": true,
                  "visible": true
                },
                "pstdmediadatascorenumber": {
                  "name": "pstdmediadatascorenumber",
                  "label": "{[ComUXMedTxt]}",
                  "enabled": true,
                  "visible": false
                },
                "pstdmarketingdatascorenumber": {
                  "name": "pstdmarketingdatascorenumber",
                  "label": "{[ComUXMarkTxt]}",
                  "enabled": true,
                  "visible": true
                },
                "pstdcompliancedatascorenumber": {
                  "name": "pstdcompliancedatascorenumber",
                  "label": "{[ComUXCompTxt]}",
                  "enabled": true,
                  "visible": true
                }
              }
            }
          }
        ]
      }
    }
  ]
}

Download the attached JSON file.

sys_rock-catalog-readiness-base_commerceUXConfig

1.97 KB

Open the sys_rock-catalog-readiness-base_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 readiness score attributes with the following details:
	name	Specify the internal name of the attribute.
	label	Specify the category name to be displayed in the widget.
	enabled	Turn-on or turn-off the categories during the Dashboard customizations. For more information, see true – implies the category is turned-on in the widget. false – implies the category is turned-off in the widget.
	visible	Show or hide the categories during the Dashboard customizations. true – implies the category is displayed in the widget. false – implies the category is hidden in the widget and in the Dashboard customizations.

Upload the JSON configuration file in the Classic UI. For more information, see How to upload UI Configurations.
In the Dashboard, the Catalog Readiness widget displays the summary of product readiness statuses based on the configured categories.