Module Magento 2 - Verified Reviews...MODULE MAGENTO 2 This document is the property of Avis-Verifies Page 7 of 26 Step 3 • The next step will be to create a backup. It is recommended

Magento 2 Module

REVISIONS

Author Date Rating

L. Vigne 10/10/2017 Editor D. Houlle 10/11/2017 Proofreading Carlos RAYA 06/03/2019 Image correction Carlos RAYA 04/10/2020 Update (images and data)

MAGENTO 2 MODULE

This document is the property of Verified Reviews Page 2 of 34

CONTENTS

1. How it works ............................................................................................................................................ 4

2. Installation of the module ....................................................................................................................... 5

2.1. Installation via Magento Marketplace ................................................................................................. 5

2.1.1. Retrieve the module installation key ......................................................................................... 5

2.1.2. Installation of the module on Magento 2 .................................................................................. 5

2.2. Installation of the module via an archive .................................................................................... 10

2.2.1. Download the archive of a module ......................................................................................... 10

2.2.2. Installation of the module on Magento 2 ................................................................................ 11

2.2.3. Version history ......................................................................................................................... 11

3. First export of orders ............................................................................................................................. 12

4. Ensure Magento 2 and Verified Reviews are connected. ..................................................................... 14

5. Automation of review requests ............................................................................................................. 19

5.1. Check module connection............................................................................................................ 19

5.2. Retrieving the configuration ........................................................................................................ 20

5.3. Multi-store configuration ............................................................................................................. 21

5.4. Module configuration option ....................................................................................................... 22

5.5. Some details ................................................................................................................................. 23

6. Widget configuration............................................................................................................................. 25

7. Display of product reviews .................................................................................................................... 27

8. PLA Section ............................................................................................................................................ 28

9. Recurring problems ............................................................................................................................... 30

9.1. Reviews and/or stars are not displayed on the product page ............................................ 30

9.2. Stars are not displayed on the products list page ................................................................ 30

9.3. The average rating, number of reviews or reviews do not match ...................................... 31

9.4. Orders have not been retrieved for some time ..................................................................... 31

9.5. The Rich-Snippets don’t work ................................................................................................. 31

9.6. Information regarding Google searches and Rich-Snippets. .............................................. 31

10. Appendices ....................................................................................................................................... 33

10.1. Monitoring review requests ...................................................................................................... 33

MAGENTO 2 MODULE


10.2. Monitoring reviews .................................................................................................................... 33

11. Contact ............................................................................................................................................. 34

MAGENTO 2 MODULE


1. HOW IT WORKS

Magento 2 is a free e-commerce solution based on the Zend framework. Our Verified Reviews module

for Magento 2 is available for download on our website. Once the module is installed and configured,

everything is automatic, Verified Reviews communicates directly with your e-commerce solution.

• Automatic recovery of orders and requests for reviews: The module communicates your

latest orders to us directly. Our platform, therefore, collects orders for which we must send

requests for reviews, and this according to the configuration entered during the setup

described below.

• Display of product reviews on your site: The module allows you to display your product

reviews collected on our platform directly on your product sheets and thus reassure your

customers about the quality of your products.

• Display of Verified Reviews rating widget: You have the option of displaying a floating

widget on your site. This widget allows you to display to your visitors the average overall rating

for your verified Reviews and thus reassure the potential customer on the quality of your

services.

MAGENTO 2 MODULE


2. INSTALLATION OF THE MODULE

2.1. Installation via Magento Marketplace

2.1.1. Retrieve the module installation key

• Log in to Magento Marketplace (marketplace.magento.com).

• Use the search engine to find the module Verified Reviews.

• Select the version of the module for Magento 2 (M2).

• Click on “Add to cart” and submit your order.

• Once your order has been made, click on “Install”.

• Create a new key for Magneto 2 by pressing the button “Create a new access Key”.

• Copy the keys, you’ll need them again later.

2.1.2. Installation of the module on Magento 2

Step 1

• Connect to your Magento 2 back office.

• In the main menu, click "System" then "Web Setup Wizard".

• Then click "Component Manager".

MAGENTO 2 MODULE


• If you’re still not connected, click on “Sign in” and enter your access key.

