Skip to content

Product Hierarchy

Products are a second-level classification under a business class. The platform supports a two-level hierarchy (sub_class_1 and sub_class_2) for more granular product categorisation.

Products

Products are defined as business constants and then referenced in the business class file.

Step 1: Define the products in business-constants/product.json:

[
  { "typeCode": "product", "itemCode": "PROP_STANDARD", "value": "Standard Property" },
  { "typeCode": "product", "itemCode": "PROP_COMPLEX", "value": "Complex Property" }
]

Step 2: Reference them in the business class file:

{
  "products": [
    { "productCode": "PROP_STANDARD" },
    { "productCode": "PROP_COMPLEX" }
  ]
}

Sub-class hierarchy

Create a parent-child product hierarchy using sub_class_1 and sub_class_2 business constants. Each level references its parent via an additionalProperties object.

Business Constant File Usage
sub_class_1 business-constants/sub_class_1.json First sub-level. References parent productCode via additionalProperties.productCode.
sub_class_2 business-constants/sub_class_2.json Second sub-level. References parent sub_class_1 item via additionalProperties.parent.

sub_class_1 example

[
  {
    "typeCode": "sub_class_1",
    "itemCode": "PROP_STD_COMMERCIAL",
    "value": "Commercial Property",
    "additionalProperties": {
      "productCode": "PROP_STANDARD"
    }
  },
  {
    "typeCode": "sub_class_1",
    "itemCode": "PROP_STD_RESIDENTIAL",
    "value": "Residential Property",
    "additionalProperties": {
      "productCode": "PROP_STANDARD"
    }
  }
]

sub_class_2 example

[
  {
    "typeCode": "sub_class_2",
    "itemCode": "PROP_STD_COM_OFFICE",
    "value": "Office Buildings",
    "additionalProperties": {
      "parent": "PROP_STD_COMMERCIAL"
    }
  }
]

How the hierarchy works in the UI

When an underwriter selects a product on the submission form, the sub_class_1 dropdown filters to show only the children of that product. When they select a sub_class_1 item, the sub_class_2 dropdown filters accordingly.

This cascading selection is handled automatically by Workbench — no additional configuration is needed to enable the filtering behaviour, as long as the additionalProperties references are correct.

Using sub-classes in display conditions

Sub-class values can be used in displayConditions and displayCriteriaExpressions to show or hide fields based on the selected product hierarchy. For example, showing a specialist field only when a specific sub_class_2 value is selected.

Tips

  • additionalProperties values are case-sensitive. Ensure productCode and parent values exactly match the itemCode of the parent item.
  • Sub_class_1 items that reference a non-existent product code will not appear in the filtered dropdown.
  • You do not need to use both levels of the hierarchy. If you only need one level of sub-classification, configure sub_class_1 only.