You must define the relationship between the event types, attributes, and identifiers that Exchange supports and the corresponding events that you have defined for use in your Tealeaf environment. You do this by explicitly mapping the Exchange event types to your Tealeaf events, attributes, and identifiers.
Confirm that you have access to the configuration files for your Tealeaf installation and to the Event manager.
Tealeaf provides the file, TealeafUBXMapping.cfg, to provide the necessary mapping details for the default list of event types that you can publish through Exchange. The file contains the event type names, attributes, and supported identifiers, as defined in Exchange. You modify this file to map the values that you have defined for Tealeaf events to their Exchange equivalents.
By modifying this configuration file, you can indicate which event types to publish to Exchange and which Tealeaf attributes correspond to Exchange attributes. You must also specify at least one personal identifier that can be used to link events to a specific individual or session.
- In your Tealeaf installation directory, go to Tealeaf CX and open TealeafUBXMapping.cfg.
- In the top part of the file, locate the
UBXEndpointAuthKey
property, and enter the authentication key for the Tealeaf endpoint that is registered in your Exchange account.This is the same authentication key that you entered into the
config.properties
file when you registered the Tealeaf endpoint in Exchange. You can find the authentication key in Exchange. It is listed in the endpoint properties for the Tealeaf endpoint. - In the Identifier mapping section, define at least one identifier. Remove the comment tag (#) from each identifier that you will publish to Exchange. On the right-hand side of the = sign, enter the name of the identifier as it is defined in your Tealeaf installation.
For example, the configuration file provides an identifier called email to support using email address as a way to identify individuals. If you have defined a field named ADDR_email to track email addresses in your Tealeaf installation, you must modify the line in the file to appear as shown in the following example:
email=ADDR_email
- In the Event attribute mapping section, indicate the event types that you want to publish. Each event type lists the event’s relevant attributes. For each event type that you will publish, do the following:
- Change the value for the Active field to Y.
- In the TLEventId field, enter the Event ID of the Tealeaf event type that you want to map to the selected Exchange event type.
- Enter the name of each Tealeaf attribute that you want to publish on the same line as the corresponding Exchange event attribute that provides the same information.
Find the values for TLEventId and Tealeaf attribute names in the event descriptions that are available in the Event manager.
For example, the configuration file provides the Cart Purchase event. It includes the OrderID attribute to identify specific online orders. If you have defined an attribute called WebOrdNum in your Tealeaf installation to track online orders, you must modify the line in the file to appear as follows:
eventAttribute:orderID=WebOrdNum
- Save the file.
To support event subscriptions between Tealeaf and Acoustic Campaign, you must specify a value for contactConsent
. Acceptable values for contactConsent
:
email,opt-in
email,opt-out
email,unknown