Ambient Data Framework
The Ambient Data Framework allows you to gather and transform website data, such as information about your visitor or about the current session and implement specific functionality by creating your own Claim Processors and organizing them into cartridges that plug into the framework.
- Ambient Data Framework system diagram
To implement the Ambient Data Framework, you add a client (a servlet filter) to your web application. The client communicates with the Ambient Data Framework service, available through a Content Delivery microservice (typically the Content Service). The Ambient Data Framework service combines Claims, Claim Processors and Cartridges. - Installing the Ambient Data Framework client
Set up the Ambient Data Framework client in one or more Content Delivery roles running as (part of) your web application(s). - Claim Processors
A Claim Processor is piece of Java code that puts Claims into the Claim Store and converts Input Claims to Output Claims. A Claim Processor responds to request or session events called by the framework. You develop Claim Processors using the Ambient Data Framework API. - Claims
The Ambient Data Framework gathers information about users visiting a website and puts these pieces of information (called Claims) into the Claim Store. You can develop cartridges to use and transform these Claims. The framework gathers the actual values of a set of Claims when an HTTP request is made. - Cartridges
You can hook into and use the Ambient Data Framework by implementing cartridges. A cartridge is a package of related Claim Processors that perform a certain task. - Customizing the Ambient Data Framework
This section describes how you can customize the Ambient Data Framework. In the Ambient Data Framework configuration file, you can specify configuration strings as hardcoded values or as parameters. - Excluding paths from the Ambient Data Framework filter
You do not want the Ambient Data Framework filter to run when accessing certain paths on the Web site (for example, the httpupload/ path on which the upload servlet is listening). You need to exclude such paths from filtering in the Ambient Data Framework configuration file. - Forwarding claims from a client to a Web service
You can set up the Ambient Data Framework to allow a client to include claims in a request sent to the Web service. This section explains how to do this. - Ambient Data Framework cartridge configuration reference
cd_ambient_cartridge_conf.xml specifies the Claims and Claims Processors for a Cartridge. The configuration reference documentation describes the elements and attributes contained in the configuration file. - Ambient Data Framework configuration reference
cd_ambient_conf.xml specifies cookie settings, security settings, and a list of Cartridges. The configuration reference documentation describes the elements and attributes contained in the configuration file. In configuration files like cd_ambient_conf.xml, we use parameters instead of hardcoded or literal strings for some configuration values.