Integrate Bazaarvoice

Last updated:
Edit on GitHub

To integrate Bazaarvoice, follow these guidelines.

Prerequisites

Before you can integrate Bazaarvoice, make sure that your project is ACP-enabled. See App Composition Platform installation for details.

The Bazaarvoice app requires the following Spryker modules:

  • spryker/asset: ^1.3.0
  • spryker/asset-storage: ^1.1.0
  • spryker/merchant-profile: ^1.2.1 (Marketplace only)
  • spryker/message-broker: ^1.3.0
  • spryker/message-broker-aws: ^1.4.1
  • spryker/oms: ^11.25.0
  • spryker/product-review: ^2.10.0
  • spryker/product-review-gui: ^1.5.0
  • spryker-shop/asset-widget: ^1.0.0
  • spryker-shop/cart-page: ^3.32.0
  • spryker-shop/product-detail-page: ^3.17.0
  • spryker-shop/product-category-widget: ^1.6.0
  • spryker-shop/shop-ui: ^1.62.0
  • spryker-shop/checkout-page: ^3.23.0
  • spryker-shop/merchant-page: ^1.1.0 (Marketplace only)
  • spryker-shop/merchant-profile-widget: ^1.1.0 (Marketplace only)
  • spryker-shop/merchant-widget: ^1.3.0 (Marketplace only)
  • spryker-shop/payment-page: ^1.3.0

Integrate Bazaarvoice

To integrate Bazaarvoice, follow these steps:

1. Add the Bazaarvoice domain to your allowlist

To enable your customers to leave reviews on your products, you must add the Bazaarvoice domain to your Content Security Policy allowlist.

To do that, do one of the following:

  1. Change the deploy.yml file:
image:
  environment:
    SPRYKER_AOP_APPLICATION: '{
      "APP_DOMAINS": [
        "*.bazaarvoice.com",
        ...
      ],
      ...
    }'
  1. Update the config/Shared/config_default.php file:
$config[KernelConstants::DOMAIN_WHITELIST][] = '*.bazaarvoice.com';

2. Add markup to custom templates

The Bazaarvoice app takes data on products from the Storefront pages—for example, the product details page, or the Catalog page. To get necessary data from the pages, schemas from Schema.org are used. By default, the necessary markups are already available in the Yves templates.

If you have custom Yves templates or make your own frontend, add the markups required for the Bazaarvoice app according to the following tables.

Dynamic catalog collection (DCC) for products

Core template: SprykerShop/Yves/ProductDetailPage/Theme/default/views/pdp/pdp.twig

SCHEMA.ORG PROPERTY BAZAARVOICE PROPERTY Required Example
product.sku productId Yes 012_3456789
product.name productName Yes Camera Pro 123
product.description productDescription No Lorem ipsum dolor sit amet, consectetur adipiscing elit.
product.image productImageURL Yes https://www.example.com/img/gallery/camera-pro-123.jpg (always use absolute URL)
product.url productPageURL Yes https://www.example.com/office-chair (always use absolute URL)
product.brand.name brandId, brandName No Xyz Brand
product.category categoryPath No [{“id”:1,“name”:“Cameras & Camcorders”},{“id”:4,“name”:“Digital Cameras”}]
product.gtin12 upcs No 123456789876
product.inProductGroupWithID family No 6

Example:

<section itemscope="" itemtype="https://schema.org/Product">
    <meta itemprop="name" content="Camera Pro 123">
    <meta itemprop="url" content="https://www.example.com/camera-pro-123?">
    <meta itemprop="sku" content="012_3456789">
    <meta itemprop="productId" content="012_3456789">
    <meta itemprop="description" content="Lorem ipsum dolor sit amet, consectetur adipiscing elit.">
    <meta itemprop="image" content="https://www.example.com/img/gallery/camera-pro-123.jpg">
    <div itemprop="brand" itemscope="" itemtype="https://schema.org/Brand">
        <meta itemprop="name" content="Xyz Brand">
    </div>
    <meta itemprop="category" content="[{&quot;id&quot;:1,&quot;name&quot;:&quot;Cameras &amp; Camcorders&quot;},{&quot;id&quot;:4,&quot;name&quot;:&quot;Digital Cameras&quot;}]">
    <meta itemprop="inProductGroupWithID" content="6">
    <meta itemprop="gtin12" content="123456789876">
</section>

DCC for merchants

Note

Since merchants don’t have their own entities in the Bazaarvoice service, products with specific IDs or merchant references are used instead.

Core template: SprykerShop/Yves/MerchantProfileWidget/Theme/default/components/molecules/merchant-profile/merchant-profile.twig

SCHEMA.ORG PROPERTY BAZAARVOICE PROPERTY Required Example
organization.identifier productId Yes MER000001
organization.name productName Yes Xyz Merchant
organization.logo productImageURL Yes https://www.example.com/merchant/merchant-logo.png (always use absolute URL)

Example:

<section itemscope="" itemtype="https://schema.org/Organization">
    <meta itemprop="identifier" content="MER000001">
    <meta itemprop="name" content="Xyz Merchant">
    <meta itemprop="logo" content="https://www.example.com/merchant/merchant-logo.png">
</section>

Ratings and reviews (for Product)

Core templates:

  • SprykerShop/Yves/ProductDetailPage/Theme/default/views/pdp/pdp.twig
  • SprykerShop/Yves/ProductReviewWidget/Theme/default/views/pdp-review-rating/pdp-review-rating.twig
  • SprykerShop/Yves/ProductReviewWidget/Theme/default/components/organisms/review-summary/review-summary.twig

Example:

