Removes a profile marker from a profile.
Class Name |
|
|---|---|
Component |
|
Required Input Parameters
key
The value in the marker’s key property. Set this parameter to ANY_VALUE to indicate that the marker’s key value is irrelevant for your purposes. For example:
<dsp:param name="key" bean="RemoveMarkersFromProfileDroplet.ANY_VALUE"/>
Optional Input Parameters
itemId
The ID for the profile that has markers to be removed. If omitted, the value indicated in the item input parameter is used.
item
The profile item that that has profile markers to be removed. If omitted, the active profile is used.
value
The value in the markers’ value property. Set this parameter to NULL or omit it in order to remove the markers only if their value property is null.
Set this parameter to ANY_VALUE to indicate that the markers’ value value are irrelevant for your purposes. For example:
<dsp:param name="value"
bean="RemoveMarkersFromProfileDroplet.ANY_VALUE"/>
data
The value in the markers’ data property. Set this parameter to NULL or omit it to remove the markers only if their data property is null.
Set this parameter to ANY_VALUE to indicate that the markers’ data value is irrelevant for your purposes. For example:
<dsp:param name="data"
bean="RemoveMarkersFromProfileDroplet.ANY_VALUE"/>
extendedProperties
A map that specifies any additional marker properties (set to the map’s key) and property values (set to the map’s value) that must exist on the profile marker in order for it to be removed.
markerManager
The Profile Marker Manager component to use. If omitted, the Profile Marker Manager indicated in the servlet bean’s repositoryMarkerManager property is used.
markerPropertyName
The property on the profile whose markers are to be removed. If omitted, the servlet bean uses the default value specified in its defaultMarkerPropertyName property.
markedItemType
The type of RepositoryItem with markers to be removed. If omitted, the servlet bean uses the default value specified in its defaultMarkedItemType property.
Output Parameters
markerCount
Contains the number of profile markers removed from the profile during this servlet bean’s execution.
errorMsg
Contains any error messages generated during the servlet bean’s execution.
Open Parameters
output
Rendered when the profile markers are removed from the profile.
error
Rendered when an error occurs during marker removal.
Usage Notes
RemoveMarkersFromProfile works with the Profile Marker Manager to remove the markers from a particular profile that have the key, value, data, and other marker property values that you specify.
For more information on removing profile markers, see the Removing Profile Markers section in the Using Profile Markers chapter of the ATG Personalization Programming Guide.
Example
The following example shows how to remove all markers with a key of partner and a value of travelSiteA from the active user’s profile.
<dsp:droplet name="/atg/markers/userprofiling/droplet/RemoveMarkersFromProfileDroplet"> <dsp:param name="key" value="partner"/> <dsp:param name="value" value="travelSiteA"/> <dsp:param name="data" bean="RemoveMarkersFromProfileDroplet.ANY_VALUE"/> </dsp:droplet>
