Implementing the Plugin

You can implement the Bloomreach Feed plugin, which works with Elastic Path Catalog Syndication, to send your catalog in the Bloomreach (TSV) Tab Separated Value format.

Before You Begin

Ensure that you are an Elastic Path Catalog Syndication consumer. For more information about catalog syndication, see Catalog Syndication Overview.

Adding the Dependency for the Bloomreach Feed Plugin

1. In the ep-commerce/extensions/batch/ext-batch/pom.xml file, add the following dependency:

     <dependency>
           <groupId>com.elasticpath.plugins</groupId>
           <artifactId>bloomreach-feed</artifactId>
           <version>1.0.0</version>
         </dependency>
     <dependency>
           <groupId>com.elasticpath</groupId>
           <artifactId>ep-messaging-camel</artifactId>
           <version>${dce.version}</version>
     </dependency>
     <dependency>
           <groupId>com.elasticpath</groupId>
           <artifactId>ep-catalog-projection-spring-data</artifactId>
           <version>${dce.version}</version>
     </dependency>
     <dependency>
           <groupId>com.elasticpath</groupId>
           <artifactId>ep-catalog-batch</artifactId>
           <version>${dce.version}</version>
     </dependency>
       ```
   
   

2. In the ep-commerce/extensions/batch/ext-batch-webapp/src/main/filtered-resources folder, add a property file with the name bloomreachFeedUploader.properties.

3. In the bloomreachFeedUploader.properties file, add the following properties:

   • outputDirectory
   • outputFileName
   • storeLanguage
   • currency
   • storeCode
   • ftp.host
   • ftp.username
   • ftp.password
   • readerPageSize

   Note: For more information about the properties, see the Bloomreach Feed Plugin Properties File section.

4. Edit the ep-commerce/extensions/batch/ext-batch-webapp/src/main/webapp/WEB-INF/elastic-path-servlet.xml file, in the context element, add the location of the bloomreachFeedUploader.properties file to the location attribute. The following example shows an updated context element:

   <context:property-placeholder
       ignore-resource-not-found="true"
       system-properties-mode="OVERRIDE"
       location="
           classpath*:META-INF/elasticpath/conf/spring/plugin.properties,
           classpath:module.properties,
           classpath:bloomreachFeedUploader.properties,
           file:/etc/ep/ep.properties,
           file:/ep/conf/ep.properties,
           file:/ep/conf/ep.batch.properties,
           file:${user.home}/ep/ep.properties,
           file:${user.home}/ep/conf/ep.properties,
           file:${user.home}/ep/conf/ep.batch.properties"/>
   

5. Run mvn clean install to rebuild the extensions and batch files.

6. Restart the batch service

Bloomreach Feed Plugin Properties File

The bloomreachFeedUploader.properties file contains the following properties:

outputDirectory

The Bloomreach Feed plugin file is placed in this directory before it is sent to the File Transfer Protocol (FTP) server.

outputFileName

(Optional) The name of the report. The default value is OfferCatalog.

storeLanguage

The language of the store.

currency

The currency of the store.

storeCode

The code of the store.

ftp.host

The FTP server host name.

ftp.username

The FTP server username.

ftp.password

The FTP server password.

readerPageSize

(Optional) The number of rows to retrieve at a time. The default value is 1000.