Registration tag
The WebSphere Commerce registration tag collects registration data for a customer that is logged in to the store.
This tag collects the following data to pass to an external analytics system:
- Customer identifier
- Customer email
- Customer city
- Customer state
- Customer ZIP code
- Customer country
- Age
- Gender
- Marital status
- Number of children in household
- Company name
- Hobbies
- Income
- Store identifier
This tag can also pass extra parameters for tag customization.
Parameters
The registration tag supports two optional parameters.
Note for IBM Digital Analytics: The following parameters are for the WebSphere Commerce <cm:registration /> tag. This tag generates the IBM Digital Analytics cmCreateRegistrationTag data tag.
- personType
- Use this parameter if the store uses the PersonType service data object to represent guest and registered customers. This parameter is a populated instance of the PersonType class. If you do not use this parameter, the registration tag uses the current customer's member ID to fetch the data required to generate the registration tag.
- extraparms
- An optional parameter that communicates more information to the external analytics system. This parameter is provided for cases in which we might have negotiated with the external analytics vendor to generate some custom report that requires more information.
Note for IBM Digital Analytics: Use the extraparms parameter to pass either IBM Digital Analytics Explore attributes, or data for custom IBM Digital Analytics reports, or both. See Passing extra data to IBM Digital Analytics with the extraparms parameter. There are multiple ways to pass values using the extraparms parameter:
Description Example Specify explicit values as properly escaped JavaScript. To pass more than one value, separate values with a comma. extraparms="\"value1\",\"value2\""
- returnAsJSON
- An optional parameter that is designed for use when tracking customer interactions that do not cause a full page refresh. For example, in a Web 2.0 store, the customer might interact with the mini shopping cart, the Product Fast Finder, or a wish list. To track these page interactions, we can use this parameter to return a JSON object instead of generating the analytics data tag. When the Web 2.0 store tagging framework detects that this analytics event has occurred, the tagging framework can use the JSON object to populate the analytics data tag. Valid values are:
- true = Return a JSON object.
- false = Generate the analytics data tag.
The following is the JSON data structure for the registration tag:
[{userId:"ID",userEmail:"EMAIL",userCity:"CITY",userState:"STATE" ,userZip:"ZIP",newsletterName:"NLFLAG",subscribedFlag:"SBFLAG", storeId:"STOREID",userCountry:"COUNTRY",age:"AGE",gender:"GEN", maritalStatus:"MS",numChildren:"NC",numInHousehold:"NH", companyName:"CN",hobbies:'"HBS",income:"INCM"}]
Tag versions
WebSphere Commerce provides two versions of the registration tag:
- An abstract base tag implementation class: MembershipBaseTag. Analytics vendors who want to provide a page view tag in their web analytics JSP tag library for WebSphere Commerce can extend this base tag class to get the registration data and implement their own logic to generate the vendor-specific registration tagging APIs.
- A default implementation of the registration tag (<cm:registration />) for IBM Digital Analytics. This implementation automatically generates the IBM Digital Analytics cmCreateRegistrationTag data tag.
Related concepts
IBM Digital Analytics, formerly known as Coremetrics Analytics integration with Web 2.0 starter stores
Passing extra data to IBM Digital Analytics with the extraparms parameter
Related reference
Use the registration tag with IBM Digital Analytics