API Docs for: 0.0.6
Show:

OmnitureHelper Class

Defined in: lib/omnitureHelper.js:32

OmnitureHelper - a microlibrary for omniture tagging.

Constructor

OmnitureHelper

(
  • events
  • commerceVariables
  • insightVariables
)

Defined in lib/omnitureHelper.js:32

Parameters:

  • events Object

    (id,name) array of all events that will be used.

  • commerceVariables Object

    (id,name) array of all commerce variables that will be used.

  • insightVariables Object

    (id,name) array of all insight variables that will be used.

Methods

clearCommerceVariables

()

Defined in lib/omnitureHelper.js:106

Clears Every Commerce Variable.

clearInsightVariables

()

Defined in lib/omnitureHelper.js:141

Clears Every Insight Variable

clearVariablesAndEvents

()

Defined in lib/omnitureHelper.js:94

Clears Variables, Page Name and Events. Useful to be used before setting values in a method

commerceVariablesWithValues

()

Defined in lib/omnitureHelper.js:122

Lists Every Commerce Variable with a Value.

fireEvent

()

Defined in lib/omnitureHelper.js:228

Clear Events (s.events) removes all events.

fireEvent

(
  • eventName
)

Defined in lib/omnitureHelper.js:215

Fire Event (s.events) adds another event to the list of events.

Parameters:

  • eventName String

    The key of the event to be added

incrementCommerceCounterValue

(
  • variableName
)

Defined in lib/omnitureHelper.js:237

Increment Commerce Variable (s.eVar)

Parameters:

  • variableName String

    The key associated with the eVar number that is to be incremented.

insightVariablesWithValues

()

Defined in lib/omnitureHelper.js:157

Lists Every Insight Variable with a Value.

saveValues

(
  • thisvar
  • linkName
)

Defined in lib/omnitureHelper.js:316

used to track exit link.

Parameters:

  • thisvar Object

    this

  • linkName String

    the url or some other decription of where the user is going..

saveValues

(
  • thisvar
)

Defined in lib/omnitureHelper.js:282

used to track evars / props WITHOUT associated page info.

Parameters:

  • thisvar Object

    this

setChannel

(
  • channelName
)

Defined in lib/omnitureHelper.js:196

Set Channel

Parameters:

  • channelName String

    The Channel Name.

setCommerceVariable

(
  • variableName
  • value
)

Defined in lib/omnitureHelper.js:248

Set Commerce Variable (s.eVar)

Parameters:

  • variableName String

    The key associated with the eVar number that is to be set.

  • value String

    The value that is to be recorded.

setErrorPage

()

Defined in lib/omnitureHelper.js:206

Used only to designate a 404 Page Not Found Error Page.

setInsightVariable

(
  • variableName
  • value
)

Defined in lib/omnitureHelper.js:260

Set Insight Variable (s.prop)

Parameters:

  • variableName String

    The key associated with the prop number that is to be set.

  • value String

    The value that is to be recorded.

setPageName

(
  • pageName
)

Defined in lib/omnitureHelper.js:176

Set Page Name

Parameters:

  • pageName String

    The Name of the Page.

setPageUrl

(
  • url
)

Defined in lib/omnitureHelper.js:186

Set Page Url

Parameters:

  • url String

    The Url To Set.

trackVirtualPageView

()

Defined in lib/omnitureHelper.js:272

used to track evars / props with associated page info.