A map messages identifier mapping maps looks up an id in the internal idmap database and replaces the value with the reference value found in that database.

The idmap database contains endpoint-id pairs that define the endpoint and id of a message. These pairs are associated with other endpoint-id pairs in the database maintaining a relationship between two messages from disparate systems.

Attribute

Required

Description

from

Y

Defines the field name before mapping.

to

Y

Defines the field name after mapping.

precedence

N

Defines the precedence used when mapping.

Function typeYDefines the function type of the mapping. Needs to be "Enrichment/lookup functions"

Function

Y

Defines the type of mapping. Needs to be "Map message identifier".


In this example, an incoming message with an incident/id field needs to be mapped to its partner id and stored in payload/events_data_id.



To define the fields in the idmap database the mapper in the listener plugin needs to map the endpoint id to 1GatewayHeader/origin/endpoint and the mesage id to 1GatewayHeader/origin/id and add the option 1GatewayHeader/option/idmap = true.  Some plugins have this functionality built-in.

An example of a mapper with an idmapping: