OnboardingDataObjectGroup

Represents a configuration that groups fields from one or more objects for a specific business purpose. For example, the Customer Contact Information onboarding data object group includes Name, Email, Phone Number, and Address.

Parent Type

This type extends Metadata and inherits its fields.

File Suffix and Directory Location

OnboardingDataObjectGroup components have the suffix .onboardingDataObjectGroup and are stored in the onboardingDataObjectGroups folder.

Version

Introduced in API version 66.0.

Special Access Rules

There are no additional access requirements that are specific to this type.

Fields

description

Type: string
Required: No
Description: Description of the onboarding data object group.

masterLabel

Type: string
Required: Yes
Description: Required. A user-friendly name for OnboardingDataObjectGroup, which is defined when the OnboardingDataObjectGroup is created.

usageType

Type: OnboardingDataObjGrpUsageType (enumeration of type string)
Required: Yes
Description: Required. Specifies the purpose of the onboarding data object group.
Possible values:
- DocumentValidation
- ValidityPeriod

versionDetail

Type: OnboardingDataObjGrpVer[]
Required: No
Description: Versions of the onboarding data object group, which define the computation settings and related data objects.

OnboardingDataObject Type

Represents a data object within an onboarding data object group, specifying the target object and its field configurations. For example, Party Profile and Party Profile Address are objects within the Customer Information onboarding object data group.

Fields

businessContext

Type: OnboardingDataObjBusContext (enumeration of type string)
Required: Yes
Description: Required. Specifies the business context or scenario in which this validity configuration is applicable.
Possible values:
- KYC_VALIDITY
- DVC

fieldDetail

Type: OnboardingDataObjectField[]
Required: No
Description: Details of the fields within the data object.

name

Type: string (enumeration of type string)
Required: Yes
Description: Required. Target sObject type for this data object.
Possible values:
- Account
- Applicant
- ApplicationForm
- ApplicationFormProduct
- ApplicationFormSellerItem
- Contact
- IdentityDocument
- Opportunity
- PartyCreditProfile
- PartyExpense
- PartyFinancialAsset
- PartyFinancialAssetLien
- PartyFinancialLiability
- PartyFinclAssetAddlOwner
- PartyFinclLiabAddlBrwr
- PartyIdentityVerification
- PartyIdentityVerificationStep
- PartyIncome
- PartyProfile
- PartyProfileAddress
- PartyProfileRisk
- PartyScreeningSummary
- PersonEmployment

partyProfileDataObjectValidityDefinition

Type: string
Required: No
Description: Reference to the PartyProfileDataObjectValidityDefinition metadata type that defines validity settings for this data object.

pathToRoot

Type: string
Required: No
Description: Relationship of the path from this data object to the root object in the hierarchy.

relatedObjectRole

Type: RelatedOnboardingDataObjRole (enumeration of type string)
Required: No
Description: Specifies the type of relationship between this record and related onboarding data object record. Valid values are Parent and Child.

relatedOnboardingDataObjRecord

Type: string
Required: No
Description: Reference to a related onboarding data object record.

targetObjectRelationshipField

Type: string
Required: No
Description: API name of the target object’s field that links this record to the related onboarding data object record.

OnboardingDataObjectField Type

Represents a field within an onboarding data object group. For example, Email Address of Party Profile is a field in the Customer Information group.

Fields

name

Type: string
Required: Yes
Description: Required. API name of the field on the target object.

OnboardingDataObjGrpVer Type

Represents a version of an onboarding data object group, containing computation settings and the related data objects.

Fields

computationSource

Type: string
Required: No
Description: Unique name of the component that contains the computation logic to determine the group’s validity, such as a Flow ID or ExpressionSet ID.

computationType

Type: OnboardingDataObjGrpCompType (enumeration of type string)
Required: No
Description: Specifies the type of computation that’s used for validity calculations of the onboarding data object group version.
Possible values:
- Formula
- StandardMinimumValidity

objectDetail

Type: OnboardingDataObject[]
Required: No
Description: Details of the data objects within this version.

onbrdDataObjGrpDocCatgMap

Type: OnbrdDataObjGrpDocCatgMap[]
Required: No
Description: Junction object that maps onboarding data category version, document type, and document category.

status

Type: OnboardingDataObjVerGrpStatus (enumeration of type string)
Required: Yes
Description: Required. Status of the onboarding data object group version.
Possible values:
- Active
- Inactive