• Once connected, click " Install".

• Check the "Netreviews - Verifiedreviews" module and click on "Install".

Step 2

MAGENTO 2 MODULE


• Click on "Readiness Check" to check if your Magento 2 site has all the necessary

components for module installation.

MAGENTO 2 MODULE


• Once the verification is complete, click on the "Next" button. If any components are displayed

in red, you can resolve these conflicts by following the link at the bottom of the page – this will

redirect you to the official Magento 2 documentation.

Step 3

• The next step will allow you to create a backup. We recommend a full backup before installing

a new module. Select the elements you want to add to the backup and click the "Create

Backup" button.

MAGENTO 2 MODULE


• A backup confirmation should be displayed on the screen, you can then continue by clicking

"Next".

Step 4

• The last step asks you to confirm the installation of this new module, click on the button

“Install” to finalize the installation. Once the module is installed, you can click the "Back to

Setup Tool" button.

MAGENTO 2 MODULE


2.2. Installation of the module via an archive

2.2.1. Download the archive of a module

The module is available to download from the customer area of your Verified Reviews account. You

can access it by visiting: www.avis-verifies.com and clicking on the "Orders/Our eCommerce

modules" menu.

Click on the "Download" button of our Magento 2 module to download a zip file.

http://www.avis-verifies.com/

MAGENTO 2 MODULE


2.2.2. Installation of the module on Magento 2

Step 1

• Extract the module file from the folder "Mon_Site_Magento2/app/code" of your Magento 2

site.

Step 2

• Login to your Magento 2 site via order line and enter the following two orders:

You should see a message confirming the successful installation of the module.

2.2.3. Version history

The version history is available from the module download page by clicking the "Version history"

button.

MAGENTO 2 MODULE


3. FIRST EXPORT OF ORDERS

In order to quickly receive your first Reviews, the

Verified-Reviews module has an order export

functionality which enables you to generate a CSV

file already formatted on the correct structure which

can be directly loaded via your Verified-Reviews

Customer Area or communicated to your account

manager. The first order export enables you to

generate the first reviews quickly by surveying the

customers of your orders already placed.

Go to the Magento 2 menu in "Verified

Reviews>Export reviews (CSV file)" to access the

export for orders.

Warning: If a click on the "VerifiedReviews" menu

leads to a 404 error page, you must log out from your

Magento 2 back-office then reconnect. This is a

known problem with Magento 2 following the

installation of a new module.

MAGENTO 2 MODULE


• Choose the store to which you want to export the orders.

• Choose the desired duration for retrieving orders.

• Select the status of the orders you want to export.

• Select "Yes" to "Request product reviews" if you also want to obtain product reviews.

• Click on “Export file” in the top right.

File loading starts automatically, by default you can find it in your download file. Send this file to your

Verified Reviews account manager to generate review requests or load it directly through your Verified

Reviews account. To do this, go to your Verified Reviews tab OrdersSend by file. You will then access

the page for loading orders by importing files. Follow the steps displayed on screen.

If the Orders > Send by file menu does not appear, contact us. You have certainly already loaded your

first orders and we limit access to this functionality.

MAGENTO 2 MODULE


4. ENSURE MAGENTO 2 AND VERIFIED REVIEWS ARE CONNECTED.

Once the module is installed, go to the "Configuration" section of the module on Magento 2. There is

a request for two pieces of information in the "General Configuration" section, the secret key and the

Website ID.

To access them, log into your Verified Reviews account.

• Navigate the "Integration>Configure my Magento module" menu.

• Click the "Download/Documentation" button.

This page has more information to be given in this module.

• Copy the secret key and the website ID.

MAGENTO 2 MODULE


• Return to the "Configuation" section of your Magento 2 back-office.

• Select the store to configure.

• Paste the secret key and the website ID.

• Select "Yes " in "Enable Module on this Website" to activate the module in this store.

• Select "Production" in "Environment mode".

MAGENTO 2 MODULE


• If you use a sandbox URL communicated by our team, please select "Sandbox" and put the URL communicated by our team in the "Sandbox URL" field; the URL should not contain "http://" or "https://" it should be formatted as in the image below. The button “Check URL” allows you to check if the URL is correct.

