Configuring Experience Optimization in your RESTful API
Configure Fredhopper and Experience Optimization settings in the Experience Optimization configuration file, smarttarget_conf.xml.
Procedure
- In the configuration location of your Web site, open smarttarget_conf.xml for editing.
- Find the
<FredHopper>section. - If your Fredhopper setup does not use
catalog01as its default Universe, set the value of the<DefaultUniverse>element to the default universe used by Fredhopper. A Universe is a collection of items that are held together in a categorization. The top level category in the categorization is the Universe. Typically, Fredhopper hascatalog01as its default (and only) Universe. - If your Fredhopper setup does not use US English as its default locale, set the value of the
<DefaultLocale>element to the default locale used by Fredhopper. The locale is a language-region combination, typically written as a language code in lower case, underscore, and a country code in upper case, such asen_GBorfr_BE. By default, standard language (ISO-639) and country (ISO-3166) codes are supported. - Find the
<IndexServer>section, and within it, the<Timeouts>subsection. - Set
Triggersto the number of milliseconds you want Experience Optimization to take retrieving the list of triggers from Fredhopper, as defined in trigger-types.xml. - In the
<Timeouts>subsection of<QueryServer>, set the value of<Query>to the maximum amount of milliseconds to take executing a Fredhopper query before displaying fallback content in the Page Region. - Find the
<SmartTarget>section. - Set the value of the
TimeZoneOffsetelement to the difference, in hours and minutes, from the Content Delivery system to the Content Manager system's local server time. For example, if the local time in the Content Manager server location is 5 and a half hours later than the local time in the Content Delivery server location, setTimeZoneOffsetto+5:30. - In the
Analyticselement, set the value of thetrackingRedirectUrlattribute to relative URL to your Web site redirects folder, by default/redirect/. - In the
Analyticselement, set the value of thetimeoutMillisecondsattribute to the time in milliseconds to wait to retrieve the Experiment from the analytics provider before timing out. - In the
<DefaultValues>section, set the value of<AllowDuplicates>totrueif you want to allow Promotions that are already in the output of preceding regions on this Page to also be displayed in this page region. - Set the value of the
<Referrers>element to the file name of your referrers file, typically smarttarget.referrers.xml. - In the
<AmbientData>section, in the<Prefixes>subsection, map the URI of Claims to a unique prefix using the format<ClaimURI>prefix</ClaimURI>where:<ClaimURI>is the URI up to the last subpart of the String separated by underscores: the pattern that matches the prefix to the URI of a resource matches everything but the last term in the URI string.prefixis the prefix value used instead of the full Claim URI: when you define Trigger Types, you specify theurl-paramattribute which consists of the Claim URI prefix and the last subpart of the URI string.
<AmbientData> <Prefixes> <taf_claim_audiencemanager_contact>am</taf_claim_audiencemanager_contact> <taf_claim_audiencemanager_contact_extendeddetail>am_ex</taf_claim_audiencemanager_contact_extendeddetail> <taf_claim_ambientdata_sessioncartridge>sc</taf_claim_ambientdata_sessioncartridge> <taf_claim_ambientdata_sessioncartridge_session>sc_session</taf_claim_ambientdata_sessioncartridge_session> <taf_claim_ambientdata_sessioncartridge_useragent>sc_ua</taf_claim_ambientdata_sessioncartridge_useragent> <taf_claim_ambientdata_sessioncartridge_useragent_browser>sc_ua_browser</taf_claim_ambientdata_sessioncartridge_useragent_browser> <taf_claim_ambientdata_sessioncartridge_useragent_os>sc_ua_os</taf_claim_ambientdata_sessioncartridge_useragent_os> <taf_claim_ambientdata_sessioncartridge_authorization>sc_auth</taf_claim_ambientdata_sessioncartridge_authorization> </Prefixes> </AmbientData>- Example
- In Audience Manager for example, where a full Claim URI for a Contact extended detail such as Age is
taf_claim_audiencemanager_contact_extendeddetail_age-
in the Claim Store, the Claim Prefix
am_exis mapped to the generic part of the URItaf_claim_audiencemanager_contact_extendeddetailso that you just need to add the specific field to the Claim prefix, in this caseam_ex_age, to address that field.Note: Colons (:) are used to separate the subparts of Claim URIs in the Claim Store. These are replaced with underscores (_) when patterns are matched against thesmarttarget_conf.xmlfile. - Default prefixes for Audience Manager
-
The following default prefixes are configured in the
smarttarget_conf.xmlfile for Claim URIs inserted by the Audience Manager cartridge:<taf_claim_audiencemanager_contact>am-
Maps to Claim URIs containing a Contact's regular details, for example
BounceStatus. <taf_claim_audiencemanager_contact_extendeddetail>am_ex-
Maps to Claim URIs containing a Contact's Extended Details, for example
name.
- Default prefixes for session data
-
The following default prefixes are configured in the
smarttarget_conf.xmlfile for Claim URIs inserted by the Session cartridge:<taf_claim_ambientdata_sessioncartridge>sc- Maps the generic part of Claim URIs inserted by a Session cartridge to a prefix.
<taf_claim_ambientdata_sessioncartridge_session>sc_session- Maps to a Claim URI containing the value of the session length (the maximum duration of the user session specified in minutes).
<taf_claim_ambientdata_sessioncartridge_useragent>sc_ua- Maps to the following Claim URIs.
-
- The visitor browser used when making the HTTP request.
- The visitor search engine (whether the client application making the request is a Web robot).
- The visitor operating system used by the client application making the HTTP request.
<taf_claim_ambientdata_sessioncartridge_useragent_browser>sc_ua_browser- Maps to a Claim URI containing the value of the Web browser that was used when making the HTTP request.
<taf_claim_ambientdata_sessioncartridge_useragent_os>sc_ua_os- Maps to a Claim URI containing the value of the operating system used by the client application making the HTTP request.
<taf_claim_ambientdata_sessioncartridge_authorization>sc_auth-
Maps to the following Claim URIs:
- Whether the user has been authenticated (they are who they claim to be).
- The authorization mechanism used for communication.
- To allow other applications to use Experience Optimization data (Promotion, Page Regions and content items), within the
<AmbientData>section, set the value of<AddSmartTargetDataToClaimStore>totrue. Doing so adds such data to the Ambient Data Framework Claim Store for other applications to retrieve. - Leave all other elements and attributes set to their default values.
- Save and close smarttarget_conf.xml.