bea.com | products | dev2dev | support | askBEA

Download Docs | Site Map | Glossary
Search

Development Guide

Event Descriptions

This appendix provides information about the standard events provided with WebLogic Portal. Specifically, it contains a description of each kind of event, what generates the event, the class where event generation occurs, an example of usage, and the type of data within each event object.

WebLogic Portal Events are organized in the following categories:

- Session Events

- User Registration Event

- Product Events

- Content Events

- Cart Events

- Buy Event

- Rules Event

- Campaign Events

Session Events

Session events fire at the start time, end time, and if executed, the login time of a visitor's session.

SessionBeginEvent

Description | Occurs when a visitor begins interacting with a Web or portal site.
Class | com.bea.p13n.tracking.events.SessionBeginEvent
Generator | See Servlet Lifecycle Events and Servlet Filter Events.
Elements | application event-date event-type session-id user-id

SessionEndEvent

Description | Occurs when a visitor leaves a site, or when the visitor's session has timed out.
Class | com.bea.p13n.tracking.events.SessionEndEvent
Generator | See Servlet Lifecycle Events and Servlet Filter Events.
Elements | application event-date event-type session-id user-id

SessionLoginEvent

Description | Occurs when a visitor logs on a Web or portal site.
Class | com.bea.p13n.tracking.events.SessionLoginEvent
Generator | TrackingEventHelper.dispatchSessionLoginEvent(), P13NAuthFilter, and/or Input Processor. See Generating Login and Creation Events.
Elements | application event-date event-type session-id user-id

User Registration Event

Only one registration event exists. It is described in the following table.

UserRegistrationEvent

Description | Occurs when visitor registers on a Web or portal site.
Class | com.bea.p13n.tracking.events.UserRegistrationEvent
Generator | TrackingEventHelper.dispatchUserRegistrationEvent() and/or Input processor.
Example Usage | examples.wlcs.sampleapp.customer.webflow.LoginCustomerIP located in <BEA_HOME>\weblogic700\portal\samples\portal\wlcsDomain\wlcsApp\wlcs\WEB-INF\src
Elements | application event-date event-type session-id user-id

Product Events

These events occur when visitor is presented with a product or clicks (selects) the presented product.

ClickProductEvent

Description | Occurs when a visitor clicks a product link.
Class | com.bea.commerce.ebusiness.tracking.events.ClickProductEvent
Generator | JSP Tag. Also see Servlet Lifecycle Events and Servlet Filter Events.
Elements | application event-date event-type session-id user-id document-type document-id sku category-id application-name (name of storefront, not portal application)

DisplayProductEvent

Description | Occurs when a product is displayed to the visitor.
Class | com.bea.commerce.ebusiness.tracking.events.DisplayProductEvent
Generator | JSP Tag
Elements | application event-date event-type session-id user-id document-type document-id sku category-id application-name (name of storefront, not portal application)

Content Events

These events occur when the visitor is presented some content, such as an advertisement, or clicks the presented content.

ClickContentEvent

Description | Occurs when a visitor clicks some Web site content, such as a link or banner.
Class | com.bea.p13n.tracking.events.ClickContentEvent
Generator | JSP Tag. Also see Servlet Lifecycle Events and Servlet Filter Events.
Elements | application event-date event-type session-id user-id document-type document-id

DisplayContentEvent

Description | Occurs when content is presented to a visitor, usually any content from a content management system.
Class | com.bea.p13n.tracking.events
Generator | JSP Tag
Elements | application event-date event-type session-id user-id document-type document-id

Cart Events

These events indicate that one or more items are added or removed from a visitor's shopping cart.

AddToCartEvent

Description | Occurs when an item is added to a visitor's shopping cart.
Class | com.bea.commerce.ebusiness.tracking.events.AddToCartEvent
Generator | Pipeline component. Located in <BEA_HOME>\weblogic700\portal\applications\wlcsApp-project\application-sync\pipelines.
Example Usage | examples.wlcs.sampleapp.tracking.pipeline.AddToCartTrackerPC located in <BEA_HOME>\weblogic700\portal\samples\portal\wlcsDomain\beaApps\wlcsApp\src
Elements | application event-date event-type session-id user-id sku quantity unit-list-price currency application-name (name of storefront, not portal application)