Once the configuration is complete, click on the "Save Config" button.

• Only use the "Advanced Configuration" section if you have a very good understanding of your site configuration and configure the options in line with the characteristics of your store.

MAGENTO 2 MODULE


By default, the advanced configuration is filled in like this:

• Add Review to product Page: "Yes" (Display product reviews on the product page).

• Use tiny responsive design in product reviews "No" (To reduce the block size of the reviews).

• Activate Rich-Snippets on your product page: "No rich-snippets" (Add RichSnippets to your product sheets).

• My product page already has rich-snippets: "No" (Only available for JSON-LD format).

• The orders originated from a physical store (Offline orders): "No" (Choose "Yes" if the orders originated from a physical store, i.e. offline orders. If the value is "No", the orders will be considered as online orders).

• Use the data of the Parent product: "Yes" (Recovers data from the Parent products: Configurable, bundle, package. If the value is "No", the module recovers the data of the Children products : Simple)

• Limit export order (between 1 and 100000): "empty by default" (If you want to limit the quantity of orders shown during order retrieval, complete the quantity of orders to limit).

MAGENTO 2 MODULE


The following image shows the difference between the "classic" design and the "Tiny" design:

MAGENTO 2 MODULE


5. AUTOMATION OF REVIEW REQUESTS

Access configuration from your Verified Reviews account via "Integration Configure my Magento

module".

5.1. Check module connection

Click "Retrieve site configuration" to check the connection between Verified Reviews and Magento 2. If you have a green message at the top of the page after clicking "retrieve configuration", the module is now connected to your Magento 2 site:

You can also check the connection to the module by clicking "Module status" to check the connection between Verified Reviews and Magento 2. A green success message should appear like the image below:

MAGENTO 2 MODULE


5.2. Retrieving the configuration

This step will allow you to retrieve the configuration of your Magento 2 site in order to configure our

module according to it:

• Click on "Retrieve site configuration" to check the connection between Verified Reviews and Magento 2 and retrieve the module configuration if you sent it previously.

• If a "success" message appears and the square at the right side of the "Module status" has green check marks, the module is configured correctly. If another message appears, check the previous configurations and if the problem persists, contact the verified reviews support by going to: "Config>Go to support".

MAGENTO 2 MODULE


5.3. Multi-store configuration

If you use multi-store with Magento 2, you need to complete the Secret Key and Website ID for each store you want to use our module for.

If you want to use our module for your multi-language stores, you need to create several Verified Reviews accounts for the relevant countries (with each account linked to a store).

You will see a list of all the Websites and stores of your site where only the stores where "(Current Configuration)" is written will be configured. The identifier of the store to be configured appears between curly brackets {}.

Note: If "(Current Configuration)" is written to the right of a store that you do not wish to configure, return to the module configuration on your Magento 2 back-office, then select the store in question from the drop-down menu above at the left. Delete the Secret Key as well as the Website ID and continue to the option "Enable Module on this Website" to "No".

MAGENTO 2 MODULE


5.4. Module configuration option

This step will allow you to configure the module and review requests. All you have to do is fill out the

form following the instructions. If you have any problems, hover over the "? " to get help.

• Activate the automation: Click on "yes " to activate the automation.

• Review requests: click "change order status" then select the last order status you updated on Magento 2.

• Time before the request is issued for the review: select the number of days between the change of the order status and sending the review request.

• Extension of e-mails: default permission to not question the marketplace customers.

• Options regarding the products: Check "yes" to retrieve the product reviews and/or post them on the corresponding product forms.

• Display widgets : you can paste the code here for the widget you have created.

• Click on "Send this configuration". Our platform communicates directly with the module to register this configuration.

You are now automated and you can follow the review requests sent to your clients from "Stats > Reporting - Review Requests".

MAGENTO 2 MODULE


5.5. Some details

Automatic order retrieval

• Activate the automation: if "yes", our engine will come every night to retrieve the orders for which we should survey the clients. If "no", you can continue to use the solution but the new orders will not be subject to review requests (unless you wish to export the orders and import them manually, refer to point 3 - Export of orders).

• Multi-store: Allows you to confirm the store to configure if you use the Magento 2 "multi-store" functionality. The store you inputted the ID for at stage 2 is selected by default.

