hbx variables
DESCRIPTION
detailed description of the variables available in hbxTRANSCRIPT
OMNITURE' - ..... ~ Example 5
Read details about implementing the event intexface hbOnprepvO along wi th hbcooki e and the C:: s hortcut notaL; on.
Gateway Variables
The following table shows all gateway variables currently in HBX and HBX co=exce. It also indicates HBX page code variables witb no gateway variable equivalents and gateway variables witb no HBX page code equivalents.
h.bx. acc-t hb ACCOUNT NUMBER INTERNAL USE ONLY
hbx.pn n PAGE NAME
hbx.mle veon MUL TI·LEVEL CONTENT
hbx.seg seg POPULATION GROUP
hbx.cmp cmp CAMPAIGN ID '" '."
hbx . gp gp GOAL PAGE ALSO IN HBX COMMERCE
hbx . fnl fnl FUNNEL ID
hbx.pee pee PAGE ERROR CODE
hbx.dcmp dcmp DYNAMIC CAMPAIGN ID
DYNAMIC CAMPAIGN hbx.dcmpre dcmpre RESPONSE
EXPIRATION
hbx.dcmpe . dcmpe DYNAMIC CAMPAIGN EXPIRATION
hbx.hra ra CAMPAIGN RESPONSE ATIRIBUTE
hbx.hen gn CAMPAIGN CONVERSION
j PageA-44
. ..
OMNITURE" ............. ~ - ATIRIBUTE
.~
hbx .hlt Id CAMPAIGN LEAD ALSO IN HBX TRACKING COMMERCE
,
hbx . hla la ' CAMPAIGN LEAD ALSO IN HBX ATTRIBUTE COMMERCE
hbx . hcv CAMPAIGN ALSO IN HBX cv CONVERSION VALUE COMMERCE
hbx . cp cp LEGACY CAI.1PAIGN 10 FOR HBX COMMERCE
cl hbx . hcl or CUSTOM METRIC 1
cv.cl
c2 . . ' ,"'"
hbx:hc2 or CUSTOM METRIc" 2 cv.c2
c3 hbx . hc3 or CUSTOM METRIC 3
cv . c3
c4 hbx.hc4 or CUSTOM METRIC 4
cv . c4
hbx . ci customerid CUSTOMER 10 ALSO IN HBX COMMERCE
hbx.vpc vpc HBX PAGE CODE INTERNAL USE ONLY VERSION -
hbx . lt tt LINK ANALYSIS MODE INTERNAL USE ONLY
hbx . rf rf INDICATES CUSTOM REFERRER
cname . id cname . id ID ASSOCIATED WITH CNAME IS THE NAME OF CNAME THE USER·DEFINED
I PageA-45
· cname . valuecname.value -
cnv . id cnv.id
cnv-.,va;tue cnv. value --
1v _1pos
' , .... . . VALUE ASSOCIATED '
WITHCNAME
CUSTOM CONVERSION 10
CUSTOM CONVERSION VALUE
OMNITURE' ~ _ _ 1e!etIS
CUSTOM EVENT
CNAME IS THE NAME OF THE USER-DEFINED .
CUSTOM EVENT
GATEWAY VARIABLES WITH NO HBX PAGE CODE EQUIVALENTS
lid LINK 10
:~ 1pos LINK TRACKjNG POSITION
1v _id LINK VIEW AND COMMA-SEPARA TEO IDS LINK 10 LIST
LINK VIEW AND 1v_1pos LINK POSITION · COMMA-SEPARATED IDS ·
LIST
ttt LINK TRACKING INTERNAL USE ONLY TOKEN
e1 EXIT LINK
sf INDICATES FORM COMPLETION
1f INDICATES FORM VALUE IS LAST FORM FIELD ABANDONMENT WITH FOCUS
! PageA-46
OMNITURE" ---- ......
fn INDICATES DOWNLOAD
-INTERNAL
-.
search.keyword SEARCH KEYWORD
search.attrl INTERNAL through SEARCH search . attr4 AITRIBUTES
HEC=O INDICATES NEWPAGE
hec PAGE VIEW VIEW INTERNAL USE ONLY STATUS .- HEC=1
INDICATES INTRA·PAGE
REQUEST
JS ERROR
err ERROR FLAG OCCURS ON INTERNAL USE ONLY PAGE POST
LOAD
NAME OF m.f TRACKED
MEDIA FILE
CURRENT
m.cp POSITION OF TRACKED MEDIA IN MILLISECONDS
FILE
END POSITION m. ep OF TRACKED IN MILLISECONDS
MEDIA FILE
PLAY
m . s MEDIA STATE PAUSE STOP PLAYP
m.cl MEDIA PLAYER TYPE
! PegeA-47
OMNITURE'
MEDIA CLIENT AVAILABLE ONLY FOR m.cv VERSION QUICKTIME AND REALPLA YER
I = INTERVAL
m . tt MEDIA TRACKING TRACKING TYPE E = EVENT
TRACKING
pu PAGE URL 200 CHARACTER MAXIMUM
HBX PAGE CODE VARIABLES WITH NO GATEWAY VARIABLE EQUIVALENTS
hbx . pndef DEFAULT PAGE NAME
hbx . ctCief DEFAULT CONTENT CATEGORY
hbx.cpd CAMPAIGN DOMAIN
hbx.elf EXIT LINK FILTERING
hbx . gn GATEWAY NAME
hbx.mn MACHINE NAME
hbx.cgn COMMERCE GATEWAY
hbx.epg EVENT GATEWAY TOGGLE
hbx . dft DOWNLOAD FILE NAME DISPLAY TOGGLE
hbx.fv FORM VALIDATION
I P?geA·48
HBX COMMERCE PAGE CODE
-COMMERG.E PAGE CODE' . ,. : EVENT '.' : VARIAB\..~""
~,_ ._ ~4F
CARTADD
CARTADD ITEMVIEW
CARTADD CHECKOUT
ORDER
ORDER
ORDER
ORDER
ORDER
ORDER
ORDER
ORDER
ORDER
ORDER CARTADD ITEMVIEW
hbx.cam
hbx.pv
n/a
n/a
n/a
hbx . ci
hbx . oi
hbx.sy
hbx . sa
hbx . sz
hbx . so
hbx.pt
hbx .pr
cam
pv
abd_type
event=true
eid=l
customerid
orderid
shipcity
ships tate
shipzipcode
shipcountry
paymenttype
product
CART ADD METHODOLOGY
PRODUCT VIEW FLAG
EVENT TYPE
EVENT FLAG
EVENT ID FLAG
CUSTOMER ID
ORDERID
SHIP CITY
SHIP STATE
SHIP ZIP
SHIP COUNTRY
PAYMENT TYPE
CART PRODUCT
CAM=O INDICATES HIGHWATERMARK CAM = 1 INDICATES INCREMENTAL
PV= 0 INDICATES CART ADD
PV=1INDICATES ' PRPDUCT VIEW
OMNITURE' ---
ABD_TYPE = CART_ADD ON CART ADD PAGES ABD_TYPE = CHECKOUT ON CHECKOUT PAGES ABD_ TYPE = ORDER ON ORDER PAGES
EVENT = TRtlE ON ORDER .
EID = 1 ON ORDER
ALSO IN HBX
OMNITURE' ___ -===r!I
CHECKOUT
ORDER PRODUCT CARTADD hbx.qn quantity
QUANTITY CHECKOUT
ORDER hbx.bd brand PRODUCT BRAND ITEMVIEW
ORDER : hbx . ca category PRODUCT ITEMVIEW CATEGORY ·
ORDER hbx . st shippingtype SHIPPING TYPE CHECKOUT
ORDER hbx.sp shipping SHIPPING PRI.CE CHECKOUT
ORDER CARTADD hbx .pc price PRODUCT PRICE CHECKOUT
ORDER CARTADD hbx ."sr store STORE CHECKOUT
ORDER hbx . sk sku SKU
ORDER - hbx . cu customer_type CUSTOM TYPE .. . ORDER hbx . ds discount DISCOUNT
ORDER hbx . po promotion PROMOTION
ORDER hbx . cl Ii customl CUSTOM METRIC 1
ORDER hbx . c2 Ii custom2 CUSTOM METRIC 2
ORDER CARTADD hbx . cacct aid COMMERCE ITEMVIEW ACCOUNTID CHECKOUT
! PageA-50
OMNITURE' --~
CHECKOUT hbx.cv CONVERSION -
CARTADD cv
VALUE
ORDER CHECKOUT hbx.gp gp GOAL NAME ALSO IN HBX CARTADD
ORDER hbx.hla la LEAD A TIRIBUTE ALSO IN HBX CHECKOUT
ORDER hbx.hlt ld LEAD TRACKING ALSO IN HBX CHECKOUT