1. Customer Hub (UCM) Master Data Management Reference
  2. Configuring Oracle Customer Hub (UCM) to Send User Keys for Child Records to an External Rules Engine

Configuring Oracle Customer Hub (UCM) to Send User Keys for Child Records to an External Rules Engine

If you use an external rules engine for rules evaluation, then you can optionally configure Oracle Customer Hub (UCM) to include user key information in each of the child records that are sent to the rules engine. Providing this information can help the rules engine to match child records.

The user key information is sent in the <UserKey> property in the child records. Because Oracle Customer Hub (UCM) cannot determine which user key an external rules engine uses, all of the user keys are sent. The format of the <UserKey> property is as follows:

<UserKey>UserKey1:FieldValue1FieldValue2…FieldValuen;UserKey2:FieldValue1FieldValue2…FieldValuen;…UserKeyn:FieldValue1FieldValue2…FieldValuen</UserKey>

where:

  • FieldValue1 is the value in the first field in the user key, FieldValue2 is the value in the second field in the user key, and so on.

  • FieldValuen is the value in the last field in the user key.

  • UserKeyn is the last user key for the record.

As an example, the user keys for the Alternate Phone object are as follows:

  • UserKey1: Alternate Phone Id

  • UserKey2: Alternate Phone Integration Id

  • UserKey3: Alternate Phone # + Alternate Phone Name

    Note: Alternate Phone Name is Address + Name.

If you configure Oracle Customer Hub (UCM) to include user key information in each of the child records, then the following is an example of the output for a contact record that has three alternate phone child records.

<ListOfContact>
  <Contact>
    <Id>88-1VW1ZN</Id>
      <FirstName>Jane</FirstName>
      <LastName>Lee</LastName>
      <EmailAddress>jane.lee@exampleco.com</EmailAddress>
      <WorkPhone>6035550185</WorkPhone>
      <ListOfAlternatePhone>
        <AlternatePhone>
          <UserKey>UserKey1:88-1VW3UE;UserKey2:;UserKey3:3333333333From SAP01</UserKey>
          <UseType>Home</UseType>
          <Id>88-1VW3UE</Id>
          <Address>3333333333</Address>
          <Name>From SAP01</Name>
        </AlternatePhone>
        <AlternatePhone>
          <UserKey>UserKey1:;UserKey2:;UserKey3:2222222222From Siebel01</UserKey>
          <UseType>Personal</UseType>
          <Id>Dummy1</Id>
          <Address>2222222222</Address>
          <Name>From Siebel01</Name>
        </AlternatePhone>
        <AlternatePhone>
          <UserKey>UserKey1:88-1VW3UF;UserKey2:;UserKey3:1111111111From Siebel02</UserKey>
          <UseType>Business</UseType>
          <Id>88-1VW3UF</Id>
          <Address>1111111111</Address>
          <Name>From Siebel02</Name>
        </AlternatePhone>
      </ListOfAlternatePhone>
    </Contact>
</ListOfContact>

The following procedure describes how to configure Oracle Customer Hub (UCM) to send user key information in child records.

To configure Oracle Customer Hub (UCM) to send user keys for child records to an external rules engine

  • In the UCM Survivorship Engine business service, add a new user property, Enable Sending User Key Field to External Business Service, with the value set to True.