Audience Manager cartridge specifications
This topic describes the Audience Manager cartridge XML file and Claim Processors.
Cartridge XML file
The Audience Manager cartridge XML file audiencemanager_cartridge_conf.xml links the Audience Manager together and specifies the Input and Output Claims for each processor. The audiencemanager_cartridge_conf.xml is packaged in the audiencemanager_cartridge.jar and is preconfigured in the Ambient Data Framework cd_ambient_conf.xml configuration file.
Claim Processors
The Claim Processors used in the Audience Manager cartridge are packaged in the audiencemanager_cartridge.jar:
ContactIdClaimProcessorContactDetailClaimProcessorContactExtendedDetailClaimProcessorContactKeywordClaimProcessorContactEnumerationsClaimProcessorContactSegmentsClaimProcessor
The JAR file also contains the AudienceManagerProcessorConfigProvider class for dynamically extracting Contact Extended details and the AudienceManagerCartridgeConstants class which contains constants used by the Claim Processors.
- Contact ID Claim Processor
-
Retrieves the Contact ID that is used by subsequent Claim Processors to identify an Audience Manager Contact. The Contact ID is retrieved from the following sources:
- In a SiteEdit-enabled Web site, using an HTTP header called
x-audiencemanager-contactidThe HTTP header is used in a SiteEdit-enabled Web site to allow SiteEdit users to view the Web site as different users without having to constantly log on. If both attributes are present, the HTTP header takes precedence over the session attribute (the value of the HTTP header is used and the session attribute is ignored).
- In a live Web site, using a session attribute with the key
taf:claim:audiencemanager:contact:idTo put the Contact ID into the session you have to add coding, for example:
request.getSession().setAttribute("taf:claim:audiencemanager:contact:id", contactId);
- In a SiteEdit-enabled Web site, using an HTTP header called
- Contact Details Claim Processor
-
Takes the Contact ID and transforms it into standard Contact details. The Claim Processor has the following Input Claim:
Input Claim Input type taf:claim:audiencemanager:contact:idString The Claim Processor has the following Output Claims:
Output Claim Output type taf:claim:audiencemanager:contact:emailaddressString taf:claim:audiencemanager:contact:emailtypeInteger taf:claim:audiencemanager:contact:bouncestatusInteger taf:claim:audiencemanager:contact:subscribestatusInteger taf:claim:audiencemanager:contact:enabledBoolean taf:claim:audiencemanager:contact:groupidInteger taf:claim:audiencemanager:contact:creationdateDate - Contact Extended Details Claim Processor
-
Takes the Contact ID and transforms it into Contact Extended Details (implementation-specific custom Contact details). The Claim Processor has the following Input Claim:
Input Claim Input type taf:claim:audiencemanager:contact:idString The Claim Processor has the following Output Claims:
Output Claim The AudienceManagerProcessorConfigProvider.classimplements theClaimProcessorConfigProviderinterface to provide configuration information for this Claim Processor. The class dynamically determines the Contact Extended Details which are extracted as Output Claims. - Contact Keyword Claim Processor
- Takes the Contact ID and transforms it into a list of a Contact's Keywords. The Claim Processor has the following Input Claim:
- Contact Enumerations Claim Processor
- Creates the following user-friendly names (visible in interfaces such as the SmartTarget Manager) from enumeration values:
- Contact Segments Claim Processor
- Takes the Contact ID and transforms it into a list of Segments which the Contact belongs to. The Claim Processor has the following Input Claim: