getComparativeEntities
- Description
- This inquiry transaction returns details of multiple parties with all child business object collections and selected party associations aligned based on business keys. It can be used in both physical MDM and hybrid MDM implementations.
- Web Services
- Operation name: getComparativeEntities
- Example
- A member of a Data Governance team would like to preview and compare a deleted party with active parties before deciding to move supplemental attributes from the deleted party to the active parties.
- Usage information
You can use this to preview and compare two or more parties and party associations based on the business keys of the MDM business objects. It orders, and therefore allows for the alignment of, all the child object collections and selected party associations across the parties by ensuring that the child objects with the same business keys appear at the same index for each party. If one party does not have such a child object to match the business keys of the other parties, an empty child object is created to make sure all child objects are aligned properly across different parties.
- Preconditions
- Hybrid MDM mode must be enabled if comparing entities in hybrid MDM.
- Mandatory input
- Two ComparativeEntityBObj instances, each wrapped with a party
- Each party can be specified in one of four ways:
- PartyId: Retrieve the party by using the specified partyId.
- AdminSystemType and AdminPartyId: Retrieve the party by the external administrative system party identifier.
- EntityType and EntityId: Retrieve the party by the configured composite view of the party in hybrid MDM.
- Pre-populated: With this option, the party data are pre-populated in the request.
- Inquiry levels
- Optional. The Inquiry Level is set to 4 by default if a value is not provided. For details, see the getParty, getPartyByAdminSyskey, and getPartyByEntityId transactions.
- Filter values
- Not applicable
- Transaction behavior
- This transaction retrieves parties using internal transactions
(either getParty, getPartyByAdminSysKey, or getPartyByEntityId) at
the MDM component level. It then compares and aligns party child objects.
If ComparePartyAssociationsIndicator is set to
Y
ory
, the selected party associations are retrieved for comparison and alignment as well. - Request message
<TCRMTxType> getComparativeEntities
<TCRMTxObject> ComparativeEntityListBObj
<TCRMObject> ComparativeEntityListBObj
- Response objects
- ComparativeEntityBObj
- Special note
- Not applicable