This article will review the types of beacons available and how to select the right one for your site, how to determine if you need to make any configuration changes to track additional information or add additional security, and how to integrate the beacon into your site:
Beacon Installation Checklist
- Use Evergage beacon version 4 or later (adjust it in SETTINGS > Beacon Version)
- Point the integration to the right protocol (https or http). You can also omit the protocol and include //cdn.evgnet.com...
- Insert the synchronous integration script
- Insert any other _aaq.push() calls needed before the script
- Review the differences in page load events
- Synchronous–recommended for most customers, this integration loads the beacon before the page loads so Evergage can prevent page flicker, a momentary flash of the original page content
- Asynchronous–this integration loads the beacon after the page has loaded. With this integration, Evergage cannot protect against flicker
- Hybrid–this integration supports ZeroFlicker but doesn't require you to point to the Evergage tag synchronously. Instead, a much smaller piece of code either loaded directly onto your site in a script tag, or hosted on your CDN or web hosting provider. Additionally, you point asynchronously at the standard Evergage tag. The trade-off here is that every time you want to change the sections that you target ZeroFlicker campaigns at, or the maximum redisplay timeout, you have to update the evergageFlickerDefender.min.js that you are hosting. For more specific details, please refer to the article on Synchronous vs. Asynchronous Integration.
Add Campaign Request Security
Campaign Request Security is an option in your Evergage integration which makes campaigns and other tracking more secure. This option requires you to write code for your site to properly encrypt userIDs with an API token. If a user's ID cannot be properly decrypted, then Evergage will not process events for this user.
Enable Campaign Request Security requires custom code to Encrypt userIDs on your site.
Encrypted Fields is an option in your Evergage integration to make field tracking more secure. This option requires code to be written on your site to encrypt values so they are not readable by the browser or browser's cache. If a field value cannot be properly decrypted then Evergage will not send this field value to Evergage for this user.
Enable Encrypted Fields requires custom code to Encrypt user fields on your site.
Tracking Additional User Information
Depending on what additional information you would like to collect, you may need to adjust the beacon code before you place it in your site. Typically, there are three additional pieces of information you may want to gather about logged in site or product visitors.
If the account of the logged in user is visible in your site or product or if you include the account name in the subdomain of your URL when logged in (i.e.
Account Type/Subscription Level
Sample Code Block
You will need to include two script tags if you adjust the beacon code to capture other variables, like UserID. In the first script tag, define these variables and in the second, define the beacon, in that order as user info must be loaded before the beacon. For example, if you are defining the UserID in a variable called mySitesUsername, it would look something like this:
This page has no comments.