Using the Unica Interact Inbound Gateway for IBM Universal Behavior Exchange

1. Use the REST API client to post the requests to UBX.
2. Register an endpoint in UBX with JSON. See the following example.

   Method Call: PUT
   URL: https://ubx-qa1-api.adm01.com/v1/endpoint
   Headers: Content-Type: application/json
   Accept-Charset: UTF-8
   Authorization: Bearer 912586bf-190d-48f9-8488-26f1bf532ef3
   (Note: This is the Auth Key generated from the UBX UI.)
   Body
   {
   "name":"Interactubxdk1",
   "description":"Interactubxdk1",
   "providerName":"IBM", "
   "url":"http://Host:port/ubxEndPoint/UBXEndPoint",
   "endpointTypes":{
   "event":{
   "source":{
   "enabled":true
   },
   "destination":{
   "enabled":true,
   "url":"http://Host:port/ubxEndPoint/UBXEndPoint",
   "destinationType":"push"
   }
   }
   },
   "marketingDatabasesDefinition":{
   "marketingDatabases":[
   {
   "name":"IDSync",
   "identifiers":[
   {
   "name":"interactprofileid",
   "type":"INTERACTID"
   }
   ]
   }
   ]
   }}
   

3. Register an eventtype in UBX with JSON. See the following example.

   Event Registration for Interact Event in UBX
   Method Call: POST
   URL: https://ubx-qa1-api.adm01.com/v1/eventtype
   Headers:
   Content-Type: application/json
   Accept-Charset: UTF-8
   Authorization: Bearer 912586bf-190d-48f9-8488-26f1bf532ef3
   Note: This is the Auth Key generated from the UBX UI.)
   Bearer 912586bf-190d-48f9-8488-26f1bf532ef3
   Body
   {
   "name": "recommendedOffers",
   "description": "recommended offers by OMO",
   "code": "recommendedOffers"
   }
   

4. Post an event to UBX with JSON. See the following example.

   
   {
   "channel" : "mobile",
   "identifiers" : [
   {
   "name" : "interactprofileid",
   "value" : "55"
   }
   ],
   "events" : [
   {
   "code" : "recommendedOffers",
   "timestamp" : "2015-12-28T20:16:12Z"
   }
   ]
   }
   

1. In the Interact | activityOrceshtrator | receivers configuration property, add a new receiver. Set Type to Kafka or Custom. If you choose Custom, enter ClassName and ClassPath. If you choose Kafka, leave ClassPath and ClassName blank.
2. Add providerUrl, topic, authentication, group.id, and zookeeper.connect parameters for your receiver.
3. In the Interact | activityOrceshtrator | gateways configuration property, UBX category is available by default.
4. • Using properties files based mappings.
     • Create a new folder, example, Interactubx12 folder under the <Interact_Home>\conf\inbound\UBX directory and copy the properties files to this new folder. The folder name much match the name of the subscriber endpoint that you created in UBX.
     • Configure the interactEventNameMapping.properties file.

       Use this file to map the value of the payload event field that is defined in the interactEventPayloadMapping.properties file as [EventName] to the Interact event name. The interactEventNameMapping.properties file is in the <Install dir>\conf\inbound\UBX directory.{UBX event name}={Interact event name} Example: recommendedOffers=recommendedOffers

       If support for payload data from specific source is necessary, this file may also be placed in the <Install dir>\conf\inbound\UBX\{source} directory. The value for source should match the value of source field in the UniversalBehavior Exchange event payload, typically the Universal Behavior Exchange endpoint name. If support fordata using specific versions is necessary, this file may also be placed in the <Install dir>\conf\inbound\UBX\{source}\version-{version} directory. The value for version must match the value of version field in the Universal Behavior Exchange event payload.

       To support multiple Universal Behavior Exchange instance data, this file may also be placed in the <Install dir>\conf\inbound\UBX\{source}\version-{version}\account-{clientID} directory. The value for clientID must match the value of clientID in the Universal Behavior Exchange event payload

     • Configure the interactEventPayloadMapping.properties file, add your field definitions.

       Use the interactEventPayloadMapping.properties file to map the inbound field to the Interact API parameters. The interactEventPayloadMapping.properties file is in the <Install dir>\conf\inbound\UBX directory.

       Interact API parameters: The value must start with a field type definition, followed by either a static value when the value is in double quotes, or a field name from the payload data. (FIELD_TYPE)"STATIC_VALUE" or (FIELD_TYPE)PAYLOAD_FIELD_NAME. FIELD_TYPE can be either String, Numeric, or DateTime.

       For example:

       [SessionID]=(String)interactprofileid
       [EventName]=(String)code
       [AudienceIDFieldNames]=(String)"change_me"
       [AudienceIDFieldValues]=(String)interactprofileid
       [AudienceLevel]=(String)"change_me"
       [InteractChannel]=(String)"change_me"
       

       Event data: These properties are used to map the event attributes that can be used in your outbound channel communications. The left side contains the variable names you use in your outbound channel communication. The value must start with a field type definition, followed by either a static value when the value is in double quotes, or a field name from the payload data. (FIELD_TYPE)"STATIC_VALUE" or (FIELD_TYPE)PAYLOAD_FIELD_NAME. FIELD_TYPE can be either String, Numeric, or DateTime.

       If support for payload data from specific source is necessary, this file may also be placed in the <Install dir>\conf\inbound\UBX\{source} directory. The value for source should match the value of source field in the Universal Behavior Exchange event payload, typically the Universal Behavior Exchange endpoint name. If support for data using specific versions is required, this file may also be placed in the <Install dir>\conf\inbound\UBX\{source}\version-{version} directory. The value for version must match the value of version field in the Universal Behavior Exchange event payload. To support multiple Universal Behavior Exchange instance data, this file may also be placed in the <Install dir>\conf\inbound\UBX\{source}\version-{version}\account-{clientID} directory. The value for clientID should match the value of clientID in the Universal Behavior Exchange event payload.

     • Restart the Interact server.
     • Create an interactive channel and add an event to it.

   • Using UI based mappings:

     Use Generic Inbound option available under the Gateway tab on Interactive channel. Create gateway with the name 'UBX' and define the event mappings.

     It is required that the incoming request coming from UBX must contain the ICName header parameter. The mappings from the specific Interactive channel will be initialized based on this header value.

5. Perform the steps mentioned in sections C and D below.
6. Deploy the interactive channel.
7. Post an event to UBX from any publisher or to test with a REST API client.

   Example event body:

   
   {  
     "channel" : "mobile",       
     "identifiers" : [            
       {
         "name" : "interactprofileid",       
         "value" : "55"   
       }
     ],
   "events" : [
     {
       "code" : "recommendedOffers",      
       "timestamp" : "2015-12-28T20:16:12Z"
      }
     ]
   }

8. Check the Unica Interact log to see if the triggered messages event is triggered. You can use this event for further processing in patterns/triggered messaged as per your specific use case

   You can also refer the endpoint logs for more information

• UBX endpoint with Kafka
• Endpoint ubxInboundEndpoint.properties file
• Endpoint inboundTopicNameConfig.properties file
• Endpoint log4j2.xml file

topic=UBXTopic