Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
RecordAggregationDefinition
Parent Type
File Suffix and Directory Location
RecordAggregationDefinition components have the suffix .RecordAggregationDefinition and are stored in the RecordAggregationDefinitions folder.
Version
RecordAggregationDefinition components are available in API version 59.0 and later.
Special Access Rules
To access the RecordAggregationDefinition metadata type, you must have the Record Aggregation permission set license and the Record Aggregation Access permission.
Fields
| Field Name | Description |
|---|---|
| aggregateFromObject |
|
| aggregateToObject |
|
| aggregationType |
|
| batchProcessingDefinition |
|
| description |
|
| displayName |
|
| recordAggregationObject |
|
| status |
|
RecordAggregationObject
Represents an object in the record aggregation join sequence.
| Field Name | Description |
|---|---|
| associatedObject |
|
| developerName |
|
| filterLogic |
|
| masterLabel |
|
| recordAggregationJoinCondition |
|
| recordAggregationObjectFilter |
|
RecordAggregationJoinCondition
Represents a condition in a join between two record aggregation objects.
| Field Name | Description |
|---|---|
| joinField |
|
| navigationSequenceNumber |
|
| relatedJoinField |
|
| relatedRecordAggregationObject |
|
| type |
|
RecordAggregationObjectFilter
Represents a filter that is applied to the records of an object in the record aggregation join sequence. Available in API version 60.0 and later.
| Field Name | Description |
|---|---|
| associatedObjectField |
|
| operator |
|
| sequenceNumber |
|
| value |
|
Declarative Metadata Sample Definition
The following is an example of a RecordAggregationDefinition component.
<?xml version="1.0" encoding="UTF-8"?>
<RecordAggregationDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
<aggregateToObject>PartyRelationshipGroup</aggregateToObject>
<aggregateFromObject>PartyIncome</aggregateFromObject>
<status>Active</status>
<aggregationType>Record</aggregationType>
<description>Aggregate head of household's income to household</description>
<displayName>Party Income to Party Relationship Group</displayName>
<recordAggregationObject>
<associatedObject>PartyRelationshipGroup</associatedObject>
<masterLabel>Party Relationship Group Object</masterLabel>
<developerName>PartyRelationshipGroupObject</developerName>
<recordAggregationJoinCondition>
<joinField>Account</joinField>
<navigationSequenceNumber>1</navigationSequenceNumber>
<relatedJoinField>Account</relatedJoinField>
<relatedRecordAggregationObject>AccountContactrelationObject</relatedRecordAggregationObject>
<type>Intermediate</type>
</recordAggregationJoinCondition>
<recordAggregationObjectFilter>
<associatedObjectField>Type</associatedObjectField>
<operator>Equals</operator>
<value>Household</value>
<sequenceNumber>1</sequenceNumber>
</recordAggregationObjectFilter>
</recordAggregationObject>
<recordAggregationObject>
<associatedObject>AccountContactRelation</associatedObject>
<masterLabel>Account Contact Relation Object</masterLabel>
<developerName>AccountContactRelationObject</developerName>
<recordAggregationJoinCondition>
<joinField>Contact</joinField>
<navigationSequenceNumber>2</navigationSequenceNumber>
<relatedJoinField>Party</relatedJoinField>
<relatedRecordAggregationObject>PartyIncomeObject</relatedRecordAggregationObject>
<type>Intermediate</type>
</recordAggregationJoinCondition>
<recordAggregationObjectFilter>
<associatedObjectField>IsPrimaryMember</associatedObjectField>
<operator>Equals</operator>
<value>true</value>
<sequenceNumber>1</sequenceNumber>
</recordAggregationObjectFilter>
</recordAggregationObject>
<recordAggregationObject>
<associatedObject>PartyIncome</associatedObject>
<masterLabel>Party Income Object</masterLabel>
<developerName>PartyIncomeObject</developerName>
<filterLogic>1 AND 2</filterLogic>
<recordAggregationObjectFilter>
<associatedObjectField>IncomeFrequency</associatedObjectField>
<operator>Equals</operator>
<value>Monthly</value>
<sequenceNumber>1</sequenceNumber>
</recordAggregationObjectFilter>
<recordAggregationObjectFilter>
<associatedObjectField>IncomeStatus</associatedObjectField>
<operator>Equals</operator>
<value>Active</value>
<sequenceNumber>2</sequenceNumber>
</recordAggregationObjectFilter>
</recordAggregationObject>
</RecordAggregationDefinition>The following is an example package.xml that references the previous definition.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>RecordAggregationDefinition</name>
</types>
<version>60.0</version>
</Package>Wildcard Support in the Manifest File
This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.