Detailed Product Review - Common documentation

Extensions Installing 1. Installation tutorial

1.1. Find extensions that extend the reach of your Magento store 1.2. Preparation: Find the Extension Menu 1.3. Start a Readiness Check 1.4. Backup your Data 1.5. Install the Extension

2. Installing from the archive 2.1. Install extension using command line or manual installation 2.2. Magento 2 install extension using command line (Recommended) 2.3 Magento 2 install extension manually

3. How to Disable Extensions in Magento 2

Detailed Product Review 1. Extension description 2. Backend

2.1. Review forms and fields 2.1.1. Managing review fields 2.1.2. Review field validation rules 2.1.3. Common validation rules

2.1.3.1. Text Field validation rules 2.1.3.2. Text Area validation rules

2.2. Managing review forms 2.3. Choosing the review form 2.4. Reviews list - Admin Panel

3. Frontend 3.1. Ratings of reviews

3.1.1. Section "RATING & REVIEWS" 3.2. Review form 3.3. Review list 3.4. Review filters

3.4.1. The ability to sort and filter reviews by date. 3.4.2.The ability to search in reviews.

4. Detailed Product Review Submodules 4.1. DR_Customer Permissions submodule

4.1.1. Extension description 4.1.2. Module settings 4.1.3. Frontend

4.2. DR_Akismet submodule 4.2.1. Extension description 4.2.2. Module settings

4.3. DR_SEO submodule

4.3.1. Extension description 4.3.2. Module settings

4.4. Google ReCaptcha submodule 4.4.1. Module description 4.4.2. Module settings 4.4.3. Frontend

4.5. DR_Social Sharing submodule 4.5.1. Module settings 4.5.2. Module on frontend

5. Testing

Extensions Installing

1. Installation tutorial

To install an extension in Magento 2, you will need to:

● Find extensions on Magento Marketplace ● Preparation: Find the Extension Menu ● Start a Readiness Check ● Backup your Data ● Install the Extension

1.1. Find extensions that extend the reach of your Magento store

Note: Before you try to install an extension, we recommend you to create a backup of your Magento. Find applications and services that extend the reach of your Magento store. An example of another our module:

Go to extension that interests you.

Click on the button "Add to Cart"

Click on the button "Add to Checkout"

Click on the button "Add to Checkout"

1.2. Preparation: Find the Extension Menu To install an extension, you will need to access your admin dashboard and navigate to System>Web Setup Wizard.

From the 3 blocks options you have at your disposal, choose the Component Manager.

Here you will see already installed extensions on your website, any new updates for them and new extensions which you can install. Click on the Install link below the New Purchases label.

Select the extensions you want to install and click on the Install button or mark then and select a bulk install action form the top of the page.

1.3. Start a Readiness Check The First Step is the Readiness Check which will check if your Magento 2 installation has all of the necessary components required for the extension installation. Click on the Start Readiness Check button.

After the check has been completed and your installation covers all of the requirements, you will be able to proceed by clicking on the Next button.

If you have a component marked as red, you will be able to check how to fix the issues with it by clicking on the link below it. This will direct you to the official Magento 2 documentation section where you will find a guide on the matter.

1.4. Backup your Data You can create a Backup for your Store. We have recommended you to do this at the start of this tutorial as sometimes the integrated Magento Backup system will not create a proper backup of your data. You can de-select the backup options here and click on the Next button or click on Create Backup button if you have selected an option.

If you choose the latter, you will receive a confirmation screen that the backup has been successfully created and then you can hit the Next button to proceed.

1.5. Install the Extension In the last step, you will see again the extension/s you wanted to install. Click on the Install button to continue.

Once the installation has been completed, you will receive a confirmation and the ability to go back by clicking on the Back to Setup Tool button.

2. Installing from the archive

2.1. Install extension using command line or manual installation There are two most popular ways to install extension in Magento 2. To use COMMAND LINE or to install manually.

2.2. Magento 2 install extension using command line (Recommended) Detailed Product Review extension can be installed in a few minutes by going through these following steps.

Step 1: Download/purchase the extension. Step 2: Unzip the file in a temporary directory. Step 3: Upload it to your Magento installation root directory that is <project directory>/app/code. Step 4: Disable the cache under System >> Cache Management. Step 5: When installing Detailed Product Review extension, which in its structure contains module ReCaptcha. For correct work you need to execute this command:

php composer.phar require "google/recaptcha"

Step 6: Enter the following at the command line: php -f bin/magento setup:upgrade rm -R var/generation/ var/cache/ var/page_cache/ var/di php -f bin/magento setup:di:compile php -f bin/magento setup:static-content:deploy

Step 6: After opening Stores >>Configuration >>Advanced >> Advanced, the module will be available in the admin panel.

2.3 Magento 2 install extension manually

Step 1: Download/purchase the extension Step 2: Unzip the file in a temporary directory Step 3: Upload it to your Magento installation root directory that is <project directory>/app/code. Step 4: Disable the cache under System >> Cache Management Step 5 : After opening Stores >> Configuration >> Advanced >> Advanced, the module will be shown in the admin panel. Or after running the command in the

console: php bin/magento module:status

Or open app/etc/config.php file:

If you need to upgrade the database, run the following command line: php -f bin/magento setup:db-schema:upgrade

3. How to Disable Extensions in Magento 2 If you no longer need an extension, you have the option to disable it thus removing its function from your Magento 2 store. This can be easily done from the back-end of your website. Login to your admin dashboard and navigate to Stores>Configuration.

Now, access the Advanced>Advanced section from the left navigation panel inside your Configuration menu.

Click on the Save Config button and clear the corresponding cache when you are done with the change. Or you can disable the module via console command: magento module:disable <ModuleName>

Detailed Product Review

1. Extension description Detailed Product Review module provides an ability to customize review forms by adding new fields of various type and setting review forms per category. This is especially important for the stores that sell multiple types of products. Additionally to that, fields can be easily reordered and additional validation rules can be added to the text fields. Also, sorting/filtering review and ratings is now possible. This is a great opportunity to individualize product review forms to best suit your industry and business goals. Detailed Product Review is: Customizable review form:

- More customer content and useful information with additional review fields. Possibility to create fields of different types: text, text area, Yes/No, custom drop-downs and multi-select fields;

- Configurable field validation rules for clear information; - Reorder fields in forms to best suit you needs; - Set personal review forms per product categories to stress the product

characteristics; - Ability to use visual swatches (like drop-down);

Product ratings: - Implemented summary and detailed product ratings; - Display average summary and detailed ratings in the blocks above customer reviews

list; Sort and search for reviews; Social sharing for reviews; Voting for reviews; Engineering content optimization for search bots:

- possibility to indexed all reviews content for search bots; - added more attributes for helping search bots better-indexed review content;

Administration and protect against Internet bots:

- the “Customer permission” that allows disable/enable pre-moderated of the reviews; - submodule “Akismet” for prevents your web store from spam in reviews; - Google reCAPTCHA special integrated into extension(Review, SignIn, SignUp,

ContactUs, ForgotPassword forms) that protects from spam and bots;

Blazing fast real-time reindex or scheduled reindex (*reindexing 1M reviews takes less than 1 minute). The standard Magento review form has limitations to manage customer reviews. And you to lose some opportunity to drive your e-store visit, conversion and sells. Detailed Product Review extension this is the way to create review system, to manage reputation and to collect user generated content. Easy for using, very customizable and configured for your e-store characteristics.

2. Backend

2.1. Review forms and fields Review Fields and review Forms are technically based on the EAV functionality similar to the Product Attributes and Product Attribute Sets. Principles of review fields management are quite the same.

2.1.1. Managing review fields Location in Admin Panel: Marketing > User Content section > Review Fields:

"Review Fields" page contains a list of all the available review fields except required system fields: “Nickname”, “Summary”, “Review”. Currently system attributes are not manageable and are required by default. After selecting an attribute or pressing the “New review Field” button:

You get to the “Field Information” page:

This page contains the following tabs/section:

- Properties tab > Field Properties - edit basic properties like default label, input type etc. Manage options for dropdowns, multiselect and visual swatches;

- Properties tab > Advanced Field Properties - set custom field code (available only while creating attribute);

- Properties tab > Field Validation Rules - define custom validation rules for text fields;

- Manage Labels tab - allows editing field names per store for proper

internationalization.

Extension provides ability to edit custom fields from Admin Panel in the same way as this is done on the frontend. Store administrator has ability to edit data entered in the custom review fields. The list of the fields is the same as on the frontend in the store the review was posted from.