OnbrdDataObjGrpDocCatgMap Type

Represents a configuration that maps a document type and a document category to a specific onboarding data object group version.

Fields

documentCategory

Type: string
Required: No
Description: Required. Category that’s used to group the document checklist items.

documentType

Type: string
Required: No
Description: Type of file that’s uploaded or attached in the document checklist item.

Declarative Metadata Sample Definition

The following is an example of an OnboardingDataObjectGroup component where usageType is ValidityPeriod.

1<?xml version="1.0" encoding="UTF-8"?>
2<OnboardingDataObjectGroup xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>description text</description>
4    <masterLabel>Field Group Valid Configuration</masterLabel>
5    <usageType>ValidityPeriod</usageType>
6    <versionDetail>
7        <computationType>StandardMinimumValidity</computationType>
8        <objectDetail>
9            <businessContext>KYC_VALIDITY</businessContext>
10            <fieldDetail>
11                <name>Status</name>
12            </fieldDetail>
13            <name>PartyFinancialAssetLien</name>
14            <pathToRoot>PartyFinancialAsset.PartyProfile.Id</pathToRoot>
15            <relatedObjectRole>Parent</relatedObjectRole>
16            <targetObjectRelationshipField>PartyFinancialAsset</targetObjectRelationshipField>
17        </objectDetail>
18        <objectDetail>
19            <businessContext>KYC_VALIDITY</businessContext>
20            <fieldDetail>
21                <name>ValuationAmount</name>
22            </fieldDetail>
23            <fieldDetail>
24                <name>VerificationStatus</name>
25            </fieldDetail>
26            <name>PartyFinancialAsset</name>
27            <pathToRoot>PartyProfile.Id</pathToRoot>
28            <relatedObjectRole>Parent</relatedObjectRole>
29            <targetObjectRelationshipField>PartyProfile</targetObjectRelationshipField>
30        </objectDetail>
31        <objectDetail>
32            <businessContext>KYC_VALIDITY</businessContext>
33            <fieldDetail>
34                <name>IncomeAmount</name>
35            </fieldDetail>
36            <name>PartyIncome</name>
37            <pathToRoot>Party.Id</pathToRoot>
38            <relatedObjectRole>Parent</relatedObjectRole>
39            <targetObjectRelationshipField>Party</targetObjectRelationshipField>
40        </objectDetail>
41        <objectDetail>
42            <businessContext>KYC_VALIDITY</businessContext>
43            <fieldDetail>
44                <name>CreditScore</name>
45            </fieldDetail>
46            <fieldDetail>
47                <name>EmploymentType</name>
48            </fieldDetail>
49            <name>PartyProfile</name>
50            <pathToRoot>Id</pathToRoot>
51        </objectDetail>
52        <status>Inactive</status>
53    </versionDetail>
54</OnboardingDataObjectGroup>

This is an example of an OnboardingDataObjectGroup component where usageType is DocumentValidation.

