Oracle ATG Web Commerce - ProfilePropertyUpdate Event

ProfilePropertyUpdate Event

This event is triggered when a site visitor changes the value of a specific profile property by way of an implementation of the profile form handler.

Examples:

Changes Marital status from single to married
Changes Home address’s city to Boston
Changes Interests by removing dancing

You can define the properties that trigger the event through the propertiesToSendUpdateEvents property of the ProfileUpdateTrigger component. By default, a change to any profile property triggers this event. See /atg/userprofiling/ProfileUpdateTrigger for more information.

The Personalization module sends a separate instance of the ProfilePropertyUpdate message for every value that is changed. For example, if a visitor changes five property values during the same form submission, the Personalization module sends five messages to the Scenario Manager.

See also the description of the Update User Profile element.

Class name

atg.userprofiling.dms.ProfilePropertyUpdateMessage

JMS name

atg.dps.ProfilePropertyUpdate

Display name

Profile property updated by user

Message context

Request

Message scope

Individual

Message source

Component: /atg/userprofiling/DPSMessageSource

Class: atg.userprofiling.dms.DPSMessageSource

Component that calls the message source

/atg/userprofiling/ProfileUpdateTrigger

How this event is triggered

Triggered by the postUpdateUser() methods in the ProfileFormHandler and MultiProfileUpdateFormHandler.

How to turn this event off

Set to false the generateProfileUpdateEvents property in the /atg/userprofiling/ProfileUpdateTrigger component.

The message that triggers this event contains the following properties:

Property	Type	Scenario editor label
`propertyPath`	`java.lang.String`	`by changing <property list>`
	The name of the property that has changed, for example `maritalStatus` or `homeAddress.city`
`oldValue`	`java.lang.Object`	`where old value`
	The old value of the property, before it was changed.
`newValue`	`java.lang.Object`	`where new value`
	The new value of the property, after it was changed.
`changeSign`	`int`	Does not appear.
	An integer representing whether the new value is greater than, less than, or equal to the old value. A positive `changeSign` value indicates that the new property value is greater than the old, a negative value indicates that it is less than the old, and zero indicates that they are equal or not comparable.
`changePercentage`	`double`	Does not appear.
	For number type properties only, the absolute value of the percent difference between the old and new values.
`changeAmount`	`double`	Does not appear.
	For number type properties only, the absolute difference between the old value and the new value
`elementsAdded`	`java.lang.Object[]`	Does not appear.
	If the changed property is an array or Collection, `elementsAdded` is the array of items that are members of the new value but not members of the old value.
`elementsRemoved`	`java.lang.Object[]`	Does not appear.
	If the changed property is an array or Collection, `elementsRemoved` is the array of items that are members of the old value but not members of the new value.
`profileId`	`java.lang.String`	Does not appear.
	The profile ID of the visitor whose profile property has changed.
`reportingOldValue`	`java.lang.String`	Does not appear.
	A text representation of the value of the `oldValue` property. This property is used for reporting.
`reportingNewValue`	`java.lang.String`	Does not appear.
	A text representation of the value of the `newValue` property. This property is used for reporting.
`reportingChangeSign`	`java.lang.String`	Does not appear.
	A text representation of the value of the `changeSign` property. This property is used for reporting.
`reportingChangeAmount`	`double`	Does not appear.
	A Double representation of the value of the `changeAmount` property. This property is used for reporting.
`reportingChangePercentage`	`double`	Does not appear.
	A Double representation of the value of the `changePercentage` property. This property is used for reporting.
`reportingElementsAdded`	`java.lang.String`	Does not appear.
	A comma-separated representation of the contents of the `elementsAdded` property. This property is used for reporting.
`reportingElementsRemoved`	`java.lang.String`	Does not appear.
	A comma-separated representation of the contents of the `elementsRemoved` property. This property is used for reporting.
`siteId`	`java.lang.String`	Does not appear.
	The ID of the current site. The value is provided by the Site Context Manager. This parameter applies to multisite environments.

ProfilePropertyUpdate Event

ATG Personalization Programming Guide