Elastic Path Commerce Bloomreach Feed Plugin

1.2.x

Bloomreach Feed Release Notes

1.2.3

Released: September 2020

Release Highlights

Allow specification of which product/sku attributes to include in the feed

Added new settings that allow business users to specify which product or sku attribute values to include in the feed. A comma-separated list of attribute keys can be specified. If no values are not specified, all attribute values are included in the feed.

Product attributes to include: COMMERCE/SYSTEM/PLUGIN/BLOOMREACH/VALUESFILTER/offerProperties / valuesFilter.offerProperties Sku attributes to include: COMMERCE/SYSTEM/PLUGIN/BLOOMREACH/VALUESFILTER/itemProperties / valuesFilter.itemProperties

Fixed Issues

Fixed Cucumber tests

The Cucumber tests in the repo were out-of-date and failing. They have now been fixed and are passing again.

Upgrade Notes

Customers upgrading from prior versions of the plugin must complete the following tasks:

  1. The system configuration settings have changed, you must re-add the settings to your database. To add the settings, go to your project source and create a new release folder in the extensions/database/ext-data/src/main/resources/data project. Populate the folder with the appropriate liquibase-changelog.xml file, importexport/configuration/importconfiguration.xml file, and importexport/manifest.xml file. For more information, use the files in rel-1.0-data as a template.

  2. Update the extensions/database/ext-data/src/main/resources/data/liquibase-changelog.xml file to contain an include reference for the liquibase-changelog.xml file in the new release folder.

  3. Follow the Defining TSETTINGS Properties section. Populate system_configuration.xml file in the new release folder that you created instead of rel-1.0-data with the following:

    <configuration_setting>
    <name_space>COMMERCE/SYSTEM/PLUGIN/BLOOMREACH/VALUESFILTER/offerProperties</name_space>
    <description>A comma-separated list of product attribute keys to include in the feed. Defaults to all product attribute values if not specified.</description>
    <default_value type="String">${ep.bloomreach.valuesFilter.offerProperties}</default_value>
    <max_overrides>1</max_overrides>
    <setting_metadata/>
</configuration_setting>
<configuration_setting>
    <name_space>COMMERCE/SYSTEM/PLUGIN/BLOOMREACH/VALUESFILTER/itemProperties</name_space>
    <description>A comma-separated list of sku attribute keys to include in the feed. Defaults to all sku attribute values if not specified.</description>
    <default_value type="String">${ep.bloomreach.valuesFilter.itemProperties}</default_value>
    <max_overrides>1</max_overrides>
    <setting_metadata/>
</configuration_setting>

  4. Add the corresponding property values to your filtering.properties files:

    ep.bloomreach.valuesFilter.offerProperties=
ep.bloomreach.valuesFilter.itemProperties=

  5. If the setting definition values are empty, Bloomreach will fallback on values from a bloomreachFeedUploader.properties configuration file. If you want to use this approach, update the file with the following values:

    valuesFilter.offerProperties=
valuesFilter.itemProperties=

  6. Update the bloomreach-feed dependency in the ep-commerce/extensions/batch/ext-batch/pom.xml file to version 1.2.3.

  7. Commit all your changes and push them to your central git repository.

  8. Build and deploy the commerce project as usual using Jenkins

1.2.2

Released: July 2020

Release Highlights

Allow specification of which stores to include in the feed

Added new COMMERCE/SYSTEM/PLUGIN/BLOOMREACH/stores / stores setting that allows business users to specify which stores to include in the feed. If the store is not specified, all stores are included in the feed.

Publish offer sale price in the feed if specified

Modified the logic for determining the value of the price_* values in the feed so that they include the sale price instead of the list price if a sale price has been specified.

Fixed Issues

Setting sftpCamelOptions value should not override username and private key values

Modified the COMMERCE/SYSTEM/PLUGIN/BLOOMREACH/sftpCamelOptions / sftpCamelOptions setting so that it can be overridden without also overriding the username and private key values that are specified.

Upgrade Notes

Customers upgrading from prior versions of the plugin must complete the following tasks:

  1. The system configuration settings have changed, you must re-add the settings to your database. To add the settings, go to your project source and create a new release folder in the extensions/database/ext-data/src/main/resources/data project. Populate the folder with the appropriate liquibase-changelog.xml file, importexport/configuration/importconfiguration.xml file, and importexport/manifest.xml file. For more information, use the files in rel-1.0-data as a template.

  2. Update the extensions/database/ext-data/src/main/resources/data/liquibase-changelog.xml file to contain an include reference for the liquibase-changelog.xml file in the new release folder.

  3. Follow the Defining TSETTINGS Properties section. Populate system_configuration.xml file in the new release folder that you created instead of rel-1.0-data with the following:

    <configuration_setting>
    <name_space>COMMERCE/SYSTEM/PLUGIN/BLOOMREACH/stores</name_space>
    <description>A list of stores to export in the feed. Defaults to all stores if not specified.</description>
    <default_value type="String">${ep.bloomreach.stores}</default_value>
    <max_overrides>1</max_overrides>
    <setting_metadata/>
