Collectors

Note: For definitions of collector, visitor, and visit, see Relevance Concepts and Terminology.

Configuration

Collectors are configured in the Java Content Repository (JCR) at the following path:

/targeting:targeting/targeting:collectors

Each child node under this path represents a collector. The node name serves as the collector's ID. Each collector node requires the following property:

• targeting:className: The fully qualified Java class name of the collector implementation.

Example configuration:

/targeting:targeting/targeting:collectors:
  /geo:
    jcr:primaryType: targeting:collector
    targeting:className: com.onehippo.cms7.targeting.collectors.GeoIPCollector
copy

Some collectors support additional configuration properties. For details, see Collector Configurations.

Available Collectors

The following collectors are included by default:

Class Name*	Collected Targeting Data	Update Frequency
ChannelCollector	IDs of all visited channels	Every request
DayOfWeekCollector	Day of the week when a channel is visited (based on server time)	Every request
DocumentTypesCollector	Types of documents viewed by the user (relative content beans of visited pages)	Every request
GeoIPCollector	Visitor's city, country, continent, latitude, and longitude (based on IP address)	Every new visit
GroupsCollector	Group membership of a logged-in visitor	Every request
PageViewsCollector	URLs of visited pages	Every request
ReferrerCollector	Referring web page that led the visitor to the site	First visit
ReturningVisitorCollector	Indicates if the visitor has previously visited the site	Every new visit
TagsCollector	All tags on documents viewed by the user (tags on relative content beans of visited pages)	Every request
SiteSearchKeywordsCollector	Keywords used in site searches	Every request

* All collectors listed above are in the com.onehippo.cms7.targeting.collectors package.

To quickly configure commonly used collectors, you can use the Collectors Bundle.

REST Service

All targeting data collected for the current user is accessible through the Relevance REST service. The Content Management System (CMS) uses this REST service to display data in the Content audiences application.

Info: This product includes GeoLite2 data created by MaxMind, available from http://www.maxmind.com.