1<?xml version="1.0" encoding="UTF-8"?>
2<OnboardingDataObjectGroup xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>description text</description>
4     <masterLabel>Application Form DVC Orig</masterLabel>
5    <usageType>DocumentValidation</usageType>
6    <versionDetail>
7        <objectDetail>
8            <businessContext>DVC</businessContext>
9            <fieldDetail>
10                <name>BureauReportedFirstName</name>
11            </fieldDetail>
12            <fieldDetail>
13                <name>Name</name>
14            </fieldDetail>
15            <fieldDetail>
16                <name>Id</name>
17            </fieldDetail>
18            <name>PartyCreditProfile</name>
19            <pathToRoot>ReferenceObject.ApplicationForm.Id</pathToRoot>
20            <relatedObjectRole>Parent</relatedObjectRole>
21            <targetObjectRelationshipField>ReferenceObject</targetObjectRelationshipField>
22        </objectDetail>
23        <objectDetail>
24            <businessContext>DVC</businessContext>
25            <fieldDetail>
26                <name>ApplicantId</name>
27            </fieldDetail>
28            <name>PartyFinancialAsset</name>
29            <pathToRoot>Applicant.ApplicationForm.Id</pathToRoot>
30            <relatedObjectRole>Parent</relatedObjectRole>
31            <targetObjectRelationshipField>Applicant</targetObjectRelationshipField>
32        </objectDetail>
33        <objectDetail>
34            <businessContext>DVC</businessContext>
35            <fieldDetail>
36                <name>Name</name>
37            </fieldDetail>
38            <fieldDetail>
39                <name>ProductId</name>
40            </fieldDetail>
41            <fieldDetail>
42                <name>RequestedAmount</name>
43            </fieldDetail>
44            <fieldDetail>
45                <name>RequestedMonthlyPayment</name>
46            </fieldDetail>
47            <fieldDetail>
48                <name>RequestedTerm</name>
49            </fieldDetail>
50            <fieldDetail>
51                <name>Stage</name>
52            </fieldDetail>
53            <fieldDetail>
54                <name>SystemModstamp</name>
55            </fieldDetail>
56            <fieldDetail>
57                <name>TotalBrandOwnedItemAmt</name>
58            </fieldDetail>
59            <fieldDetail>
60                <name>TotalVendorOwnedItemAmt</name>
61            </fieldDetail>
62            <name>ApplicationFormProduct</name>
63            <pathToRoot>ApplicationForm.Id</pathToRoot>
64            <relatedObjectRole>Parent</relatedObjectRole>
65            <targetObjectRelationshipField>ApplicationForm</targetObjectRelationshipField>
66        </objectDetail>
67        <objectDetail>
68            <businessContext>DVC</businessContext>
69            <fieldDetail>
70                <name>Name</name>
71            </fieldDetail>
72            <name>ApplicationForm</name>
73            <pathToRoot>Id</pathToRoot>
74        </objectDetail>
75        <objectDetail>
76            <businessContext>DVC</businessContext>
77            <fieldDetail>
78                <name>FirstName</name>
79            </fieldDetail>
80            <fieldDetail>
81                <name>LastName</name>
82            </fieldDetail>
83            <fieldDetail>
84                <name>Name</name>
85            </fieldDetail>
86            <name>Applicant</name>
87            <pathToRoot>ApplicationForm.Id</pathToRoot>
88            <relatedObjectRole>Parent</relatedObjectRole>
89            <targetObjectRelationshipField>ApplicationForm</targetObjectRelationshipField>
90        </objectDetail>
91        <objectDetail>
92            <businessContext>DVC</businessContext>
93            <fieldDetail>
94                <name>AccountId</name>
95            </fieldDetail>
96            <fieldDetail>
97                <name>ApplicantId</name>
98            </fieldDetail>
99            <fieldDetail>
100                <name>ApplicationFormId</name>
101            </fieldDetail>
102            <fieldDetail>
103                <name>InterestRate</name>
104            </fieldDetail>
105            <fieldDetail>
106                <name>LastReferencedDate</name>
107            </fieldDetail>
108            <fieldDetail>
109                <name>LastViewedDate</name>
110            </fieldDetail>
111            <fieldDetail>
112                <name>Lender</name>
113            </fieldDetail>
114            <fieldDetail>
115                <name>Name</name>
116            </fieldDetail>
117            <fieldDetail>
118                <name>ShareType</name>
119            </fieldDetail>
120            <fieldDetail>
121                <name>SourceSystemIdentifier</name>
122            </fieldDetail>
123            <name>PartyFinancialLiability</name>
124            <pathToRoot>ApplicationForm.Id</pathToRoot>
125            <relatedObjectRole>Parent</relatedObjectRole>
126            <targetObjectRelationshipField>ApplicationForm</targetObjectRelationshipField>
127        </objectDetail>
128        <onbrdDataObjGrpDocCatgMap>
129            <documentCategory>Id_Proof</documentCategory>
130            <documentType>Aadhaar</documentType>
131        </onbrdDataObjGrpDocCatgMap>
132        <onbrdDataObjGrpDocCatgMap>
133            <documentCategory>Address_Proof</documentCategory>
134            <documentType>Passport</documentType>
135        </onbrdDataObjGrpDocCatgMap>
136        <onbrdDataObjGrpDocCatgMap>
137            <documentCategory>Id_Proof</documentCategory>
138            <documentType>Passport</documentType>
139        </onbrdDataObjGrpDocCatgMap>
140        <onbrdDataObjGrpDocCatgMap>
141            <documentCategory>Id_Proof</documentCategory>
142            <documentType>Pan_Card</documentType>
143        </onbrdDataObjGrpDocCatgMap>
144        <status>Inactive</status>
145    </versionDetail>
146</OnboardingDataObjectGroup>

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>OnboardingDataObjectGroup</name>
6    </types>
7    <version>66.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.

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!