Documentation Center

Upgrading smarttarget_conf.xml file

The smarttarget_conf.xml file has changed in SmartTarget 2014 SP1. Use the configuration_upgrade.jar to migrate the file and then manually configure the <TimeZoneOffset> element and <Analytics> section for Experiments.

Procedure

  1. Back up your smarttarget_conf.xml configuration file—for example, create a copy of the file called smarttarget_conf_old.xml.
  2. Open a command prompt.
  3. Access the SmartTarget installation media.
  4. Access the Migration\ directory.
  5. Run the configuration_upgrade.jar using the following command:
    java -jar configuration_upgrade.jar "/filepath/smarttarget_conf.xml"
    where filepath specifies the location to your smarttarget_conf.xml file.

    A smarttarget_conf.xml.upgraded file is created containing old settings migrated to a new file.

  6. Open smarttarget_conf.xml.upgraded in a text editor and check the migrated settings.
  7. If you are upgrading from SmartTarget 2011 SP3, SP2, or SP1:
    1. In the <IndexServer> element, change the <Location> setting as this has changed (SmartTarget deployment now makes use of the Fredhopper Deployment Agent):
      The following is an example of old smarttarget_conf.xml setting:
      <Location>c:/fredhopper/instance01/FAS/data/xml/incoming/batch/</Location>
      The following is an example of the new smarttarget_conf.xml setting:
      <Location>c:/fredhopper/indexer/data/fas-xml-incremental/catalog01</Location>
    2. In the <Regions> element, add the names (case-sensitive) of your Page Regions. For example:
      <Regions>
         <Region>Header</Region>
         <Region>Footer</Region>
         <Region>Sidebar</Region>
         <Region>Inset 1</Region>
         <Region>Inset 2</Region>
       </Regions>
  8. Set the <TimeZoneOffset> element and in the <Analytics> section enter details of your Google Analytics account:
    <TimeZoneOffset>0</TimeZoneOffset>
      <!--  Analytics  -->
      <Analytics implementationClass="com.tridion.smarttarget.analytics.google.GoogleAnalyticsManager" timeoutMilliseconds="5000" trackingRedirectUrl="/redirect/">
        <ServiceAccountEmailAddress/>
        <PrivatekeyPath/>
        <AccountId/>
        <TrackingId/>
        <ViewId/>
        <CustomDimensions>
        <ExperimentId>dimension1</ExperimentId>
        <PublicationTargetId>dimension2</PublicationTargetId>
        <PublicationId>dimension3</PublicationId>
        <PageId>dimension4</PageId>
        <Region>dimension5</Region>
        <ComponentId>dimension6</ComponentId>
        <ComponentTemplateId>dimension7</ComponentTemplateId>
        <ChosenVariant>dimension8</ChosenVariant>
        </CustomDimensions>
      </Analytics>
    The <Analytics> element has the following properties:
    PropertyDescription
    implementationClassThe class that implements the analytics provider.
    trackingRedirectUrlA relative URL to your Web site redirects folder, by default "/redirect/".
    timeoutMillisecondsThe time in milliseconds to wait to retrieve the Experiment from the analytics provider before timing out.
    The <Analytics> element has the following child elements:
    ServiceAccountEmailAddress
    The email account created when you created a Project in the Google Console Developer.
    PrivatekeyPath
    The path to the location of the P12 key generated when you created a Project in the Google Console Developer, for C:/Google/MyProject RS-8235a2fedac7.p12.
    AccountId
    The Account ID created when you set up Google Analytics.
    TrackingId
    The Tracking ID created when you set up Google Analytics.
    ViewId
    The View ID created when you set up Google Analytics.
    CustomDimensions
    The custom dimensions created when you set up Google Analytics to bring Content Manager data into the platform:
    ElementValue
    ExperimentIddimension1
    PublicationTargetIddimension2
    PublicationIddimension3
    PageIddimension4
    Regiondimension5
    ComponentIddimension6
    ComponentTemplateIddimension7
    ChosenVariantdimension8
  9. Save your smarttarget_conf.xml.upgraded file as smarttarget_conf.xml.
  10. In the <SmartTarget><TimeZoneOffset> section of the smarttarget_conf.xml configuration file, enter the offset:
    <TimeZoneOffset>0</TimeZoneOffset>
    For example:
    <TimeZoneOffset>Description
    -7The Content Manager system is in a time zone 7 hours earlier than the Content Delivery system.
    -7:45The Content Manager system is in a time zone 7 hours and 45 minutes earlier than the Content Delivery system.
    +5The Content Manager system is in a time zone 5 hours later than the Content Delivery system.
    +5:30The Content Manager system is in a time zone 5 hours and 30 minutes later than the Content Delivery system.
  11. Save smarttarget_conf.xml.
  12. Copy smarttarget_conf.xml to the following locations:
    Application using smarttarget_confFile path
    Content Delivery server%TRIDION_HOME%\config
    .NET Web application (Presentation Server)bin\config
    Java Web application (Presentation Server)WEB_INF/classes
    SmartTarget Deployment Web servicebin\config
    Content Delivery Web service (for each Fredhopper system)bin\config or WEB_INF/classes