Getting Started

Welcome to the Advanced Reviews Documentation. Whether you are a new or an advanced user, you can find some useful information here.

First of all, we recommend you check the following link:

• How to install extension

How to install the extension

1. Backup your store's database and web directory.
2. Login to your server's SSH console and navigate to the root directory of the Magento 2 store.
3. Copy the installation instructions from the page My Downloadable Products into the SSH console and press ENTER.
4. Run the command below to enable the extension:

       php -f bin/magento module:enable Mirasvit_Core Mirasvit_Review Mirasvit_Comment

5. Run the command below to install the extension:

       php -f bin/magento setup:upgrade

6. Run the command below to clean the cache:

       php -f bin/magento cache:clean

7. Deploy static view files:

       rm -rf pub/static/frontend/*; rm -rf pub/static/backend/*; rm -rf var/view_preprocessed/*;
       php -f bin/magento setup:static-content:deploy

Install the extension for Hyva

1. Run the command to obtain the Advanced Reviews Hyva component

       composer require mirasvit/module-review-hyva:* mirasvit/module-comment-hyva:*

2. Enable installed Hyva component:

       php -f bin/magento module:enable Hyva_MirasvitReview Hyva_MirasvitComment Hyva_CompatModuleFallback

3. Update Magento database schema and data with the command:

       php -f bin/magento setup:upgrade

4. Compile the code to generate the contents of Magento var/di folder:

       php -f bin/magento setup:di:compile

5. Check the file app/etc/hyva-themes.json. If there are no entries for the package mirasvit/module-review-hyva package - run the following command

       php -f bin/magento hyva:config:generate

6. Compile the code of the installed extension:

       cd /path/to/theme/web/tailwind/

       npm run build-prod

7. Deploy the static view files

       cd /path/to/project/

       rm -rf pub/static/*; rm -rf var/view_preprocessed/*;
       php -f bin/magento setup:static-content:deploy

8. Run the command below to clean the cache:

       php -f bin/magento cache:flush

Advanced Reviews settings

The settings of Advanced Reviews are located at Stores ▸ Configuration ▸ Mirasvit Extensions ▸ Advanced Reviews and are grouped into the following sections:

• General Settings - basic configuration of the extension;
• Media Settings - attachments and gallery settings;
• AI-Powered Features - settings for AI-powered features;
• Admin Notifications - settings for admin natifications about new reviews;
• Review Reminder Settings - settings for review reminder emails;

General Settings

• Enable Advanced Reviews - enable/disable reviews.
• Allow Guest Reviews - enable/disable the ability to leave reviews for guests.
• Select Date Format - choose how dates are displayed in reviews.
• Default Review Sorting - default sort order for reviews.
• Show Pros and Cons - enable/disable additional review fields - pros and cons.
• Display Reviewer Location - enable/disable location label from where the review was placed.
• Show "Verified Buyer" Badge - enable/disable "Verified Buyer" label for reviews placed after the product was ordered.
• Display Purchased Product Details - displays additional information of purchased product. This option only affects reviews for configurable products placed by verified buyers.
• Verified Buyer Order Statuses - Select for which order statuses the customer should be considered as a "Verified Buyer". By default only the "complete" status is used. After changing this setting reindex reviews with the command bin/magento mirasvit:review:reindex --verify --force

Media Settings

• Allow Photo Attachments - enable/disable the ability to attach photos to reviews.
• Show Photo Gallery - enable/disable the media gallery for attached photos.
• Maximum Photos per Review - Max number of images to upload per review. The limit should be between 1 and 20 photos. If empty, the default limit will be used (5 photos).

AI-Powered Features

• OpenAI API Key - generate an OpenAI API key. You'll need to create an account if you don't have one.
• Enable Review Aggregation - If enabled the extension will generate a summarized review for each products. The summarized review will be generated based on the last 10 customer reviews. The summarized review won't be generated for products with less than 5 reviews.
• Show AI-Generated Info Hint In Summary - If enabled the extension will add info icon and popup with info that the summary was generated by AI.
• Enable AI Autowrite - Enable/disable the ability to generate the content for a product review using Open AI (ChatGPT) when creating a new review from the admin panel.

Admin Notifications

• Enable Admin Notifications - enable/disable admin notifications about new pending reviews. If enabled, the extension will create admin notifications when new pending reviews are submited.
• Enable Email Alerts for New Reviews - enable notifiyng admin about new pending reviews by email.
• Email Recipients - comma-separated list of emails to which notifications should be sent.

Review Reminder Settings

• Enable Review Reminders - enable/disable emails for customers with the request to left the review for recently purchased products.
• Delay sending reminders, days - the number of days the extension should wait before sending emails with review requests. Valid values between 0 and 365.
• Delay sending reminders, hours - the number of days the extension should wait before sending emails with review requests. Valid values between 0 and 23.

  Note

  If both Delay sending reminders, days and Delay sending reminders, hours are 0 the reminder will be send immediately after the order will obtain one of the statuses selected in the config Send Reminder for Orders with Status
• Choose Email Template - Select the template, that will be used in emails. The default template can be customized in Marketing -> Communications -> Email Templates. The default templates contains a PHTML template for the list of products - Mirasvit_Review::email/order_items.phtml. To customize this part of the reminder email rewrite this template in your theme.
• Send Reminder for Orders with Status - when the order obtained one of selected statuses the extension will schedule the review reminder email. The extension creates only one email per order.
• Cancel Reminders for Orders with Status - if at the moment when a reminder email should be sent the order status will match one of the statuses selected in this setting, the email will be canceled.
• Sender Email - select the email address from which email reminders will be sent.
• Do Not Send Reminders For Customer Groups - select customer groups for which review reminders souldn't be sent. The extension validates actual customer group of the customer before sending the reminder.
• Reminde email logs lifetime, days - number of days after which email logs will be deleted. Leave empty to disable this feature

General Configurations

All configurations of the Comments extension are located at Stores -> Configuration -> Mirasvit Extensions -> Comments.

The extension has only one configurations section - General Settings - with the following configurations:

• Enable Comments - enable/disable the comments feature.
• Allow Guests to Write Comments - defines whether guest users are allowed to leave comments or not.
• Automatically Approve Comments - defines whether comments left by visitors should automatically obtain the Approved status or should be left for moderation.
• Date Format - defines how the date when the comment was left should be displayed.
• Enable Admin Notifications - if enabled, the extension will add notifications about pending comments into the admin system notifications.

General Configurations

All configurations of the Comments extension are located at Stores -> Configuration -> Mirasvit Extensions -> Comments.

The extension has only one configurations section - General Settings - with the following configurations:

• Enable Comments - enable/disable the comments feature.
• Allow Guests to Write Comments - defines whether guest users are allowed to leave comments or not.
• Automatically Approve Comments - defines whether comments left by visitors should automatically obtain the Approved status or should be left for moderation.
• Date Format - defines how the date when the comment was left should be displayed.
• Enable Admin Notifications - if enabled, the extension will add notifications about pending comments into the admin system notifications.

Command Line Interface

Usage: php -f bin/magento [command]

• mirasvit:mirasvit:review:aggregate [options] - generate aggregated reviews (AI-powered). Allowoed Options:
  • --product [id] - specify the ID of the product for which aggregated review should be generated. If ommited the extension will generate aggregated reviews for all reviewed products.
• mirasvit:mirasvit:review:generate [options] - generate reviews using Open AI. Allowed options:
  • --nickname [nickname] - the nickname of the reviewer. This option is required.
  • --rating [rating] - rating from 1 to 5. This option is required.
  • --product [product_id] - the ID of the product for which the review should be generated. If ommited the extension will generate reviews for all products.
  • --store [store_id] - specify for which store view the review should be generated
  • --additional [text] - add additional instructions for Open AI. These instructions will be included in the prompt for reviews generation.
  • --qty [number] - the limit of reviews to generate in one execution.
  • --autoapprove - define if generated reviews should be automaticaly marked as approved
• mirasvit:review:reindex [options] - reindex reviews locations and "verified buyer" data. If no options specified the extension will reindex both. Allowed options:
  • --verify - reindex "verified buyer" data.
  • --location - reindex reviewers' location data.
  • --force - force reindex. Affects only the "verified buyer" data reindex. Should be used after changing the Store Statuses setting of the extension.

How to upgrade extension

To upgrade the extension, follow these steps:

1. Backup your store's database and web directory.
2. Login to your server's SSH console and navigate to the root directory of the Magento 2 store.
3. Run the command below to update the current extension with all dependencies:

       composer require mirasvit/module-review:* --update-with-dependencies

   Note

   If you have the Hyva installed, run:

       composer require mirasvit/module-review:* mirasvit/module-review-hyva:* mirasvit/module-comment-hyva:* --update-with-dependencies

   Note

   In some cases, the command above is not applicable; neither is it possible to update just the current module, nor need to upgrade all the Mirasvit modules in a bundle. In this case, the command above will be of no effect.
   
   Run instead composer update mirasvit/* command. It will update all the Mirasvit modules installed in your store.
   
   
4. Run the command below to enable the extension:

       php -f bin/magento module:enable Mirasvit_Core Mirasvit_Review Mirasvit_Comment

   Note

   If you have the Hyva installed, run:

       php -f bin/magento module:enable Mirasvit_Core Mirasvit_Review Hyva_MirasvitReview Mirasvit_Comment Hyva_MirasvitComment

5. Run the command below to install updates:

       php -f bin/magento setup:upgrade

6. Run the command below to clean the cache:

       php -f bin/magento cache:clean

7. Deploy static view files:

       rm -rf pub/static/frontend/*; rm -rf pub/static/backend/*; rm -rf var/view_preprocessed/*;
       php -f bin/magento setup:static-content:deploy

   If you have the Hyva installed, run:

       cd /path/to/theme/web/tailwind/
       npm run build-prod
       cd /path/to/project/
       rm -rf pub/static/frontend/*; rm -rf pub/static/backend/*; rm -rf var/view_preprocessed/*;
       php -f bin/magento setup:static-content:deploy