Skip to main content

OnboardingDataObjectGroup

Bill Appleton

Metadata Type: OnboardingDataObjectGroup

OnboardingDataObjectGroup is a metadata type in Salesforce that represents a configuration for grouping fields from one or more objects for a specific business purpose. This metadata type allows organizations to define how critical customer data, such as contact information, financial profiles, and identity documents, should be organized and validated during onboarding processes (like Know Your Customer or document verification).

Overview

The OnboardingDataObjectGroup metadata type was introduced in API version 66.0 and is part of Salesforce's efforts to enhance onboarding and compliance capabilities, particularly within Financial Services Cloud and specialized industry clouds. It enables administrators to create custom groupings of objects and fields, define document category mappings, and set computation logic to determine the validity of the collected data. This functionality is vital for organizations that need to maintain strict compliance and generate accurate validation checks during customer acquisition.

Key Features

  • Grouping of multiple data objects and specific fields for a unified business context
  • Support for complex usage types, including Document Validation and Validity Period tracking
  • Built-in version control to manage active and inactive computation logic
  • Integration with document checklist items and compliance computation processes

Structure and Components

An OnboardingDataObjectGroup typically consists of the following components:

  • Usage Type: Specifies the primary purpose of the group, such as DocumentValidation or ValidityPeriod
  • Version Detail: Contains specific versions of the group, defining the computation settings and related data objects
  • Object Detail: Defines the target sObject (e.g., Account, PartyProfile), its required fields, and its relationship path to the root object
  • Document Category Maps: Junction configurations that tie onboarding data category versions to specific document types and categories

Deployment Considerations

When deploying OnboardingDataObjectGroup metadata, administrators should be aware of several potential issues:

1. Object and Field Dependencies

Ensure that all target objects and fields referenced in the group's objectDetail configurations exist in the destination environment. If a field or object is missing, the deployment will fail.

2. Computation Logic References

Verify that any underlying computation sources, such as specific Flow IDs or ExpressionSet IDs referenced for validity calculations, are either deployed alongside this metadata or already exist in the target org.

3. Version Statuses

Be cautious when deploying versions with an Active status. Overwriting or activating a new version in production immediately impacts how onboarding validations are calculated, which can disrupt active customer application processes.

4. Valid Data Types and Roles

Confirm that the values assigned to specific elements, such as business contexts (e.g., KYC_VALIDITY) and target object relationship fields, accurately match the expected enumerations and schema of the target org.

5. API Versioning

Because this metadata type was introduced in API version 66.0, confirm that your deployment manifests (package.xml) use a compatible API version to prevent the metadata from being ignored or failing validation.

Best Practices for Salesforce Administrators

To effectively use and manage OnboardingDataObjectGroup metadata, Salesforce administrators should follow these best practices:

1. Document Your Groupings

Maintain clear documentation of all onboarding data object groups, including their intended business context, mapped fields, and validation logic. This documentation will be invaluable for compliance audits and troubleshooting.

2. Use Descriptive Names

Choose clear and descriptive master labels for your OnboardingDataObjectGroup instances (e.g., "Customer_KYC_Validation_Group"). This will make it easier to understand their purpose at a glance as the number of configurations grows.

3. Implement Versioning Strategically

Leverage the built-in versioning capabilities. When updating a data object group to comply with new regulations, create a new version and test it thoroughly before changing its status to Active and deactivating the older version.

4. Leverage Sandboxes

Always test new or modified OnboardingDataObjectGroup configurations in a sandbox environment before deploying to production. Run sample onboarding flows to verify that document validation and computation logic function correctly.

5. Monitor Computation Logic

Regularly review the performance and accuracy of the Flows or ExpressionSets tied to your group's computation logic. Ensure they are optimized so that validation checks do not negatively impact the speed of the onboarding experience.

6. Manage Document Categories

Keep your document category mappings clean and updated. Ensure that the document types defined in the metadata (e.g., Passport, Drivers License) align precisely with the actual files your users are trained to upload.

7. Align with Compliance Teams

Work closely with your organization's legal and compliance teams to ensure that the fields grouped for KYC (Know Your Customer) or DVC (Document Validation) accurately reflect current regulatory standards and business requirements.

8. Regular Audits

Conduct periodic audits of your OnboardingDataObjectGroup configurations. Remove or deactivate any groups, fields, or versions that are no longer relevant to your current onboarding process to reduce technical debt.

9. Root Path Validation

Carefully define the pathToRoot relationships for your nested objects. Incorrectly mapped relationship paths can cause validation logic to fail when querying related records across complex data models.

10. Training and Documentation

Provide comprehensive training for front-line users and back-office staff who handle customer onboarding. Ensuring they understand what data is being validated and why it is required will improve data quality and speed up application approvals.

Conclusion

The OnboardingDataObjectGroup metadata type is a powerful tool for Salesforce administrators to customize and enforce data validation requirements during complex customer onboarding journeys. By understanding its structural components, potential deployment dependencies, and strictly adhering to best practices, administrators can leverage this feature to enhance data integrity and regulatory compliance. As with any critical business process configuration, careful planning, version management, and rigorous sandbox testing are essential to the successful implementation of OnboardingDataObjectGroup metadata.

Powered by Zendesk