Although integrating Experience Analytics with Exchange is fairly simple, thorough planning and preparation helps eliminate any guesswork. Your planning should identify the elements and interactions involved, highlight all necessary preparations, and schedule the tasks to be completed.
Review the integration requirements. The integration requires some changes to your network environment.
Determine which server you will use to communicate with Exchange. This is the machine on which you will modify the configuration and mapping files and where you will run the endpoint registration script.
As part of your planning, review and understand the contributing elements of the integration, and how you must interact with them.
- Exchange endpoint in Exchange. The Exchange endpoint provides a way to define event subscriptions and specifies the event types, attributes, and identifiers that Exchange can provide.
- Endpoint registration in Exchange. Registering the Exchange endpoint in your Exchange account is required to create secure communication between your Exchange installation and Exchange.
- UBXTools folder. Located in your Exchange CX installation, this folder contains the Exchange configuration file and the endpoint registration script.
- Authentication key. Exchange generates this alphanumeric string when you register Exchange as an endpoint in your Exchange account. The authentication key identifies your Exchange installation to Exchange and is part of every communication between Exchange and Exchange.
- Exchange configuration file. (
config.properties) Use the configuration file to provide the authentication key to Exchange. Find it in the UBXTools folder.
- Registration script (
RegisterEndpoint.ps1) This is a Powershell script that makes the API calls that are required to register the Exchange endpoint as a recognized event publisher in your Exchange account. You need to run this only once during the initial endpoint setup. Find it in the UBXTools folder.
- Exchange mapping file. (
TealeafUBXMapping.cfg) Use the mapping file to correlate Exchange event types, attributes, to corresponding event types, attributes, and identifiers in Exchange. Find it in the top level of your Exchange CX installation folder.
- Exchange Event manager. Use the Event manager to identify the Exchange event ID and event attributes that you must specify in the mapping file.
- Exchange event bus and configuration file. Configure the event bus to define the pipeline between captured event data and the connection to Exchange.
- Event subscription in Exchange. Event subscriptions define a path between Exchange and another business application through Exchange. The subscription indicates the event data to be shared. Establishing an event subscription is the final step in the integration.
If the event subscriber requires a specific type of event data, your Exchange installation must be able to provide it. Different event subscribers often accept or require different types of event data. Confirm the subscriber requirements before you begin to create the event subscription.
Use the Exchange Dynamic Event Library to determine the requirements for the subscribing application.
Exchange to Exchange integration requirements
Before you begin to configure the integration of Exchange with Exchange, make certain that your environment can support the integration and that you have all of the information and permissions that you need.
- Enable TLS 1.2 security at the operating system level on the Windows-based server on which you run the endpoint registration script. Run the script once, from a single server.
- Open port 443 in your firewall to allow Exchange to communicate with Exchange. All communication is through REST API calls over HTTPS.
- You must have Powershell script execution rights set to unrestricted.
- You must have an active Exchange account.
- Your Exchange user role must have access to the Event manager.
Exchange event types supported by the integration
Your ability to share event data through Exchange depends on Exchange support for the type of event, attributes, and identifiers that you provide. For the Experience Analytics to Exchange integration, you can map Experience Analytics event types and attributes to their Exchange equivalents.
By default, the integration supports the following Exchange event types.
- Add Item to Cart
- App Crashed
- App Session Closed
- App Session Opened
- Cart Abandonment
- Cart Purchase
- Conversion Abandonment
- Entry Page
- Form Field Dwell Struggle
- Form Field Repeat Struggle
- Form Field Validation Struggle
- Product View
- Provided Rating
- Remove Item from Cart
- Searched Site
- Video Completed
- Video Launched
- Video Paused
- Video Played
- Wrote Review
The Experience Analytics mapping file,
TealeafUBXMapping.cfg, lists these
supported events and related attributes.