Creating Custom Matching Keys (Managed Package)

For the managed package runtime, Vlocity Matching Keys are a custom metadata type in Salesforce. Vlocity matching keys contain seven fields

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Create these keys if you want to support connections between SObject Id fields that are not already supported by data packs, or if you would like to change the Vlocity Default for any SObject. Matching Keys created outside the Managed Package always override those contained inside (Post Vlocity v15).

For Custom Settings MatchingKeyFields__c should always be Name.

This feature changes the matching key of Product2 to its ProductCode instead of using Vlocity's GlobalKey field. This feature is useful if your project has unique product codes for each Product2. As long as the same matching keys are used in each org, there are no issues with using custom matching keys. Because these are Salesforce metadata, they can be added to the version controlled project as well.

Name API Name Description
Matching Key Fields MatchingKeyFields__c Comma-Separated list of Field API Names that define Uniqueness
Vlocity Matching Key Name Name Name of the Matching Key
Label Label Label of the Matching Key
Object API Name ObjectAPIName__c Full API Name of the SObject
Matching Key Object MatchingKeyObject__c Full API Name of the SObject
Return Key Field ReturnKeyField__c Always "Id" for data packs
Composite Unique Field CompositeUniqueFieldName__c Leave empty - Reserved for future use