Documentation Center

Installing SmartTarget on premise

SmartTarget provides API extensions, a Kettle job, and default Fredhopper configuration files that you need to install in your Fredhopper installation. The following instructions describe installing SmartTarget extensions in your Fredhopper environment can be running on premise or in the cloud: if running on premise, follow the instructions in this section, otherwise provide the files to your Fredhopper system administrator for installation in the cloud.

Before you begin

This task summarizes the instructions for installing the Fredhopper Deployment Package: refer to the Fredhopper Learning Center for detailed information, including prerequisites.

Procedure

  1. Read the Prerequisites for Fredhopper to make sure you know which version of Fredhopper is supported for on premise and cloud installation.
  2. Download and install the Fredhopper Deployment Package.
  3. Edit your topology.txt file, for example:
    <INDEXER>|localhost|1|-|Indexer and Preview environment for demo setup
    <QUERY>|localhost|2|<INDEXER>|Live Query Server for demo setup
  4. Run the following command to start your deployment agent:
    bin\deployment-agent
  5. Run the following command to create your Fredhopper cluster:
    bin\setup-cluster
  6. Create the following directories:
    1. In the <BASE_DIRECTORY>\data\instances\<INDEXER> directory, create a directory called \custom.
    2. In the <BASE_DIRECTORY>\<INDEXER>\data\fas-xml-incremental\ directory, create a directory called the name of your universe, for example:
      <BASE_DIRECTORY>\<INDEXER>\data\fas-xml-incremental\<CATALOG01>
  7. Add metadata.xml to the following Fredhopper installation directory:
    <BASE_DIRECTORY>\<INDEXER>\data\fas-xml-incremental\<CATALOG01>
    The metadata.xml is available on the SmartTarget installation media in the Fredhopper extensions\data folder
  8. Add trigger-types.xml and business.xml to the following Fredhopper installation directory:
    <BASE_DIRECTORY>\data\instances\<INDEXER>\config
    The trigger-types.xml and business.xml are available on the SmartTarget installation media in the Fredhopper extensions\configuration folder
  9. Run the following command to start the Indexer instance:
    bin\instance <INDEXER> start
  10. Install the API extensions:
    1. Access the SmartTarget installation media.
    2. In the Fredhopper extensions folder, copy the following JAR files to the \custom directory:
      • smarttarget_api_extension.jar
      • configuration-management-rest-extension.jar
      <BASE_DIRECTORY>\data\instances\<INDEXER>\custom
    3. Restart the Query Server running on the Index Server:
      bin\deployment-agent-client --location localhost invoke <INDEXER> qserver stop
      bin\deployment-agent-client --location localhost invoke <INDEXER> qserver start
  11. Add the Kettle job to your Fredhopper installation:
    1. Access the SmartTarget installation media.
    2. In the Fredhopper extensions folder, copy the STJob.kjb file to the following directory:
      <BASE_DIRECTORY>\data\instances\etl
    3. Load the metadata.xml file by running the following command from the root of the Fredhopper installation:
      bin\run-etl-job STJob.kjb "-DINSTANCE=<INDEXER>" "-DTRIGGER=load-data" "-DUNIVERSE=catalog01" "-DEXECUTIONPATH=<BASE_DIRECTORY>/data/instances/<INDEXER>/custom/"