Learn about enabling segmented grouping using L3 configuration and metadata to support high-volume entity grouping.

Segmented grouping is enabled by updating the L3 configuration to version v2 and defining grouping logic in the groupingTypes section of the metadata. You can specify how entities are grouped, which match rules to use, and how attributes are aggregated into the group entity. Here's a sample configuration:

"groupingConfig": {
  "enabled": true,
  "version": "v2"
}

In your metadata, define a groupingTypes block with the entity type to be created for groups and its member definition, as shown below.

"groupingTypes": [
  {
    "entityType": "configuration/entityTypes/Merchant",
    "members": [
      {
        "entityType": "configuration/entityTypes/Organization",
        "relationType": "configuration/relationTypes/IsMerchantMember",
        "groupingRule": "configuration/entityTypes/Organization/matchGroups/MerchantRule1a"
      }
    ]
  }
]

Define attributeMappings for the group entity to aggregate values from member entities, as shown below:

{
  "attributeMappings": [
    {
      "uri": "configuration/entityTypes/Household/attributes/PhoneNumber",
      "function": {
        "type": "topK",
        "config": {
          "attribute": "configuration/entityTypes/Individual/attributes/PhoneNumber",
          "maxValues": 3
        }
      }
    },
    {
      "uri": "configuration/entityTypes/Household/attributes/Surname",
      "function": {
        "type": "survivedValue",
        "config": {
          "attribute": "configuration/entityTypes/Individual/attributes/LastName",
          "maxValues": 1
        },
        "survivorshipGroupMapping": {
          "attribute": "configuration/entityTypes/Individual/attributes/LastName",
          "sourcesUriOrder": [
            "configuration/sources/FB",
            "configuration/sources/Reltio",
            "configuration/sources/LinkedIn"
          ],
          "fallbackStrategies": [
            {
              "attribute": "configuration/entityTypes/Individual/attributes/LastName",
              "comparisonAttributeOvOnly": true,
              "survivorshipStrategy": "Aggregation"
            }
          ],
          "fallbackUsingCriteria": "ZERO_OR_MORE_THAN_ONE",
          "survivorshipStrategy": "SRC_SYS"
        }
      }
    }
  ]
}

To know which attribute mapping functions are supported in segmented grouping and how they differ from automated householding, see Supported attribute mapping functions for segmented grouping.

To validate whether your grouping metadata supports the Segmented Grouping UI, see Validate grouping metadata.