Entity Resolution for Entity and Reference Objects

Overview

The following include files contain important elements around the code to implement the Entity resolution logic:

/eagle_default/in/xml/include/entity_xref_resolution.inc

Entity Id can be determined by Entity Xreference Identifiers: sets of elements Xref Account Id + Xref Account Id Type. The Class Code element can also be specified.

The maximum amount of identifiers is 20.

Entity Identifiers can be found in the ‘Entity Common Id Model’ XSD Group. Refer to the Entity Common Id Model mapping for more details.

An example of Entity Xreference Identifiers in the incoming message:

<entityXrefs>
    <entityXref>
        <xrefAccountId>XREF_ID1</xrefAccountId>
        <xrefAccountIdType>XREF_TYPE1</xrefAccountIdType>
        <xrefClassCode>TF1</xrefClassCode>
    </entityXref>
    <entityXref>
        <xrefAccountId>XREF_ID2</xrefAccountId>
        <xrefAccountIdType>XREF_TYPE2</xrefAccountIdType>
        <xrefClassCode>TF2</xrefClassCode>
    </entityXref>
    <entityXref>
        <xrefAccountId>XREF_ID3</xrefAccountId>
        <xrefAccountIdType>XREF_TYPE3</xrefAccountIdType>
        <xrefClassCode>TF3</xrefClassCode>
    </entityXref>
</entityXrefs>
<entityResolutionOption>MATCH_ALL</entityResolutionOption>
<entityBattingOrder>XREF_TYPE2,XREF_TYPE3,XREF_TYPE1</entityBattingOrder>

The Entity Xref element contains every Entity Identifier. The Entity Xrefs element contains all Entity Xref elements.

The Entity Id is defined by entity xreference identifiers used the RULESDBO.ENTITY_XREFERENCE DB table.

Parameters For Entity Resolution

The resolution of Entity is controlled by two parameters:

Entity Batting Order
Entity Resolution Option.

Entity Resolution Option

Entity Resolution Option can contain following values:

MATCH_ALL
Find 1st Match

If this value does not equal MATCH_ALL or is not specified , then Find 1st Match mode is used.

If the Find 1^st Match option is set, the Entity Id will be calculated by the first specified in Batting Order identifier. If the Batting Order is null, the first entity identifier in incoming message will be used.

MATCH_ALL mode implements logic when the entity resolved by the matching of ALL identifiers. If at least one identifier is not defined the entity id, the stream will return the following error: 'MATCH_ALL mode: failed. List of XREF Entity identifiers does not match for option MATCH_ALL

Entity Batting Order

The Entity Batting Order determines which entity xreference identifiers are used in the security resolution and their order for matching.

Note

If the entity batting order is not specified in incoming message, by default the order of entity identifier will be the same as in the incoming message.

Examples of SQL query if the Batting Order is specified.

OCI:

select 
 x.entity_id as ENTITY_ID, 
 x.xref_account_id, 
 x.xref_account_id_type,
 case 
 when x.xref_account_id_type = 'XREF_TYPE2' then 1
 when x.xref_account_id_type = 'XREF_TYPE3' then 2
 when x.xref_account_id_type = 'XREF_TYPE1' then 3
 else 1000
 end as ORD 
from RULESDBO.ENTITY_XREFERENCE x 
where 
  ( ( x.xref_account_id = 'XREF_ID1' and x.xref_account_id_type = 'XREF_TYPE1') or
    ( x.xref_account_id = 'XREF_ID2' and x.xref_account_id_type = 'XREF_TYPE2') or
    ( x.xref_account_id = 'XREF_ID3' and x.xref_account_id_type = 'XREF_TYPE3') ) 
order by ord

OLEDB:

select 
 x.entity_id as ENTITY_ID, 
 x.xref_account_id, 
 x.xref_account_id_type,
 case 
 when x.xref_account_id_type = 'XREF_TYPE2' then 1
 when x.xref_account_id_type = 'XREF_TYPE3' then 2
 when x.xref_account_id_type = 'XREF_TYPE1' then 3
 else 1000
 end as ORD 
from RULES.DBO.ENTITY_XREFERENCE x 
where 
  ( ( x.xref_account_id = 'XREF_ID1' and x.xref_account_id_type = 'XREF_TYPE1') or
    ( x.xref_account_id = 'XREF_ID2' and x.xref_account_id_type = 'XREF_TYPE2') or
    ( x.xref_account_id = 'XREF_ID3' and x.xref_account_id_type = 'XREF_TYPE3') ) 
order by ord