ClassName

atg.markers.userprofiling.droplet.RemoveMarkersFromProfile

Component

/atg/markers/userprofiling/droplet/RemoveMarkersFromProfile
Droplet

This servlet bean 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 you specify.

For more information on removing profile markers, see the RemovingProfileMarkers section in the UsingProfileMarkers chapter of the ATG Personalization Programming Guide.

Input Parameters

itemId
Specifies the ID for the profile that has markers you want to remove. If none is specified here, the value indicated in the item input parameter is used.

item
Specifies the profile item that that has profile markers you want to remove. If none is specified here, the active profile is used.

key
This required parameter specifies the value in the marker’s key property. By setting this parameter to ANY_VALUE, you indicate that the marker’s key value is irrelevant for your purposes. For example:

<dsp:param name="key" bean="RemoveMarkersFromProfileDroplet.ANY_VALUE"/>

value
Specifies the value in the markers’ value property. You can set this parameter to NULL or omit it altogether if you want the markers to be removed only if their value property is null. By setting this parameter to ANY_VALUE, you indicate that the markers’ value value are irrelevant for your purposes. For example:

<dsp:param name="value"
bean="RemoveMarkersFromProfileDroplet.ANY_VALUE"/>

data
Specifies the value in the markers’ data property. You can set this parameter to NULL or omit it altogether if you want the markers to be removed only if their data property is null. By setting this parameter to ANY_VALUE, you indicate that the markers’ data value is irrelevant for your purposes. For example:

<dsp:param name="data"
bean="RemoveMarkersFromProfileDroplet.ANY_VALUE"/>

extendedProperties
This parameter is 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
This parameter indicates the Profile Marker Manager component to use. If a Profile Marker Manager is not specified here, the Profile Marker Manager indicated in the servlet bean’s repositoryMarkerManager property is used.

markerPropertyName
Specifies the property on the profile from which you want to remove markers. If a property is not specified here, the servlet bean uses the default value specified in its defaultMarkerPropertyName property.

markedItemType
Specifies the type of RepositoryItem that has markers you want to remove. If a repository item type is not specified here, the servlet bean uses the default value specified in its defaultMarkedItemType property.

Output Parameters

markerCount
This parameter contains the number of profile markers removed from the profile during this servlet bean’s execution.

errorMsg
This parameter contains any error messages generated during the servlet bean’s execution.

Open Parameters

output
This parameter is rendered when the profile markers are removed from the profile.

error
This parameter is rendered when an error occurs during marker removal.

Example

This 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>
 
loading table of contents...