RelatedRecordAssocCriteria | Metadata API Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

RelatedRecordAssocCriteria components have the suffix .relatedRecordAssocCriteria and are stored in the relatedRecordAssocCriteria folder.

Version

RelatedRecordAssocCriteria components are available in API version 52.0 and later.

Special Access Rules

To use this object, you must have the Financial Services Cloud Extension permission set.

Fields

Field Name	Description
associationHandlerApexClass	Field Type string Description The name of a custom Apex class that handles the creation of association records for specific association criteria. This class must: Apply to an object that the Record Association Builder doesn't directly support Implement the fscwmgen.BranchManagementAssociationHandler interface Return a list of Branch Unit Related Records Populate at least the minimum required fields in each Branch Unit Related Record: BranchUnitId: Represents the current branch unit of the user or contact BusinessUnitMemberId: The Banker ID of the user or contact RelatedRecordId: The ID of the custom object to be related This field is a relationship field.
associationType	Field Type AssociationType (enumeration of type string) Description Required. The association type. Values are: `BranchManagement`
description	Field Type string Description A description of the association criteria.
eventType	Field Type AssociationEventType (enumeration of type string) Description Required. The type of reference object event that triggers creation of the association. Values are: `Create` `Update`
isProtected	Field Type boolean Description An auto-generated value that doesn’t impact the behavior of the metadata type. The default value is `false`.
masterLabel	Field Type string Description Required. The master label of the association criteria. This internal label doesn’t get translated.
preCondition	Field Type string Description Required. A formula that, when true, causes a new association to be created.
referenceObject	Field Type string Description Required. The reference object for the association criteria.
selectedOwnerField	Field Type string Description A field to use instead of the default Owner ID.
status	Field Type AssociationStatusType (enumeration of type string) Description Required. The status of the association criteria. Values are: `Active` `Draft` `Inactive`

Declarative Metadata Sample Definition

The following is an example of a RelatedRecordAssocCriteria component.

1<?xml version="1.0" encoding="UTF-8"?>
2<RelatedRecordAssocCriteria xmlns="http://soap.sforce.com/2006/04/metadata">
3   <associationType>BranchManagement</associationType>
4   <eventType>Create</eventType>
5   <masterLabel>RevenueThreeMillion</masterLabel>
6   <preCondition>[Account].AnnualRevenue > 3000000</preCondition>
7   <referenceObject>Account</referenceObject>
8   <status>Active</status>
9</RelatedRecordAssocCriteria>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>RelatedRecordAssocCriteria</name>
6    </types>
7    <version>52.0</version>
8</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.