• When should we ask for your clients' review:

-"On order": the review request process by Verified Reviews starts following the order and according to the number of days set below.

-"On changing the order status": the review request process by Verified Reviews will begin according to the status of the order that you will have chosen and also depends on the number of days set below.

Collection of reviews

• Length of time after this event: Choose how much time, after the above event of choice, the review request will be sent by Verified Reviews to your client.

• Define the email extensions: We are not authorized to survey your clients that buy from marketplaces such as Amazon, eBay, PriceMinister, temporary emails such as [email protected] are created for each of these orders. You should then advise the email extensions for which it is not necessary to send the review requests (the extension corresponds to what follows the @). We have already filled in some of these and you can add more below by separating them with a ":".

Product options

• Do you wish to retrieve the reviews on your products: If "yes", we will ask your clients about all the products that they ordered.

• Do you wish to post your product reviews on your product records: If "yes", the collected product reviews will be posted on your product records.

• Add the option "Useful Reviews" to your reviews? If "Yes" the "useful review" button will be displayed in your reviews for visitors to your site.

• Do you want to display media with the product reviews? If "Yes" images uploaded by your customers will be displayed in your reviews. For more information, please contact your Account Manager.

MAGENTO 2 MODULE


Widgets display

• Do you want to display the floating widgets: If "yes", the widgets will be displayed on your site.

• Floating Widget Script: Go to "Integration> Widget Site Integration" to choose the widgets and retrieve the code (script) to be integrated.

• Does your theme use Require JS: Leave "Yes" as default. Only change this option to no if you experience display problems on your site.

• What type of reference product would you like to use? By default, leave the value "SKU", change to "ID" only if our technical team requests this or if you are sure that you know how this part works, otherwise there may be a conflict in how your reviews are displayed.

MAGENTO 2 MODULE


6. WIDGET CONFIGURATION

As soon as you have collected more than three review sites, you can add our floating widget to your

website.

• Access your Verified Reviews account and click on "Integration > Widget Integration Site".

• Choose the widget that you prefer and click on the Floating type, then choose the position

and how to open the certification, and finally, click on "Create the widget".

• The widget that you just created is posted at the top of the page, click on "Retrieve the code"

and copy it.

• To add the widget script, go to the "Integration" section, then "Configure my Magento

module".

MAGENTO 2 MODULE


• Scroll down, select "Yes" for the question "Do you want to display the floating widget? " and

paste the script copied in point 3. If it is a fixed widget, you can choose the column in which you

would like to place it.

• To finish, click "Send this configuration".

MAGENTO 2 MODULE


7. DISPLAY OF PRODUCT REVIEWS

• Go to the "Integration" section then "Configure my Magento module" of the Verified Reviews

module configuration page.

• In the "Product option" section, select "Yes" for the following two questions:

- Do you want to get reviews on your products?

- Would you like to display product reviews on your product sheets?

• Click "Send this configuration".

Note : If this is the first time you are displaying product reviews, contact our technical support by sending

an email to [email protected], as manual synchronization is needed.

Note: You must wait 24 hours for any new product review to be displayed on your website.

• To check the display of product reviews, go to "Reviews > Published - Product Reviews",

choose a review dated more than 24 hours ago and check that it is displayed on your website.

You can then click on the "small arrow icon" to directly open the product page.

mailto:[email protected]

MAGENTO 2 MODULE


8. PLA SECTION

To allow Verified Reviews to retrieve supplementary data on your products (required by Google

Shopping):

• Do you wish to go to the Magento 2 back-office in

the "Verified Reviews> Google Shopping -

Product Data (PLA)" menu.

• Select the STORE to configure. Product

information for Google Shopping is only configured

at the store level (store views).

• Please read the warnings below each field. By

default, the module retrieves the following data on

your products:

- ID

- SKU

- Description: Product name

- Link: URL of the product sheet

- Image link: URL of the product image

Do not change the

default value of

these fields, you

can only change it if

you are sure that

the module does

not retrieve the

correct attribute of

the product.

MAGENTO 2 MODULE


• To retrieve new product data, please select the product attribute from the list only for the fields

