Developer guide: Configuration

JSON Schema Definition

The configuration schema for CCC is defined in hiiretail-json-schema-registry repo. This schema specifies the required structure, allowed values, and validation rules for CCC configuration.

Configuring CCC in Common Clan Repo

To set up CCC, you must configure the actual configuration in the experience-selfcheckout-common repo. This involves:

• Referencing the JSON schema from hiiretail-json-schema-registry Repo.
• Setting default values for the configuration parameters.
• Defining the configuration level based on the available hierarchy levels.

Below is an example of the YAML configuration:

- name: colors-config
    version: v1
    display-name: Color Coding Configuration
    schema-location: https://raw.githubusercontent.com/extenda/hiiretail-json-schema-registry/refs/heads/master/customer-config/attendant-app/att.colors-config.v1.json
    max-tree-depth: business-units/*/workstations/*
    default-value:
      colors:
        primary:
          name: "Primary Color"
          value: "#1A73E8"
        secondary:
          name: "Secondary Color"
          value: "#efefef"

Available Configuration Levels

The CCC configuration applies at different hierarchical levels. The max-tree-depth property determines the maximum level at which a configuration setting is applied.

Level	Key Format	Description
global	tenants/all	Shared by all tenants.
tenant	tenants/self	Specific to a single tenant.
business unit group	business-unit-groups/*	Applies to a group of business units.
business unit	business-units/*	Configuration specific to a single business unit.
workstation	business-units/*/workstations/*	Configuration for an individual workstation.

Note:
The max-tree-depth property determines how deeply a configuration is inherited across levels.