RemoveFromCartEvent

Description | Occurs when an item is removed from a visitor's shopping cart.
Class | com.bea.commerce.ebusiness.tracking.events.RemoveFromCartEvent
Generator | Pipeline component. Located in <BEA_HOME>\weblogic700\portal\applications\wlcsApp-project\application-sync\pipelines
Example Usage | examples.wlcs.sampleapp.tracking.pipeline.RemoveFromCartTrackerPC located in <BEA_HOME>\weblogic700\portal\samples\portal\wlcsDomain\beaApps\wlcsApp\src
Elements | application event-date event-type session-id user-id sku quantity unit-price currency application-name (name of storefront, not portal application)

PurchaseCartEvent

Description | Occurs once for an entire order, unlike the BuyEvent, which occurs for each line item. This event is useful for campaigns. You can use it when writing scenario actions to know when your visitor makes a purchase with specific characteristics, such as an order greater than $100 or the purchase of a particular product.
Class | com.bea.commerce.ebusiness.tracking.events.PurchaseCartEvent
Generator | Pipeline component. Located in <BEA_HOME>\weblogic700\portal\applications\wlcsApp-project\application-sync\pipelines.
Example Usage | examples.wlcs.sampleapp.tracking.pipeline.PurchaseTrackerPC located in <BEA_HOME>\weblogic700\portal\samples\portal\wlcsDomain\beaApps\wlcsApp\src
Elements | application session-id user-id event-date event-type total-price order-id currency application-name (name of storefront, not portal application)

Buy Event

Only one buy event exists. It is described in the following table.

BuyEvent

Description | Occurs when a visitor completes the purchase. A BuyEvent occurs for each line item. A purchase may consist of one or more line items. A line item may consist of one or more items. For example, although a particular line item may have quantity of four items, only one BuyEvent occurs.
Class | com.bea.commerce.ebusiness.tracking.events. BuyEvent
Generator | Pipeline component
Example Usage | examples.wlcs.sampleapp.tracking.pipeline.PurchaseTrackerPC located in <BEA_HOME>\weblogic700\portal\applications\wlcsApp\src
Elements | application event-date event-type session-id user-id sku quantity unit-price currency application-name (name of storefront, not portal application) order-line-id

Rules Event

Only one rule event exists. It is described in the following table.

RuleEvent

Description | Indicates the rules that were fired as a visitor navigates a Web site.
Class | com.bea.p13n.tracking.events.RuleEvent
Generator | Fired internally from advislets
Elements | application event-date event-type session-id user-id ruleset-name rule-name

Campaign Events

These events occur when a visitor participates in a campaign.

CampaignUserActivityEvent

Description | Occurs when a visitor participates in a campaign. Specifically, this event is fired whenever one or more scenario actions are true and the campaign service is activated. You can limit this event to a single occurrence for a particular scenario. This event is intended for use by analytic software.
Class | com.bea.campaign.tracking.events.CampaignUserActivityEvent
Generator | Fired internally from the campaign service.
Elements | application event-date event-type session-id user-id campaign-id scenario-id

DisplayCampaignEvent

Description | Occurs when campaign content, such as an ad, is presented to the visitor. Specifically, this event is fired whenever a campaign placeholder displays an ad placed in the ad bucket by a campaign. You can use this event to trigger another campaign. Analytic software uses this event to determine if a visitor saw an ad as a result of a campaign.
Class | com.bea.campaign.tracking.events.CampaignUserActivityEvent
Generator | Fired internally from the campaign service.
Elements | application event-date event-type session-id user-id document-type document-id campaign-id scenario-id application-name (name of storefront, not portal application) placeholder-id

ClickCampaignEvent

Description | Occurs when a campaign item, such as an ad, is clicked on by the visitor. Specifically, this event is fired whenever a visitor clicks a campaign ad that was placed in the ad bucket by a campaign. You can use this event to trigger another campaign. Analytic software uses this event to determine if a visitor clicked on an ad as a result of a campaign.
Class | com.bea.campaign.tracking.events.ClickCampaignEvent
Generator | Fired internally from campaign service. Also see Servlet Lifecycle Events and Servlet Filter Events.
Elements | application event-date event-type session-id user-id document-type document-id campaign-id scenario-id application-name (name of storefront, not portal application) placeholder-id