that Google Shopping asks for, generally the product brand (Brand), the MPN and a GTIN.

Fields marked with "---" will not change their default value.

• Click on "Save Config".

MAGENTO 2 MODULE


9. RECURRING PROBLEMS

9.1. Reviews and/or stars are not displayed on the product page

Go to section 7 Display of product reviews and check that all the points mentioned are correct.

If the reviews are still not displayed, you must make sure that the code to show Magento reviews is

present in your template. Use the following instructions:

To display stars above the product sheet: In your "product" template, please paste the following code in the position you wish to display the

stars. Attention. Make sure that the $block->getProduct() variable makes reference to the item of

merchandise

<?php echo $block->getReviewsSummaryHtml($block->getProduct(),

\Magento\Catalog\Block\Product\ReviewRendererInterface::DEFAULT_VIEW); ?>

To display reviews in the product sheet: In your "product" template, please paste the following code in the position you wish to display the reviews.

<?php echo $this->getLayout()

->createBlock('Netreviews\Avisverifies\Block\Reviews')

->setTemplate('Netreviews_Avisverifies::reviews.phtml')

->toHtml(); ?>

9.2. Stars are not displayed on the products list page

Go to section 7 Display of product reviews and check that all the points mentioned are correct.

If the reviews are still not displayed, you must make sure that the code to show Magento reviews is

present in your template. Use the following instructions:

To display stars in the products list (categories page): In your "category product page" or "products list" template, please paste the following code in the

position you wish to display the stars. Be careful, make sure that the $_product variable is used

properly in this template, or else rename it to place the Magento product object.

<?php echo $block->getReviewsSummaryHtml($_product,

\Magento\Catalog\Block\Product\ReviewRendererInterface::SHORT_VIEW); ?>

MAGENTO 2 MODULE


9.3. The average rating, number of reviews or reviews do not match

Contact your customer service manager, manual synchronization of the reviews is needed.

9.4. Orders have not been retrieved for some time

Contact your account manager who will help you identify and resolve the problem.

9.5. The Rich-Snippets don’t work

The RichSnippets are included in the module.

To activate them, go to your Magento 2 back-office in the "Verified-Reviews > Configuration" menu

and then choose the store to configure, and in Advanced Configuration activate the Rich Snippets in

the "schema.org" or "json-ld" format in the "Activate the Rich-Snippets in the product page" option.

If you choose "json-ld" you have the option of specifying if your theme already includes Rich-Snippets

or not in the option "My product page already has rich-snippets"

Then, clear the Magento 2 caches and, if necessary, clear the server cache also.

9.6. Information regarding Google searches and Rich-Snippets.

In order for the stars to appear on your product page in the natural Google search results, it is necessary

to tag certain data.

Google can retrieve the availability, price, as well as the rating and number of reviews for your products.

As the management of these enriched extracts is updated quite often, we have not formulated specific

documentation.

Here is the link to Google's most recent documentation:

https://developers.google.com/search/docs/data-types/products

MAGENTO 2 MODULE


You can use their testing tool to test your changes:

https://search.google.com/structured-data/testing-tool?hl=fr

We invite you to get back to us when you have made the necessary changes so that we can confirm to

you that Google has taken the information into account.

If you cannot find an answer to your questions, see section 10 Contact

MAGENTO 2 MODULE


10. APPENDICES

10.1. Monitoring review requests

If you are now automated, you can track the requests for reviews sent to your clients from

"Stats>Reporting - Requests for reviews".

You can make a specific search by using the filters at the top of the page.

10.2. Monitoring reviews

You can monitor your published, in moderation and rejected reviews in the "Reviews" menu.

You can make a specific search by using the filters at the top of the page.

MAGENTO 2 MODULE


11. CONTACT

Don’t hesitate to contact us if you have any questions:

Alexandre GUEYDON – Lead Developer Module

[email protected]

www.Avis-Verifies.com

mailto:[email protected]?subject=Magento%202%20Documentation

http://www.aviscertifies.com/

Documents

Module Magento 2 - Verified Reviews...MODULE MAGENTO 2 This document is the property of Avis-Verifies Page 7 of 26 Step 3 • The next step will be to create a backup. It is recommended