Supported attribute mapping functions for grouping advanced mode
Review which attribute mapping functions are supported in advanced grouping and how they differ from the basic mode.
Function support comparison
The table below lists all supported attribute mapping functions in advanced mode and compares them with the basic mode support.
| Function name | Description | Basic mode support | Advanced mode support |
|---|---|---|---|
| Fixed value | Set a constant value in the group entity | ✔️ | ✔️ |
| Sum of | Sum numeric values across members | ✔️ | ✔️ |
| Minimum of | Find the minimum value across members | ✔️ | ✔️ (supports date and time) |
| Maximum of | Find the maximum value across members | ✔️ | ✔️ (supports date and time) |
| Average of | Calculate the average of numeric member values | ✔️ | ✔️ (supports date and time) |
| Count of all members | Total number of entities in the group | ✔️ | ✔️ |
| Grouping rule | Label group by applied match rule | ✔️ | ❌ (deprecated) |
| Attribute value | Copy values directly from member attributes | ✔️ | ❌ |
| Attribute with source info | Copy attribute values and source details | ✔️ | ❌ |
| Count distinct values | Count how many unique values exist across members | ❌ | ✔️ |
| Top K | Retrieve the most frequent values across members | ❌ | ✔️ |
| Most recent | Retrieve the latest values by timestamp | ❌ | ✔️ |
| Survived value | Use survivorship strategy to populate a group attribute | ❌ | ✔️ |
Supported functions and configuration examples
The following examples show how to configure each supported function in the attributeMappings section of your metadata.
Set a constant value in a group attribute.
{
"uri": "configuration/entityTypes/Household/attributes/FixValue",
"function": {
"type": "fixedValue",
"config": {
"value": "SomeFixValue"
}
}
}Sum numeric values across all group members.
{
"uri": "configuration/entityTypes/Household/attributes/SumIncome",
"function": {
"type": "aggregate",
"config": {
"action": "sum",
"attribute": "configuration/entityTypes/Individual/attributes/Income"
}
}
}Return the minimum value across members. Supports numeric and date types.
{
"uri": "configuration/entityTypes/Household/attributes/MinIncome",
"function": {
"type": "aggregate",
"config": {
"action": "min",
"attribute": "configuration/entityTypes/Individual/attributes/Income"
}
}
}Return the maximum value across members. Supports numeric and date types.
{
"uri": "configuration/entityTypes/Household/attributes/MaxIncome",
"function": {
"type": "aggregate",
"config": {
"action": "max",
"attribute": "configuration/entityTypes/Individual/attributes/Income"
}
}
}Calculate the average value across all members.
{
"uri": "configuration/entityTypes/Household/attributes/AverageIncome",
"function": {
"type": "aggregate",
"config": {
"action": "average",
"attribute": "configuration/entityTypes/Individual/attributes/Income"
}
}
}Count the number of member entities in the group.
{
"uri": "configuration/entityTypes/Household/attributes/Members",
"function": {
"type": "count",
"config": {}
}
}Count the number of unique values for a given attribute across members.
{
"uri": "configuration/entityTypes/Household/attributes/LastNameCount",
"function": {
"type": "countDistinct",
"config": {
"attribute": "configuration/entityTypes/Individual/attributes/LastName"
}
}
}Retrieve the most frequent values for a given attribute. Maximum of 5 values allowed.
{
"uri": "configuration/entityTypes/Household/attributes/Top2Names",
"function": {
"type": "topK",
"config": {
"attribute": "configuration/entityTypes/Individual/attributes/LastName",
"maxValues": 2
}
}
}Return the most recently updated values for an attribute. Maximum of 5 values allowed.
{
"uri": "configuration/entityTypes/Household/attributes/Name",
"function": {
"type": "mostRecent",
"config": {
"attribute": "configuration/entityTypes/Individual/attributes/FirstName"
}
}
}Apply a survivorship strategy to populate a group attribute based on contributor values.
{
"uri": "configuration/entityTypes/Household/attributes/OVBased",
"function": {
"type": "survivedValue",
"config": {
"attribute": "configuration/entityTypes/Individual/attributes/Income",
"maxValues": 1
},
"survivorshipGroupMapping": {
"survivorshipStrategy": "MinValue"
}
}
}