Web Extend admin functions are accessed through the Predict Dashboard in Emarsys. Web Extend data collection monitors are located on the left, with the Predict reports on the right.
Web Extend implementation is facilitated by our interactive guide (in the yellow box), which displays the next implementation step and links you to the relevant documentation / controls.
This page describes the steps in the implementation process.
But first, why not watch a short video introduction:
And now, on with the implementation.
- Step 1 – Pick your base currency
- Step 2 – Upload your product catalog
- Step 5 – Validating the JS API implementation
- Step 6 – Bringing data collection live and validating the implementation
- Step 7 – Checking site traffic statistics
- Step 8 – Checking Web Extend output in your contact database
Things to consider before you start
- We provide a number of tools to help you validate your integration as you implement it, including the Live Validator, the Live Events view, and our very own Inspector Gadget.
- All data that is collected and stored by Web Extend is anonymous; only after it has been imported into the Emarsys database is the web behavior associated with actual contacts.
If you are using Web Extend in conjunction with Emarsys Predict, you should discuss your data collection policy with Emarsys Support, as the type of data collected depends greatly on the profile of your online business.
- Most important! – You don’t just want to collect data on all your current web pages – you also want to collect it on all the new pages you create in the future. This includes new product pages and the landing pages you create for marketing campaigns. So you should also add the relevant commands to the templates you use for creating different page types.
Step 1 – Pick your base currency
This should be the currency in which you want to track your revenue statistics, regardless of the number of currencies actually used on your website.
There is an important point to make here: your revenue (and therefore your data collection) is recorded in a single, base currency. This base currency is used to display website revenues and campaign revenues. Your site may offer products in different currencies and prices, but this is not relevant for data collection. Data collection must always use your base currency.
Step 2 – Upload your product catalog
The product catalog identifies your products for analysis. The catalog is a simple, daily updated table, each row containing all the information relating to a specific item (product ID, category, page URL, thumbnail image link, etc.). This step should already have been performed as part of your data onboarding.
NOTE: If you have an existing Google Tag Manager integration, then you may want to see our Guidelines for implementing Web Extend through GTM
Some of our API commands should be included in ALL website pages:
setEmailcommand to identify your logged-in visitors.
cartcommand to report the cart content of your visitors.
- And the
gocommand to execute the Scarab Queue.
Use this JSFiddle example to see these commands in action. Use the LIVE EVENTS viewer in your Predict Dashboard to check your implementation works.
Some data-collection commands should only be included on specific pages of your website:
viewreports the ID of the product being viewed on your Product Page.
categoryreports the category path being visited.
purchasereports the orders placed. This is the basis for Web Extend revenue metrics.
Use these JSFiddle examples to see these commands in action. Use the LIVE EVENTS viewer in your Predict Dashboard to check your implementation works.
Step 5 – Validating the JS API Implementation
LIVE EVENTS is an API validation tool to check the correct functioning of our API commands. It is a real-time listener that monitors the API commands received by our servers. Every successful API call is listed in the live event feed, so you can check the correct implementation of each command.
Click the header of the box to get to the detailed Live Events screen.
Inspector Gadget is the second API validation tool we provide. Inspector Gadget runs in the browser, and monitors API commands as they are sent from the browser.
Step 6 – Bringing data-collection live, and validating implementation
Once you have made sure that all API commands function properly, it is time to bring your implementation of the JS API live.
Live Validator is our dedicated tool to analyse and validate data collection once exposed to real traffic. Live Validator monitors the health of your integration by sampling real web traffic and running over 100 validation checks, making sure that the data received from the API commands makes sense when applied to your product catalog.
Live Validator also posts its alerts to each box of the Predict Dashboard. Live Validator offers error examples and fix suggestions for each alert it displays.
Step 7 – Checking site traffic statistics
Click the header of the box to get to the detailed Site Traffic screen. Here you can see additional site statistics, and this is also where you find a function to export collected purchase data in one .csv table (this is useful for a final confirmation that Web Extend is collecting all the transactions on your site).
Step 8 – Checking Web Extend output in your contact DB
Now, the WEB EXTEND box of the Dashboard is also active, showing you the number of visitors identified through the data-collection scripts, and the number of contacts updated in Emarsys contact database based on this data.
Once you have completed the above steps, and validations run successfully on your integration, data collection and the enrichment of contact data through the Web Extend fields is continuous.
Please remember to check back on your integration’s health using the Live Validator tool every once in a while, and at least after each change of the website frontend (to ensure other updates to the pages have not corrupted the Web Extend scripts).