General education for Engage
Demo walkthru of Engage: https://vimeo.com/112195442 Password: sp2014
A few helpful times in the video if you want to jump ahead.
Programs 1.0 - 7:15
Scoring Models - 12:50
Old Content Editor - 16:45
Dynamic Content - 18:30
General education topics for new Engage users training - extensive collection of education replays
Using Engage with UBX introduction education module
Registering the Engage UBX endpoint:
1. Register the Engage endpoint in your UBX pilot account - go to Endpoints and select Register new endpoint
Select Engage from the list of available endpoints
Click Next. You will need to enter your Engage refresh token and database id
Once your Engage credentials are verified click Next. Once the endpoint registration is complete, the Engage endpoint will appear with the Test Drive endpoints and any other registered endpoints in your UBX pilot account.
Note: To obtain your Engage refresh token and database ID, proceed as follows:
Refresh token: Click Settings, Application Account Access, Add Account Access. Select an application (ie: IBM UBX) and a user account, click Add, when submitted the refresh token will be emailed to that account's email id.
UBX Event Syndication with Engage:
In order for UBX data to flow into IBM Marketing Cloud, you must setup a database for UBX as a Flexible database and the Email and x1id fields enabled as lookup keys.
Creating a Flexible Database
UBX integration with IBM Marketing Cloud requires a Flexible database. You may either:
The UBX enabled database requires the following:
- It must be saved in the Shared folder.
- it must be a Regular or Single Opt In database.
- It must be a Flexible Database.
The following are required fields:
Email - Field Type: System. Automatically generated when the database is created.
x1id - Field type: text. Manually Created By user. To create the field, go to Data, select your database, in the database view, select Settings and select Add field
The x1id and Email fields must be enabled as lookup keys.
Note: If you are using the Import method, make sure your flat file includes the Email and x1id fields.
Enable Lookup Keys:
You can enable Lookup Keys on a flexible database. The values in each selected field should uniquely identify a contact. A lookup key is a user selected data field that allows API’s to update faster.
Two fields must be enabled as Lookup Keys in the flexible database in order for UBX event to populate the database - Email and x1id. To enable these fields, follow these instructions.
Go to Data > View Data.
Select the database you want to use.
Click LookUp Keys.
In the Status column, check the box next to the fields to be used as lookup fields. The field limit counter shows how many lookup keys are available.
- The selected fields are grayed out to prevent changes while the fields are enabled.
- Once complete the screen will refresh to the Database > Fields tab. A binoculars icon displays next to the lookup field.
Contacts entries created in the Engage database when your endpoint's UBX events are received in Engage
Note that an entry for a new contact will be created in the Engage database when an event published by your UBX endpoint is received by Engage. If you would like the customer identifier field from your UBX event type to be added to new entries in the database, your UBX event definition must include the contactConsent attribute field with the desired customer identifier and the field value set to "opt-in". Supported customer identifiers are email, SMS and mobile id. The contactConsent attribute field is defined as:
Field name: contactConsent
Field type: string
Values: email|mobile|sms, opt-in|opt-out (Not case sensitive)
Example value: email, opt-in
Indicates that an individual wants to receive email messages.
Using UBX Events in Engage Programs and Queries
Once Marketing Cloud has been registered as an Endpoint, it can now subscribe to published UBX events from IBM partner or second or third party applications. Marketing Cloud (Engage) can consume the data either as Universal Behaviors or as Relational Table data. Once UBX data has been configured with Universal Behaviors, data becomes available for consumption in Queries, Program Entry Criteria, or Scoring Behaviors.
In the below scenario, Digital Analytics acts as a publisher, and Marketing Cloud (Engage) has subscribed to web site behaviors published by Digital Analytics.
Digital Analytics Publishes Data into Marketing Cloud (Engage):
The UBX events Digital Analytics publishes that can be subscribed by Engage can include visitor searches, product view, cart purchases, cart abandonment and conversion events
Now that UBX events are flowing into Marketing Cloud, Universal Behaviors have been setup allowing it's use in Queries, Programs, and Dynamic Content Rulesets. UBX event data can be used to create more relevant queries and ensure that the best possible segment of a database is targeted for various marketing email messages.
To use UBX event data for Engage program entry criteria:
Select a database configured for UBX events as their Contact Source.
Choose the Add Contacts when the following events occur option.
Select Universal Behaviors.
Note: The menu item will not display if the selected database does not contain events.
- Select an event. Click Add Behavior. The attributes specific to that event display.
- Select your criteria and then click Apply.
To use UBX event data in an Engage query:
- In Queries, select Universal Behavior from the Behavior options.
- A new criteria is added to the rule builder.
- From the drop-down list, select the configured Universal Behavior that you would like to use.
The Target section shows the attributes for the event type and Timeframe options that the UBX partner configured.
Sharing Audiences from Engage to another UBX Endpoint:
Publishing audiences from Engage thru UBX: Education session replay (5:38): https://learnerportal.kenexa.com/lmscontent/public/industry-solutions/6U028/6U028-4.mp4
Procedure for sharing audiences from Engage to another UBX Endpoint:
- Create an audience segment using an Engage contact list, database or query in SHARED folder/area
Create and add contacts to a contact list https://www.ibm.com/support/knowledgecenter/SSTSRG/Create_and_Add_Contacts_to_a_Contact_List.html
Create a contact list from a database https://www.ibm.com/support/knowledgecenter/SSTSRG/Populate_a_contact_list_using_a_database.html
- In UBX, select Share Audience, select Engage as the audience source, and under the list of shareable audiences your new audience segment should appear
- Select your UBX endpoint as the destination, specify an existing or new destination audience
- Map identifiers and attributes between the source and destination audience:
- Schedule the audience share job – for testing, leave the default choice of Immediate
- Select which mode of destination audience update (replace/add/delete)
- Select Share. Verify that the audience data has been received in the destination endpoint
Publishing audiences from your UBX solution endpoint to Engage as an audience destination
Identifiers to be used for audiences published to Engage can include typical customer identifier types; Engage specific identifier types used in Engage databases and contact lists are: email, sms and engagecontactid.
In order to allow access to audiences previously published to Engage in UBX, for UBX business users to add, replace or delete entries in the existing audience in Engage (rather than the default behavior of just creating a new audience), the proper audience type must be specified when your UBX endpoint publishes audiences to Engage thru UBX. Supported UBX audience types for UBX audience publishers are "Databases", "Queries" and "Contact Lists". For UBX audience destinations, only the "Contact Lists" audience type is supported.
Example JSON response for GET v1/segments API with these audience types:
"type": "Contact Lists",
Working with audience segments in Engage
Create an audience segment for mailing contacts:
You can create a database for the audience segment and import audience data the database, documentation link
Working with non-keyed databases
Engage audiences for use with UBX must be in a non-keyed database. For partners and clients new to non-keyed databases, these articles and KB entries may be informative.
Key use cases and benefits for non-keyed databases in Engage: http://www.silverpop.com/blogs/email-marketing/building-marketing-profiles.html
Differences between keyed and non-keyed databases and why non-keyed databases provide benefits for working with universal behaviors and UBX: http://www.ibm.com/support/knowledgecenter/en/SSTSRG/What_are_the_differences_in_Email_keyed_Non-keyed_and_Combination_Key_unique_identifiers.html
Import audience entries to a non-keyed database: http://www.ibm.com/support/knowledgecenter/SSTSRG/Import_Data_into_a_Non-keyed_Database.html
Merge email keyed and non-keyed databases in Engage: http://www.ibm.com/support/knowledgecenter/SSTSRG/Merge_Non-Keyed_and_Email_Keyed_Databases.html
Enable lookup keys in a non-keyed database: http://www.ibm.com/support/knowledgecenter/en/SSTSRG/Enable_Lookup_Keys_on_a_Non-Keyed_Database.html
Using Contact Matching to identify customers in a non-keyed database, for instance, to allow a customer to opt-in to a non-keyed database again: http://www.ibm.com/support/knowledgecenter/en/SSTSRG/If_I_use_a_non-keyed_database_how_can_a_contact_opt_in_again_to_my_database.html