Available review field types are:

- Text Field - Text Area - Yes/No - Dropdown - Multiselect - Visual Swatch

2.1.2. Review field validation rules “Field Validation Rules” section provides ability to define custom validation rules the review fields. Available validation rules depend on the input type. They work in the same way both when a customer posts a review and when a store administrator edits it. All validation rules include both frontend and backend processing for maximum security. Note: currently “Nickname”, “Summary” and “Review” fields are not editable via the “Fields Information” page and thus it is not possible to define additional validation rules for these fields. Note2: Yet, No special validation rules available for: -Yes/No validation rules -Dropdown validation rules -Multiple Select validation rules -Swatch Visual validation rules

2.1.3. Common validation rules - is required ("Value Required" field)

2.1.3.1. Text Field validation rules

- min length (3 by default) - max length (63 by default) - URL - numbers only (for Age, Weight and other fields like that)

By default:

2.1.3.2. Text Area validation rules

- min length (10 by default) - max length (1023 by default)

By default:

2.2. Managing review forms Location in Admin Panel: Marketing > User Content section > Review Forms:

Here you can see the list of all review forms and edit them or create new ones - click on the row in a grid or press the “New Review Form” button respectively:

Each form has a name and consists of a some number of a form fields. Fields are managed via drag-n-drop interface for easy management. Drag the fields you need to the “Included Fields” area or move fields to the “Available Fields” are if you don’t want them to appear on the form.

Note that “Nickname”, “Summary” and “Review” fields cannot be removed from the form. Fields can be reordered according to your needs. Note that fields order affects both fields

order on the form and data in the review listing. Though, on the New/Edit Review forms in the Admin Panel 3 default fields will appear prior to the custom ones. Detailed Product Review extension is shipped with the 3 configured industry-specific forms and a default Magento review form. Custom forms are: Note 1: the data won’t be lost if you remove the field and then return it back. Note 2: only the attributes appropriate for the form are displayed in the reviews list on the Product Page.

2.3. Choosing the review form Location in Admin Panel: Products > Inventory section > Categories > choose a category > Display Settings tab > Review Form:

Current Detailed Product Review version provides an ability to select a review form per category. This configuration can be done on the default, website or store view level. It is important to remember that products are often assigned to the multiple categories. It is confusing that customers could see different review forms when viewing the product from different categories or let’s say when going to the product page from the "Search Results” page. This is why first category with the lowest level and custom settings has more priority. Here is an example:

- Root Category > Gear - Root Category > Gear > Fitness Equipment - Root Category > Gear > Watches

If the “Fitness Equipment” and “Watches” categories both have different settings then the first one - “Fitness Equipment” - has higher priority. Though, if “Fitness Equipment” and “Watches” both are configured to use parent category settings and “Gear” category has some custom configuration then “Gear” category configuration is used for “Fitness Equipment” and “Watches” category products. While editing the review form from the Admin Panel we collect the review fields for all

2.4. Reviews list - Admin Panel By default there are 3 places in the Magento Admin Panel where store administrator can view customer reviews:

- Marketing > User Content section > Reviews

- Customers > choose a customer > Product Reviews tab

- Products > Catalog > choose a product > Product reviews

Currently we do not provide visibility of the additional review fields in these areas because this will make the interface too complicated and overloaded with data. This feature can be added in the future releases. Please, contact us if you’re interested in this particular feature: support@mage-review.com

3. Frontend In the frontend module Detailed Product Review added new features for each product in tab "Reviews":

3.1. Ratings of reviews As described earlier, the Detailed Product Review module makes it possible to customize reviews form for different products and their categories. Also added functionality that gathers statistics on all ratings reviews. There are implemented three rating blocks.

3.1.1. Section "RATING & REVIEWS" Section "RATING & REVIEWS" includes 3 block of ratings. The first block shows the overall average rating for the product, the number of posted reviews and button "Add Your Review" respectively.

Block #1

The second block shows the average number of stars for each review.

Block #2

The third block shows the average values for each type rating.

Block #3

3.2. Review form To go to the review form you have to click on the "Add Your Review":

Then you can see the new customized form of writing review:

3.3. Review list List of reviews is as follows:

3.4. Review filters

3.4.1. The ability to sort and filter reviews by date.

