Using Unica Interact Outbound Gateway for IBM Mobile Push Notification

To use this mobile push outbound or publisher gateway, you must configure Unica Interact, IBM Marketing Cloud, and the gateway.

Use the following configurations as an example for your configuration.

Configuring IBM Marketing Cloud

  1. Ensure that you have an IBM Marketing Cloud account with push access. Also make note of your Client ID, Client Secret, and Refresh Token.
  2. On the Data tab, create a new database. Add a new Mobile User ID to the database along with the default fields.
  3. On the Search tab, search by the Mobile User ID field. Hover the mouse key on first No email field. You will see the recipient ID at the bottom of browser window. Add this recipient ID to the Unica Interact profile table.

Configuring the Unica Interact Outbound Gateway for IBM Mobile Push Notification

  1. Configure the silverpopEngagePushConfig.properties file.

    For example:

    OauthServiceURL=<protocol>://<hostname>/<other_information>
    pushServiceURL=<protocol>://<hostname>/<other_information>
  2. Configure the silverpopEngagePushContentMapping.properties file.
    Note:
    If you are using UI based mappings, perform the following actions.
    1. Create a gateway with the name 'MobilePush' of type Generic Outbound in an Interactive Channel.
    2. Create the following mappings in the Mapping section.

    For example:

    Interact Profile table attributes:
    appKey=appKey
    engageRecipientId=recipientId
    mobileUserId=mobileUserId
    deviceType=deviceType
    
    Interact Offer attributes:
    simpleSubject=simpleSubjectAttr
    simpleMessage=simpleMessageAttr
    simpleActionData=simpleActionDataAttr
    simpleActionType=simpleActionTypeAttr
    simpleActionLabel=simpleActionLabelAttr
    personalizeAttributeList=personalizeAttributeList
    contentId=ContentID
    campaignId=campaignId
    

Configuring Unica Interact

  1. Create the following offer attributes.
    simpleActionDataAttr: string   
    simpleActionLabelAttr: String
    simpleActionTypeAttr: string
    simpleMessageAttr: string
    simpleSubjectAttr: string
    contentID: string
    campaignId=string
    personalizeAttributeList=string
  2. Create an offer template with the offer attributes and the following offer values.
    simpleActionDataAttr: www.ibm.com
    simpleActionLabelAttr: Open URL
    simpleActionTypeAttr: url
    simpleMessageAttr: <Enter your message text here>
    simpleSubjectAttr: <Enter subject here>
    contentID: ID of the push message template that is created in Engage.
    PersonalizeAttributeList: A comma separated list of attribute name 
    value pairs that you want to put in the personalizationDefaults 
    section of the payload to be sent to Engage.

    When you use the contentID attribute, the other simple.. attributes are ignored as the complete details are picked up from the Engage template.

    Example personalizedAttributeList
    personalizeAttributeList=discount=10,Offercost=20
    campaignId=campaignname that you want to use for this campaign.
  3. Your profile table has the following columns and values.
    appKey: gcsTQo6v79
    recipientId: 13472242  
    deviceType: android or ios
    
  4. Navigate to INTERACT_HOME/conf/gateways/outbound/common. Under the Interact folder, in the httpConnectionConfig.properties file, specify the timeout.
    For example:
    connectTimeoutMs=6000
    When OMO is configured to use a HTTP connection, a HTTP proxy can be configured optionally with authentication between Interact and the endpoint. To enable the proxy for outbound gateways, update the values of following properties.
    • proxyHost=<IP address of the proxy server>
    • proxyPort=<Listening port of the proxy server>
    • targetUsername=<username for connecting to the proxy server. leave blank if no authentication required>
    • targetPassword=<password for connecting to the proxy server. leave blank if no authentication required>
  5. Create a channel and a handler under Interact | triggeredMessage and use the [Mobile_Push] gateway that you created above in that channel. This channel is used in the triggred message to send push messages.
  6. Create an interactive channel and add a triggered message that uses the offer you created previously to the trigger rule.
  7. Deploy the interactive channel.
  8. From the API Test client, perform a startSession for interactive channel where triggered message rule is configured and the postEvent which triggers the offer to Mobile Push.
  9. Check the Unica Interact logs to make sure the push was sent successfully. The status code 202 means successful delivery.