Configuring UBX for the integration

This task involves using UBX to configure event producer endpoints and subscribe Campaign to events. This task is required to support response tracking from IBM Engage to HCL Campaign.

Before you begin

Before you begin:

  • IBM Provisioning must complete all required provisioning tasks.
  • IBM UBX Toolkit must be installed and configured.
  • You must know the Engage organization refresh token and pod name. Contact your Engage Org Admin if you are not sure.

About this task

There are two main types of endpoints: Producers (applications that produce events) and destinations (applications that consume those events). Engage is an event producer. Campaign is an event consumer or subscriber. By completing this task, you ensure that UBX can process customer response events, such as clicks and bounces, for communication back to Campaign (via UBX Toolkit).

The response event data will be stored in response tracking tables. Creating the response tracking tables is a separate configuration step.

Procedure

  1. If you are using email or SMS text messaging, use UBX to register Engage as an event producer endpoint:
    1. On the Endpoints tab in UBX, click Register new endpoint.
    2. Select Engage as an event producer endpoint and click Next.
    3. Follow the on-screen instructions to complete the registration.

    For more information, read about UBX endpoint registration at http://www.ibm.com/support/knowledgecenter/SS9JVY/UBX/Endpoints_ubx/Endpoint_registration_ch.dita.

  2. If you are using mobile app messaging (push), use UBX to register IBM Mobile Customer Engagement (Xtify) as an event producer endpoint:
    1. On the Endpoints tab in UBX, click Register new endpoint.
    2. Select IBM Mobile Customer Engagement as an event producer endpoint and click Next.
    3. Follow the on-screen instructions to complete the registration.

    For more information, read about UBX endpoint registration at http://www.ibm.com/support/knowledgecenter/SS9JVY/UBX/Endpoints_ubx/Endpoint_registration_ch.dita.

  3. If you are capturing email, PUSH, or SMS responses, use UBX to subscribe Campaign to email, PUSH, and SMS events:
    1. On the Events tab in UBX, click Subscribe to events.
    2. In the Select events column, select IBM Engage and select all available email, PUSH, and SMS events.
    3. In the Select destinations column, select HCL Campaign as the event destination.
    4. Click Subscribe.

    For more information about event publication and subscription, see http://www.ibm.com/support/knowledgecenter/SS9JVY/UBX/Events_ubx/Event_sharing.html.

  4. From IBM Engage version 16.4 onwards, mobile PUSH events are published by Endpoint. If you have previously configured the Campaign-Engage integration, you must complete the following steps on the Events tab in UBX:
    1. Subscribe to all the Mobile PUSH Events that are published by IBM Engage in Endpoint.
    2. Unsubscribe all the Mobile PUSH Events that are published by IBM Mobile Customer Engagement in Endpoint.
      Note: If the Events are not unsubscribed, then all the Events that are generated by IBM Mobile Customer Engagement are populated into the UA_Gen_Event_Record table of Campaign.

What to do next

Confirm that you have completed all of the configuration steps in Configuring the Campaign and Engage integration.