Announcement: You can find the guides for Commerce 7.5 and later on the new Elastic Path Documentation site. The Developer Center continues to support Commerce 6.13.0 through 7.4.1.Visit new site

Product Search Keyword Tracking

Product Search Keyword Tracking

Product search keywords in the Cortex are automatically stored in the TSEARCHTERMS table. To track the usage of product keywords, a Commerce Manager Quartz job named searchTermsAggregatorJob periodically scans TSEARCHTERMS and finds the frequency of a keyword as well as its last access date. The output of searchTermsAggregatorJob is stored in the TSEARCHTERMSACTIVITYSUMMARY table.

Activating searchTermsAggregatorJob

By default, searchTermsAggregatorJob, is disabled. To enable the job, follow the steps below:

Note: Before You Begin

You have a Core extension project hooked up to your Commerce Manager Server.

  1. With an XML editor, open your .m2\settings.xml.
  2. Above the </profiles> tag, add the following profile:
    <profile>
    	<id>search-terms-aggregator</id>
        <properties>
    		<ep.cm.triggers.searchterms.aggregator>
    			searchTermsAggregatorTriggers
    		</ep.cm.triggers.searchterms.aggregator>
        </properties>
    </profile>
  3. Add the following active profile under <activeProfiles>:
    <activeProfile>search-terms-aggregator</activeProfile>
  4. Save your changes.
  5. With an XML editor, open your Core extension's ep-core-plugin.xml.
  6. Add the following alias before the </beans> tag:
    <alias name="loggingSearchTermsActivityStrategy" alias="searchTermsActivityStrategy"/>
  7. Save your changes.
  8. Rebuild your Core extension project and Commerce Manager Server to apply your changes.

Configuring searchTermsAggregatorJob

You can configure the start delay and repeat interval of searchTermsAggregatorJob in the ep.properties file. See Configuring Environment Specific Settings for more information.