VerifiedImport Schema
Message Structure
VerifiedImport Event uses the following schema.
//Sample Event
{
"eventType": "externaldata",
"eventSubtype": "verifiedimport",
"correlationId": "{{$guid}}",
"source": "MDM",
"priority": 1, //Optional. Controls the queue and processing lane used for this event.
// 1 or less: Bulk queue, processed one at a time for the tenant.
// 2 or more: Normal queue. With parallel processing enabled, events with the
// same priority value are processed in order on the same lane.
// If not specified: events with 20 or fewer entities and a payload of 40 KB or
// less go to the Normal queue (in parallel when enabled); larger events go to
// the Bulk queue. See "Queues and Parallel Processing" in the DataImport Overview.
"payload": {
"eventIdentifier": "MDMImport-Verified",
"integration": "MDM Updates",
"eventConfig": {
"entityProcessingRules": {
//List the Policy Categories to identify the incoming fields (DataKeys and DataGroups)
"categories": [
"Basic Details"
],
"lookupsMapping": [
//By default incoming values will be validated against the Reference List 'Value' column
//Configure the lookup below to specify a different column to use for mapping (e.g. Id, or custom column)
//This configuration is applied to all fields that use the same lookup
{
"lookupName": "Country",
"columnName": "MDMSystem"
}
],
"waitForSearchPropagation": true, //Optional. Verifies newly created entities have finished updating
// Entity Search datastore before completing processing.
"validationProfile": "forceSave" //Optional. Applies a named set of validation rules to this request.
// Alphanumeric, max 64 characters. See Validation Profiles.
},
"importBehaviors": {
"failOnOpenJourneys": false //Optional
}
},
"entities": [
{
//Entity Id or EntityResolver must be specified
//"id": "{{$guid}}",
"entityResolver": {
"externalDataKey": "externalId",
"externalSystemId": "jh_20250226_1_2"
},
"entityType": "Company", //Required
"targetEntity": "Client", //Required. Used in Policy calls
"isClient": true, //Optional. Will add the IsClient chip to entity
"singleProperties": {
"legalEntityName": "Create_1_2",
"externalId": "jh_20250226_1_2",
"category": "Corporation",
"companyType": "Private Company",
"countryOfIncorporation": "CAN",
"dateOfIncorporation": "2012-07-11",
"state": "Alabama"
},
"collectionProperties": {
"addresses": {
"mergeStrategy": "replace",
"records": [
{
"type": "Registered|Mailing",
"addressLine1": "1 FREDERICK ST",
"addressLine2": "15D",
"country": "CAN"
}
]
}
}
}
//, { .. }
]
}
}
Processed Message Structure
The processed message is produced after the import logic has been executed. It contains the status of the overall import as well as the result of importing individual entities.
The structure of the processed message is intended for human-readable investigations, debugging, and audit purposes only. It may evolve over time and is not guaranteed to be backward-compatible. Therefore, it should not be used for service-to-service integration or automated processing.
{
"eventId": "5f934de0-0538-4c95-9a3e-14a72d05e2a0",
"messageImportStatus": "Success",
"eventIdentifier": "MDMImport-Verified",
"integration": "MDM Updates",
"integrationStatus": "Processed",
"eventConfig": {
"entityProcessingRules": {
"categories": [
"Basic Details"
],
"lookupsMapping": [
{
"lookupName": "Country",
"columnName": "MDMSystem"
}
]
}
},
"entities": [
{
"entityId": "c45c27e6-5ae2-4ec3-9c3c-5e2442c5dcf1",
"entityImportStatus": "Success",
"entityResolver": {
"externalDataKey": "externalId",
"externalSystemId": "jh_20250226_1_2"
},
"entityType": "Company",
"targetEntity": "Client",
"singleProperties": {
"legalEntityName": "Create_1_2",
"externalId": "jh_20250226_1_2",
"category": "Corporation",
"companyType": "Private Company",
"countryOfIncorporation": "CAN",
"dateOfIncorporation": "2012-07-11",
"state": "Alabama"
},
"collectionProperties": {
"addresses": {
"mergeStrategy": "replace",
"records": [
{
"type": "Registered|Mailing",
"addressLine1": "1 FREDERICK ST",
"addressLine2": "15D",
"country": "CAN"
}
]
}
},
"issues": {
"error": null,
"warnings": []
},
"validationResult": {
// Properties validation results
}
}
]
}
Products Schema
Products are nested under an Entity in the products array. When products are sent, eventConfig.productProcessingRules.categories must list the Product Policy categories used to map the incoming Product datakeys and Data Groups. See Products for resolution, mapping and error handling rules.
| Field | Required | Description |
|---|---|---|
id | id or productResolver | Fen-X Product Id. Must match an existing Product related to the entity. |
productResolver | id or productResolver | externalDataKey/externalSystemId used to find an existing Product related to the entity. If no match is found, a new Product is created. |
type | Yes | Product Type (productType datakey). |
family | Yes | Product Family (productFamily datakey). |
singleProperties | No | Product datakeys and values. |
collectionProperties | No | Product Data Groups. Each key is a Data Group field with a list of records. |
{
"eventType": "externaldata",
"eventSubtype": "verifiedimport",
"correlationId": "{{$guid}}",
"source": "MDM",
"payload": {
"eventIdentifier": "MDMImport-Verified",
"integration": "MDM Updates",
"eventConfig": {
"entityProcessingRules": {
"categories": ["Basic Details"],
"validationProfile": "forceSave" //Optional. Applied to the entities and their Products
},
"productProcessingRules": {
//List the Product Policy Categories used to identify incoming Product fields (DataKeys and DataGroups)
"categories": ["Basic Details", "Comments"]
}
},
"entities": [
{
"entityResolver": {
"externalDataKey": "externalId",
"externalSystemId": "jh_20250226_1_2"
},
"entityType": "Company",
"targetEntity": "Client",
"singleProperties": {
"legalEntityName": "Create_1_2",
"companyType": "Private Company",
"countryOfIncorporation": "CAN"
},
"products": [
{
//Product Id or productResolver must be provided
//"id": "{{$guid}}", //Updates an existing Product related to the entity
"productResolver": { //Updates the matching Product, or creates a new one if no match is found
"externalDataKey": "externalId",
"externalSystemId": "PROD_20250226_1"
},
"type": "Cash Management", //Required. Value from the Product Type reference list
"family": "Banking Services", //Required. Value from the Product Family reference list
"singleProperties": {
"externalId": "PROD_20250226_1",
"productName": "Sample Product"
},
"collectionProperties": {
//Data Group fields from the Product requirement set
"comments": {
"mergeStrategy": "replace",
"records": [
{ "comment": "Imported from MDM" },
{ "comment": "Annual review completed" }
]
}
}
}
//, { .. }
]
}
]
}
}
Products Processed Message Structure
Each entity in the processed message includes a products array reporting the outcome of each Product's migration.
{
"entities": [
{
"entityId": "c45c27e6-5ae2-4ec3-9c3c-5e2442c5dcf1",
"entityImportStatus": "Success",
// ...entity fields as above
"products": [
{
"productId": "8b1e6a2a-4d3f-4c2a-9a9e-1a2b3c4d5e6f",
"productImportStatus": "Success",
"productResolver": {
"externalDataKey": "externalId",
"externalSystemId": "PROD_20250226_1"
},
"type": "Cash Management",
"family": "Banking Services",
"singleProperties": {
"externalId": "PROD_20250226_1",
"productName": "Sample Product"
},
"collectionProperties": {
"comments": {
"mergeStrategy": "replace",
"records": [
{ "comment": "Imported from MDM" },
{ "comment": "Annual review completed" }
]
}
},
"issues": {
"error": null, //Error message if the Product failed, e.g. "Error migrating product: <datakey>: Field must be completed."
"warnings": []
}
}
]
}
]
}