3.4.2.The ability to search in reviews. Additional caveats: For search on the reviews need at least 3 values. Search is made only by the type fields as: text and textarea.

4. Detailed Product Review Submodules

4.1. DR_Customer Permissions submodule

4.1.1. Extension description Module "Customer Permissions" allows to publish reviews without first checking moderated, depending on the configuration group of users.

4.1.2. Module settings To configure the module you need: Location in Admin Panel: Stores->Configuration->MageWorkshop->Customer Permissions:

1. Field “Enabled customer permissions restrictions” - respectively enable/disable module; 2. Field “Enabled Auto Approve” - enables the automatic approval of reviews; 3. Field “Auto Approve Reviews for Customer Group” - you need to select which groups will

have "Enabled Auto Approve"; 4. Field “Only verified buyers can post reviews” - this option includes checking for users and

the ability to add reviews only verified buyers.

4.1.3. Frontend On the frontend, it looks like:

4.2. DR_Akismet submodule

4.2.1. Extension description Akismet service prevents your web store from spam in reviews, comments etc. You need to configure the akismet module before usage. Log in to Magento admin, go to Stores-> Configuration -> MageWorkshop -> Akismet.

4.2.2. Module settings Enable the module and provide your Api key:

In order to get Akismet api key, you need to login at https://akismet.com/

You need to have wordpress.com account. Then go to https://akismet.com/plans, choose plan and press "Create Subscription" And get your akismet api key:

4.3. DR_SEO submodule

4.3.1. Extension description DR_Seo module implements extended SEO features for Magento 2. This module helps the search engine to index all elements of page.

4.3.2. Module settings

Field "Hide Seo block by" has two options as:

Option "CSS" - lets you hide blocks using CSS tools. Option “JavaScript (hide SEO block after the page load)” - lets you hide blocks using JavaScript tools.

4.4. Google ReCaptcha submodule

4.4.1. Module description MageWorkshop Google reCaptcha submodule integrates Google ReCaptcha into Magento 2 and allows using it instead of default captcha. Also, it is possible to use Google ReCaptcha with any custom forms. What is reCAPTCHA? reCAPTCHA is a free service that protects your website from spam and abuse. reCAPTCHA uses an advanced risk analysis engine and adaptive CAPTCHAs to keep automated software from engaging in abusive activities on your site. It does this while letting your valid users pass through with ease. reCAPTCHA offers more than just spam protection. Every time our CAPTCHAs are solved, that human effort helps digitize text, annotate images, and build machine learning datasets. This in turn helps preserve books, improve maps, and solve hard AI problems. To enable and configure this module you should go on this way in the admin panel of your website: Location in Admin Panel: Stores->Configuration->MageWorkshop->Google reCaptcha:

4.4.2. Module settings ReCaptcha module has several settings like:

1. Enable Google reCaptcha - respectively enable/disable module;

2. Theme - two themes to choose from: l

3. Dispay reCaptcha on following forms:

4. Displaying modem has two options to choose from:

4.1. Always - for all users 4.2. A limited number of attempts for authorization:

You can enter the number of unsuccessful attempts to authorize.

5. Fields for entering keys recaptcha:

Here you can enable reCAPTCHA which will be shown for users while applying for review. You will need to register your domain on reCAPTCHA site and receive Public Key and Private Key to put them in Admin area:

5.1. Go to www.google.com/recaptcha/admin#list, log in with your google account and register your domain.

5.2. Enter your site name to Name field and domain to Domain field and click Registration button.

5.3. Copy Public Key and Private Key from reCAPTCHA website and paste to appropriate fields in reCaptcha Module section.

5.4. Turn on reCaptcha from Admin area and save changes. Note: To register your domain you should have a Google account. Domain registration for configuration Public and Private Keys.

4.4.3. Frontend On the frontend, it looks:

4.5. DR_Social Sharing submodule DR_Social Sharing module adds the opportunity to add a link to review in your social network.

4.5.1. Module settings Enable the module in admin panel: Location in Admin Panel: Stores->Configuration->MageWorkshop->Detailed Product Review->DR_SocialSharing:

4.5.2. Module on frontend

5. Testing All extensions are supported and working properly in version Magento 2.1.3 or less. Tested in a standard Magento 2 theme -- Luma. Supported Browsers: Firefox 41 and more, Chrome 44 and more, Safari 10 and more, Edge.