Documentation Center

Configuring Experience Optimization in the deprecated in-process API

Edit smarttarget_conf.xml in the configuration location of your Web site to configure Fredhopper and Experience Optimization.

Procedure

  1. In your configuration folder, open smarttarget_conf.xml for editing.
  2. Find the <FredHopper> section.
  3. If your Fredhopper setup does not use catalog01 as 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 has catalog01 as its default (and only) Universe.
  4. 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 as en_GB or fr_BE. By default, standard language (ISO-639) and country (ISO-3166) codes are supported.
  5. Find the <IndexServer> subsection.
  6. In the <Timeouts> subsection, set the following timeout values:
    1. Set Localization to the number of milliseconds you want Experience Optimization to take for retrieving the Segment titles that are displayed in the Business Manager instead of the Segment Content Manager URI value.
    2. Set Triggers to the number of milliseconds you want Experience Optimization to take retrieving the list of triggers from Fredhopper, as defined in trigger-types.xml.
  7. Find the <QueryServer> section and set the value of the Url subelement to one of the following:
    • If Fredhopper runs in an on-premise environment, set Url to http://HOST:9180, where HOST is the host name of the machine on which the Fredhopper Query Server runs.
    • If Fredhopper runs in the Cloud, set Url to the URL provided for you by Fredhopper (for example, for an EU-hosted server, the URL would be http://query.published.live1.fas.eu1.fredhopperservices.com/).
  8. If Fredhopper runs in the Cloud, also add the following within the <QueryServer> section, below the Url element:
    <Authentication>
      <Username>USER</Username>
      <Password>PASSWORD</Password>
    </Authentication>

    where USER and PASSWORD are valid username and password, respectively, that grant you access to the Fredhopper Query Server.

  9. 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.
  10. Find the <SmartTarget> section.
  11. Set the value of the TimeZoneOffset element 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, set TimeZoneOffset to +5:30.
  12. In the Analytics element, set the value of the implementationClass attribute to the fully qualified class name of the Java class that implements the analytics provider. This value defaults to com.tridion.smarttarget.analytics.GoogleAnalyticsManager, the implementation class for Google Analytics, which Experience Optimization ships with.
  13. In the Analytics element, set the value of the trackingRedirectUrl attribute to relative URL to your Web site redirects folder, by default /redirect/.
  14. In the Analytics element, set the value of the timeoutMilliseconds attribute to the time in milliseconds to wait to retrieve the Experiment from the analytics provider before timing out.
  15. In the Analytics section, specify parameters for the analytics provider you specified in the implementationClass attribute. If you chose the default Google Analytics provider, set values for the following subelements:
    ElementDescription of value
    ServiceAccountEmailAddressThe e-mail address you created in the Google Developers Console
    PrivatekeyPathThe full path and filename of the P12 key you created
    AccountIdThe ID of the Google Analytics account you created
    TrackingIdThe Tracking ID of the Google Analytics account
    ViewIdThe View ID of the view you created in Google Analytics
  16. If you use the default Google Analytics provider, in the CustomDimensions subsection, also specify the IDs of the custom dimensions you created in the subelements:
    ElementDescription of value
    ExperimentIdExperiment ID
    InstanceIdInstance ID
    PublicationIdPublication ID
    PageIdPage ID
    RegionIdRegion ID
    ComponentIdComponent ID
    ComponentTemplateIdComponentTemplate ID
    ChosenVariantChosenVariant
  17. In the <DefaultValues> section, set the value of <AllowDuplicates> to true if 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.
  18. Set the value of the <Referrers> element to the file name of your referrers file, typically smarttarget.referrers.xml.
  19. 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.
    • prefix is the prefix value used instead of the full Claim URI: when you define Trigger Types, you specify the url-param attribute 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_ex is mapped to the generic part of the URI taf_claim_audiencemanager_contact_extendeddetail so that you just need to add the specific field to the Claim prefix, in this case am_ex_age, to address that field.
    Default prefixes for Audience Manager
    The following default prefixes are configured in the smarttarget_conf.xml file 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.xml file 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.
  20. To allow other applications to use Experience Optimization data (Promotion, Page Regions and content items), within the <AmbientData> section, set the value of <AddSmartTargetDataToClaimStore> to true. Doing so adds such data to the Ambient Data Framework Claim Store for other applications to retrieve.
  21. Leave all other elements and attributes set to their default values.
  22. Save and close smarttarget_conf.xml.