HBX Flash Implementation

HBX Flash ImplementationHBX Flash Implementation

Welcome to HBX!

This presentation will walk you through how to install HBX code for sites built with Macromedia Flash.

We will cover • The necessary HTML code that needs to be put on the HTML page.• The different ways to trigger HBX metrics from within the Flash movie.• How to code Flash specifically to be recognized by Visual Sciences’ Active Viewing plug-in.

Code for the HTML Page

• Just as standard page code, the HBX Page Code should go somewhere within the body of your HTML pages. It contains a series of JavaScript variables that can be configured according to your site’s specific tracking needs, as well as a reference to an external .js file, which sits on your server. – You should set this page up just as you would for any static HTML page.

• While the HBX Page Code can go anywhere in the body, you may wish to place it immediately after the <body> tag for the best performance.

• The external hbx.js file is a standalone file that you will not need to modify. When Visual Sciences releases new versions, you can often just replace this one file to take advantage of our latest features.

Using onlyMediaThis variable is only recommended if it is certain that you do not want to track any HBX metrics for or from the HTML page code. (If you have other links or features on the page that are not contained in the flash movie then you do not want to set this variable.)

Note: This feature may be used in order to not track a page view when the HTML loads. If you set onlyMedia=”y” then you MUST record all (including the initial) page views specifically in the ActionScript of the flash file.

To Set onlyMedia:in the HBX page code, add the hbx.onlyMedia variable, and assign it the value y thus:

hbx.onlyMedia="y";

Modifying the Flash Source Code

Changes generally involve adding one line of code in the URL field of the getURL command, with the following generic form:

getURL("javascript:function ("VariableName")");

Note: All of these getURL calls made to HBX must be wrapped in an event handler. There are some browser combinations that will not allow this function call to be made if called directly from a frame.

HBX Flash Tracking FunctionsParameters for the HBX Flash Tracking Functions

In general, all parameters in the HBX tracking functions for Flash objects must adhere to page coding naming and illegal character conventions.

Page Name and Content Category: *Use this function to trigger new pages in HBX. If a user navigates to another area in the flash movie that should be represented as another page, put this function in the event handler directing the user to the next section.

_hbPageView(YourPageName,YourContentCategoryName)

Example: getURL("javascript:_hbPageView('ASP', '/software+vendors')");

Downloads: *Use this function for downloads that you want to show up in the downloads report within HBX.

_hbDownload(YourDownLoadName)

Example: getURL("javascript:_hbDownload(‘MyDoc.pdf')");



Links: *Use this function to trigger links within your flash movie. The second option below must be used to enable Active Viewing.

_hbLink(LinkName) Or

_hbLink(LinkName, LinkPosition)Or

_hbLink(‘YourLinkName’,’LinkPosition’,’Xcoordinate,Ycoordinate,width,height’)

Example: getURL("javascript:_hbLink(‘MyLink', ‘upperNav‘, ‘130,172,113,38’)");

Exit Links:*Use this function to track links that take the user away from your site.

_hbExitLink(YourExitLinkName)

Example: getURL("javascript:_hbExitLink(‘More_Information')");

_hbLink Example

_hbLink EXAMPLE

