Match events

By default, all Match events from Reltio APIs are sent to queues or topics as messages in JSON format.


Headers: tenantId; eventType; sourceObjectUri
{
	"type": <string>,
      "updatedTime": <timestamp>,
      "uris": <List<string>>
}

updateTime appears only if JMSIncludeMergeTime: true (by default, it’s false) is specified in the field in the streaming configuration. Only type ENTITIES_MERGED is supported. The updatedTime includes the timestamp when the entities were merged.

The URIs include the URIs of all merge participants.

Internally, these event types are supported:

  • ENTITIES_MERGED: This event generates a background automatic process based on match rules. An event is triggered for the winner entity.

  • ENTITIES_MERGED_MANUALLY: This event is created when we manually merge entities.

  • ENTITIES_MERGED_ON_THE_FLY: This event generates an automatic process that merges entities in real time. For more information, see topic Merge-on-the-fly.

Note: When the system sends these event types to the external queue, it always converts the type of the event into ENTITIES_MERGED in the typeFilter property in the Tenant physical configuration streamingConfig-messaging->destinations section. Therefore, even if you indicate ENTITIES_MERGED_MANUALLY, or ENTITIES_MERGED_ON_THE_FLY, the propagated event is ENTITIES_MERGED.
In addition, Reltio also supports two more event types for notifying an external program to consider taking action on the event. These two events are:
  • POTENTIAL_LINK_FOUND: This event conveys that two profiles named in the event have characteristics that suggest they’re potentially related to each other.
  • AUTO_LINK_FOUND: This event type can be used to strongly suggest that the two profiles are related to each other.

These two events can be published to the queue using your match rule. It enables your external program to receive the event, get the profiles, and further analyze the event. If the external program approves the event, then you can post a request to explicitly define a relationship between the two profiles.