</configuration_setting>

  4. Add the corresponding property value to your filtering.properties files:

    ep.bloomreach.stores=

  5. If the setting definition values are empty, Bloomreach will fallback on values from a bloomreachFeedUploader.properties configuration file. If you want to use this approach, update the file with the following values:

    stores=

  6. Update the bloomreach-feed dependency in the ep-commerce/extensions/batch/ext-batch/pom.xml file to version 1.2.2.

  7. Commit all your changes and push them to your central git repository.

  8. Build and deploy the commerce project as usual using Jenkins

1.2.1

Released: June 2, 2020

Release Highlights

Feed protocol updated from FTP to SFTP

The protocol used for uploading the feed to Bloomreach has been updated from File Transfer Protocol (FTP) to Secure File Transfer Protocol (SFTP). SFTP is encrypted and more secure. SFTP works better within secure production environments since it only requires a single outbound connection on port 22.

Upgrade Notes

Customers upgrading from prior versions of the plugin must complete the following tasks:

  1. Generate a public/private key pair by running the following command on Linux or Mac:

    ssh-keygen -t rsa -m PEM

  2. Contact Bloomreach technical support to enable SFTP access for your Bloomreach Search and Merchandising feed. You will need to send them the public key that you have generated. Ensure that you do not send them the private key.

  3. The system configuration settings have changed, you must re-add the settings to your database. To add the settings, go to your project source and create a new release folder in the extensions/database/ext-data/src/main/resources/data project. Populate the folder with the appropriate liquibase-changelog.xml file, importexport/configuration/importconfiguration.xml file, and importexport/manifest.xml file. For more information, use the files in rel-1.0-data as a template.

  4. Update the extensions/database/ext-data/src/main/resources/data/liquibase-changelog.xml file to contain an include reference for the liquibase-changelog.xml file in the new release folder.

  5. Follow the Defining TSETTINGS Properties section. Populate system_configuration.xml file in the new release folder that you created instead of rel-1.0-data. Set the following setting values:

    Previous SettingNew SettingNew Value
    COMMERCE/SYSTEM/PLUGIN/BLOOMREACH/ftpHostCOMMERCE/SYSTEM/PLUGIN/BLOOMREACH/sftpHostUse the same value as before, usually ftp.bloomreach.com.
    COMMERCE/SYSTEM/PLUGIN/BLOOMREACH/ftpUsernameCOMMERCE/SYSTEM/PLUGIN/BLOOMREACH/sftpUsernameUse the same value as before.
    COMMERCE/SYSTEM/PLUGIN/BLOOMREACH/ftpPasswordCOMMERCE/SYSTEM/PLUGIN/BLOOMREACH/sftpPrivateKeyFilenameReplace with the file system location of the private key file generated in the previous step.
    COMMERCE/SYSTEM/PLUGIN/BLOOMREACH/ftpCamelOptionsCOMMERCE/SYSTEM/PLUGIN/BLOOMREACH/sftpCamelOptionsUse the same value as before.

  6. If the setting definition values are empty, Bloomreach will fallback on values from a bloomreachFeedUploader.properties configuration file. If you want to use this approach, update the file with the following values:

    Previous FieldNew FieldNew Value
    ftp.hostsftp.hostUse the same value as before, usually ftp.bloomreach.com.
    ftp.usernamesftp.usernameUse the same value as before.
    ftp.passwordsftp.privateKeyFileNameReplace with the file system location of the private key file generated in the previous step.
    ftp.camel.optionssftp.camel.optionsUse the same value as before.

  7. Update the bloomreach-feed dependency in the ep-commerce/extensions/batch/ext-batch/pom.xml file to version 1.2.1.

  8. Commit all your changes and push them to your central git repository.

  9. Build and deploy the commerce project as usual using Jenkins

1.2.0

Released: April 28, 2020

Release Highlights

Multi-store feed

You can create a multi-store feed file containing products linked to two or more stores. The multi-store feed enables you to use one file to contain all product attributes from all of your stores in a single language. If you have more than one language, each language has its own file. For more information, see the Multi-store feed documentation.

Last updated on 10/6/2020
← OverviewImplementing the Plugin →