On (press) {getURL("javascript:_hbLink(‘Last_Min_Specials')"); //”Last_Min_Specials” can be replaced with whichever Link ID you’d like to use. Must make changes in order to get this working with Active Viewing.}on (release){getURL("http://www.website.com/showStatic.do?command=showStaticPage&targetPage=/static/promotions/homepage_promos/abb/index.html");}

Main Button:On (press) {getURL("javascript:_hbLink(‘Main_Btn')"); //”Main_Btn” can be replaced with whichever Link ID you’d like to use. Must make changes in order to get this working with Active Viewing.}on (release){getURL("http://www.website.com/showStatic.do?command=showStaticPage&targetPage=/static/promotions/homepage_promos/abb/index.html");}



Funnels: *Use this function only for Funnels that need to be hard coded. Most Funnels are set up taglessly through the system.

_hbFunnel((FunnelID,FunnelLevelID),YourPageName,YourContentCategoryName)

Example: getURL("javascript:_hbFunnel(‘(123,4c)’,’my+page’,’/home’)");

Campaigns:*Use this function only for Campaigns that need to be hard coded. Most campaigns, aside from dynamic campaigns, are set up taglessly through the system.

_hbCampaign(YourCampaignID,YourPageName,YourContentCategoryName)

Example: getURL("javascript:_hbCampaign(‘EMC-Email2‘,’my+page’,’/home’)");



Population Groups:*Use this function to insert or remove users from a population group.

_hbVisitorSeg(YourPopulationgroupID,YourPageName,YourContentCategoryName)

Example: getURL("javascript:_hbVisitorSeg(‘-1,2‘,’my+page’,’/home’)");

Hbx.seg=“-1,2”;

Goal Page: *Use this function when setting the Goal Page within a flash movie.

_hbGoalPage(YourGoalPageCampaignID,YourPageName,YourContentCategoryName)

Example: getURL("javascript:_hbGoalPage(‘LAST‘,’my+page’,’/home’)");Note: This example will ensure that conversions to this Goal Page are only converted for the last campaign a user triggers.



Using _hbSet() and _hbSend() FunctionsThese two HBX functions allow all other metrics to be sent to HBX that are not explicitly defined with the previous 7 functions.

Note: The _hbSet function MUST be followed by an _hbSend function to work properly. You may call multiple _hbSet’s followed by an _hbSend to send all of the values set by each of the _hbSend’s.

_hbSet(HBXGatewayVariable,NewValueForVariable); _hbSend();

Example: getURL("javascript:_hbSet(’n’,’/home’);_hbSend()");

HBX Gateway Variables

GATEWAY Variable

Associated PAGE Code Variable

VARIABLE NAME CLEARED ON _HBSEND()

hb hbx.acct Account Number NO

n hbx.pn Page Name NO

vcon hbx.mlc Multi-Level Content NO

seg hbx.seg Population Group YES

cmp hbx.cmp Campaign ID YES

gp hbx.gp Goal Page YES

fnl hbx.fnl Funnel ID YES

pec hbx.pec Page Error Code YES

dcmp hbx.dcmp Dynamic Campaign ID YES

ra hbx.hra Campaign Response Attribute YES

gn hbx.hcn Campaign Conversion Attribute YES

ld hbx.hlt Campaign Lead Tracking YES

la hbx.hla Campaign Lead Attribute YES

cv hbx.hcv Campaign Conversion Value YES

Gateway Variables that can be set with _hbSetRemember Gateway Variable values must adhere to page coding naming and illegal character conventions.


GATEWAY Variable

Associated PAGE Code Variable


c1 hbx.hc1 Custom Metric 1 YES




customerid hbx.ci Customer ID YES

vpc hbx.vpd HBX Page Code Version NO

dcmpre hbx.dcmpre Dynamic Campaign Response Expiration YES

dcmpe hbx.dcmpe Dynamic Campaign Expiration YES

el Exit Link

fn Download

lid Link ID

lpos Link Position

sf Form Completion, set to “1”

lf Last form field focused

lv.id link view comma list of link id's

lv.pos link view comma list of link positions

sf form analysis indicates form completion set to 1


GATEWAY Variable Associated PAGE Code Variable


cnv.type conversion type

cnv.value conversion value

search.keywords search keywords

search.results search results

search.attr1 search attribute 1




Active Viewing and FlashAnchor Tags MUST be listed in the HTML page code for all

elements you wish to track in Active Viewing!Example Anchor Tags:

(These are often generated when the movie is published to HTML. If there are any anchor tags missing then active viewing will not show the corresponding statistics.)

<!- - url’s used in the movie - - >

<a href=“javascript:_hbLink(‘MyLinkName’,’LowerLeftPane’,’130,172,113,38’)”></a>

<a href=“javascript:_hbPageView('My+Page','/home')"></a>

<a href="javascript:_hbSet('c1','Size+3')_hbSend()"></a>

Setting up Links for Active ViewingAll links need to include the correct position name and coordinates (x, y, width, height) for them to correctly show up in active viewing. Link functions need to follow the below format within your ActionScript.

_hbLink(‘MyLink', ‘LeftPane‘, ‘130,172,113,38’)

Active Viewing TipsTips:

1. Be sure that all anchor tags have been placed on the HTML page.

2. When publishing to HTML anchor tags may get skipped if any of the following are true. In this case be sure to manually code the anchor tags to the HTML page.

• If the getURL for the HBX function is not the first function call made within an event handler.

• If there is more than one getURL HBX function call within the same event handler.

• If the getURL call for the HBX function is contained within a nested or external movie clip. (If it is not on the root timeline it will not get published.)

3. In the HTML code section beginning with “add <param” be sure to have

add <param name=”WMODE” value=”opaque”>

Implementation Support

• Implementation Readiness Call:– First Party Cookie, Enterprise & Commerce

Implementation– Monday and Thursday (10:00 - 11:30 PST / 1:00 - 2:30

EST)

• Implementation Questions & Answers: – Tuesday and Friday (10:00 - 11:30 PST / 1:00 - 2:30

EST)– Submitting agenda items for the twice weekly Q & A

calls must be done by the previous Friday for the Tuesday call and by Wednesday for the Friday call. Submissions should be sent to [email protected].

Online Support

You can access the support system through theHBX interface below the message board area when you first log in tothe Downloads & Administration section of your HBX log in or you can

bookmark this link http://www.websidestory.com/support.

This provides access not only to our support team but also to our solutions base which has information you will find very useful as you continue to use your tool and its features. Contact technical support

at 1-800-791-7110 or 1-858-362-6276.

HBX Flash Implementation

Documents

Transcript of HBX Flash Implementation