Messages from Duplicate Detect

The Duplicate Detect engine returns dupResponse and dupReviewed messages. The dupResponse message is sent when the Duplicate Detect engine completes initial processing for a group of items. The dupReviewed message is sent when all items for a unit of work have been reviewed by an operator. Both messages have the same XML structure.

A unit of work may be divided into several smaller groups of items. The Duplicate Detect API splits the unit of work into smaller groups to improve processing time when the Duplicate Detect engine has multiple listeners. In addition, the Duplicate Detect engine can be configured to reply with smaller groups of items. The Duplicate Detect engine sends a dupResponse message for each group of items within the unit of work.

To configure the group size used by the Duplicate Detect engine, use the izh.dupengine.items.per.msg property. It defines the number of items that are sent in each response message from the Duplicate Detect engine. The default value of -1 indicates that a single response message will be sent for a unit of work. For information about using the configure system properties page, see Configure System Properties.

The dupResponse message contains a record element for each item in the unit of work that is a duplicate or potential duplicate. When review is disabled for the namespace, the status attribute for the record element is set to dup. If it is enabled, the item requires a final decision from a review operator and the status attribute is set to potential.

When review is enabled, the dupReviewed message is sent after all items for a unit of work have been reviewed by an operator. It contains a record element for each item in the unit of work that was a potential duplicate. If the operator decided the item is a duplicate, the status attribute for the record element is set to dup. Non-duplicate items have a status attribute of nodup.

The Duplicate Detect engine indicates that all items for a unit of work have been processed or reviewed by setting the complete flag in the last dupResponse or dupReviewed message sent for that unit of work.

The following is an example of the XML structure for the dupResponse and dupReviewed messages:

<?xml version="1.0" encoding="UTF-8"?>
<duplicateCheck xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="DupDetect.xsd">
<totals>
   <totalItems>500</totalItems>
   <itemsProcessed>100</itemsProcessed>
   <potentialDups>4</potentialDups>
   <reviewItems>0</reveiwItems>
   <failedItems>0</failedItems>
   <filteredItems>0</filteredItems>
</totals>
<records>
   <record status="dup">
      <fields>
         <field name="ACCOUNT">1234567890</field>
         <field name="ROUTING_TRANSIT">0987654321</field>
         <field name="AMOUNT">145709</field>
         <field name="AUX_ONUS">1111-2222</field>
         <field name="SOURCE">X937</field>
         <field name="PROCESS_CONTROL"></field>
         <field name="FIELD_4"></field>
         <field name="EXT_PROC_CODE"> </field>
         <field name="PAYMENT_ID">987654321</field>
      </fields>
      <errorText>error message</errorText>
   </record>
   <record status="nodup">
      <fields>
         <field name="ACCOUNT">1234567891</field>
         <field name="ROUTING_TRANSIT">0987654322</field>
         <field name="AMOUNT">500000</field>
         <field name="AUX_ONUS">3333-444</field>
         <field name="SOURCE">X937</field>
         <field name="PROCESS_CONTROL"></field>
         <field name="FIELD_4"></field>
         <field name="EXT_PROC_CODE"> </field>
         <field name="PAYMENT_ID">987654322</field>
      </fields>
      <errorText>error message</errorText>
   </record>
</records>
</duplicateCheck>

The totals element contains the following additional elements to help determine the overall status of the request.

totalItems: Total number of items in the unit of work.
itemsProcessed: Number of items processed in this group of items.
potentialDups: Number of items in the group found to be duplicates or potential duplicates.
reviewItems: Number of items in the unit of work awaiting operator review.
Note: This element only used when it is a dupResponse message and review is enabled for the namespace.
failedItems: Number of failed items in this group of items. Each failed item has a corresponding errorText element that describes the cause of the error.
filteredItems: Number of items filtered by the exclusion criteria in the Duplicate Detect engine.