<section itemscope itemtype="https://schema.org/Product">
   <meta itemprop="sku" content="{some_sku}">
   
   <section itemscope itemtype="http://schema.org/AggregateRating" itemprop="aggregateRating">
      <meta itemprop="ratingValue" content="{rating}">
      <meta itemprop="bestRating" content="{best_rating}">
   </section>
   
   <section class="review-summary"></section>
</section>

Ratings and reviews (for Merchant)

Core template: SprykerShop/Yves/MerchantProfileWidget/Theme/default/components/molecules/merchant-profile/merchant-profile.twig

Example:

<section itemscope itemtype="https://schema.org/Organization">
   <meta itemprop="identifier" content="{merchant_reference}"/>
   <meta itemprop="name" content="{merchant_name}"/>
   <meta itemprop="logo" content="{merchant_logo_url}"/>
   <section itemscope itemtype="http://schema.org/AggregateRating" itemprop="aggregateRating"></section>
   
   <section class="review-summary"></section>
</section>

Inline ratings

Core templates:

  • SprykerShop/Yves/ShopUi/Theme/default/components/molecules/product-item/product-item.twig
  • SprykerShop/Yves/ProductReviewWidget/Theme/default/views/product-review-display/product-review-display.twig
  • SprykerShop/Yves/ProductReviewWidget/Theme/default/components/molecules/rating-selector/rating-selector.twig

Example:

<section itemscope itemtype="https://schema.org/Product">
   <meta itemprop="sku" content="{some_sku}">
   
   <section itemscope itemtype="http://schema.org/AggregateRating" itemprop="aggregateRating">
      <meta itemprop="ratingValue" content="{rating}">
      <meta itemprop="bestRating" content="{best_rating}">
      
      <rating-selector></rating-selector>
   </section>
</section>

3. Configure a message broker

Add the following configuration to config/Shared/common/config_default.php:

use \Generated\Shared\Transfer\AddReviewsTransfer;
use \Generated\Shared\Transfer\OrderStatusChangedTransfer;
use \Spryker\Zed\MessageBrokerAws\MessageBrokerAwsConfig;

//...

$config[MessageBrokerConstants::MESSAGE_TO_CHANNEL_MAP] = [
    //...,
    AddReviewsTransfer::class => 'reviews',
    OrderStatusChangedTransfer::class => 'orders'
];

$config[MessageBrokerConstants::CHANNEL_TO_TRANSPORT_MAP] =
$config[MessageBrokerAwsConstants::CHANNEL_TO_RECEIVER_TRANSPORT_MAP] = [
    //...,
    'reviews' => MessageBrokerAwsConfig::SQS_TRANSPORT,
];

$config[MessageBrokerAwsConstants::CHANNEL_TO_SENDER_TRANSPORT_MAP] = [
    //...,
    'orders' => 'http',
];

Add a message handler

Add the following plugin to src/Pyz/Zed/MessageBroker/MessageBrokerDependencyProvider.php:

 /**
  * @return array<\Spryker\Zed\MessageBrokerExtension\Dependency\Plugin\MessageHandlerPluginInterface>
  */
 public function getMessageHandlerPlugins(): array
 {
     return [
         //...,           
         new ProductReviewAddReviewsMessageHandlerPlugin(),
     ];
 }

Receive messages

  1. To receive messages from the channel, the following command is used:
console message-broker:consume
  1. Because this command must be executed periodically, configure Jenkins in config/Zed/cronjobs/jenkins.php:
$jobs[] = [
    'name' => 'message-broker-consume-channels',
    'command' => '$PHP_BIN vendor/bin/console message-broker:consume --time-limit=15',
    'schedule' => '* * * * *',
    'enable' => true,
    'stores' => $allStores,
];

4. Configure OMS

To configure OMS, follow these steps:

Extend command plugins

Add the following plugin to src/Pyz/Zed/Oms/OmsDependencyProvider.php:

use Spryker\Zed\Oms\Communication\Plugin\Oms\Command\SendOrderStatusChangedMessagePlugin;

// ...

/**
 * @param \Spryker\Zed\Kernel\Container $container
 *
 * @return \Spryker\Zed\Kernel\Container
 */
protected function extendCommandPlugins(Container $container): Container
{
    $container->extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) {
        // ...
        $commandCollection->add(new SendOrderStatusChangedMessagePlugin(), 'Order/RequestProductReviews');
    
        return $commandCollection;
    });
 }

Update the OMS schema

Adjust your OMS state machine configuration to trigger the Order/RequestProductReviews command according to your project’s requirements.

Here is an example with the DummyPayment01.xml process for the deliver event:

<?xml version="1.0"?>
<statemachine
        xmlns="spryker:oms-01"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="spryker:oms-01 http://static.spryker.com/oms-01.xsd">
 
    <process name="DummyPayment01" main="true">
        <!-- ... -->
        <events>
            <!-- ... -->
            <event name="deliver" timeout="1 second" command="Order/RequestProductReviews"/>
            <!-- ... -->
        </events>
    </process>
    <!-- ... -->
</statemachine>

Add order hydration plugin (Marketplace only)

For a Marketplace project, add the following plugin to src/Pyz/Zed/Sales/SalesDependencyProvider.php:

use Spryker\Zed\MerchantProfile\Communication\Plugin\Sales\MerchantDataOrderHydratePlugin;

// ...

/**
 * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\OrderExpanderPluginInterface>
 */
protected function getOrderHydrationPlugins(): array
{
    return [
        // ...
        new MerchantDataOrderHydratePlugin(),
    ];
}

Next steps

Configure the Bazaarvoice app for your store.