Data Quality Guide for Oracle Customer Hub > Universal Connector API >

External Key Generation Function


This function allows you to enable third party vendors to generate deduplication keys in Siebel CRM. This topic describes the functions that set parameters for external deduplication key.

sdq_get_dedup_keys Function

This function allows you to invoke a third party vendor to generate the deduplication keys.

NOTE:  To support Multiple Child Entities Deduplication, you must use the data format shown in Data Format for Deduplication of Multiple Child Entities.

Syntax

int sdq_get_dedup_keys (int session_id,

SSchar* parameterList,
SSchar* inputRecordSet,
SSchar* outputRecordSet)

Parameters
  • session_id: The session ID obtained by initializing the session.
 
  • parameterList: An XML character string contains the list of parameters and values that are specific to this function call. An XML example follows:

    <Data>
    <Parameter>
    <Name>KeyGenerationParam1</Name>
    <Value>KeyGenerationValue1</Value>
    </Parameter>

    <Parameter>
    <Name>KeyGenerationParam2</Name>
    <Value>KeyGenerationValue2</Value>
    </Parameter>
    </Data>

NOTE:  The parameterList can be set to NULL if all required parameters are already set at the session level.

 
  • inputRecordSet: An XML character string containing the driver record. An XML example follows:

    <Data>
    <DriverRecord>
    <Account.Id>1-X42</Account.Id>
    <<Name>Siebel</Name>
    <Location>Headquarters</Location>
    <DriverRecord>
    <Data>

NOTE:  The Id field can be empty. An example is an incoming record without an assigned ID value.

Here is an example of the XML in hierarchical data format (to support multiple child entities deduplication):

<Data>
<DriverRecord>
<Account.Id>12-ABCC</Account.Id>
<Name>Hibbing Manufacturing</Name>
<Location>San Jose</Location>
<ListOfCUTAddress>
<CUTAddress>
<City>York1</City>
<Country>USA</Country>
<Zip>78201</Zip>
<State>AL</State>
<Street> 1200 Davisville Road</Street
</CUTAddress>
<CUTAddress>
<City>York2</City>
<Country>USA</Country>
<Zip>78202</Zip>
<State>AL</State>
<Street> 1201 Davisville Road</Street
</CUTAddress>
</ListOfCUTAddress>
</DriverRecord>
</Data>

 
  • outputRecordSet: An XML character string populated by the vendor that contains the dedup keys generated for the driver record. An XML example follows:

    <Data>
    <KeyRecord>
    <Account.Id>SAME ID AS DRIVER</Account.Id>
    <KeyValue>Key1</KeyValue>
    </KeyRecord>
    <KeyRecord>
    <Account.Id> SAME ID AS DRIVER </Account.Id>
    <KeyValue>Key2</KeyValue>
    </KeyRecord>
    <KeyRecord>
    <Account.Id> SAME ID AS DRIVER </Account.Id>
    <KeyValue>Key3</KeyValue>
    </KeyRecord>
    </Data>

Return Value

A return value of 0 indicates successful execution. Any other value is a vendor error code. The error message details from the vendor are obtained by calling the sdq_get_error_message function.

Data Quality Guide for Oracle Customer Hub Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.