User Manual - Product Questions

Magento 2 Product Questions appends a tab to product pages from where customers can ask public and private questions, provide answers to the existing ones, give rating to individual questions and answers. Store admins can decide which questions should be published, made private or public, or rejected and inform customers about their question / answer updates by email. Additionally, the extension shares questions between store views, all or selected products.

Compatibility: Magento Open Source 2.3.X, Magento Commerce 2.3.X

 

Installing Product Questions

Command Line Installation

  1. Backup your web directory and store database
  2. Download the Product Questions installation package
  3. Upload contents of the Product Questions installation package to your store root directory
  4. In SSH console of your server navigate to your store root folder:
cd path_to_the_store_root_folder

run the following command:

php -f bin/magento module:enable Aheadworks_Pquestion

then:

php -f bin/magento setup:upgrade

after:

php -f bin/magento setup:static-content:deploy

     5. Flush store cache; log out from the backend and log in again

Make sure the installation is done from the FTP administrator account. Otherwise, set 775 permissions to the store root directory after the extension is deployed.

Composer Installation

If you are installing an extension from Aheadworks for the first time, you need to add our composer repository to your Magento store:

     1. Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

Run the following command:

composer config repositories.aheadworks composer https://dist.aheadworks.com/

After the command was executed successfully, you can use the composer to install the products.

To install the extension:

     2. Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

     3. Run the following command to install the latest version of the extension:

composer require aheadworks/module-product-question

if you need to install a specific version, run this command:

composer require aheadworks/module-product-question:<version>

 

Specify the version of the extension in <version>

When prompted, enter Public Key (Username) and Private Key (Password):

Both Public Key (Username) and Private Key (Password) can be found in My Projects and Licenses in your personal account on our site:

     4. Enable the extension:

php -f bin/magento module:enable <Module_Name>

 

Add the product name in <Module_Name>

Next, register the extension:

bin/magento setup:upgrade

Recompile your Magento store if you are in the Production mode:

bin/magento setup:di:compile

To verify that the extension is enabled, run this command:

bin/magento module:status

Clean store cache, by running the following command:

bin/magento cache:clean

Log out and Log in the backend again.

To upgrade the extension:

     5. To update or upgrade an extension:

Download the updated extension file. Take note of the module-name and version. Export the contents to your Magento root.

If a composer package exists for the extension, run one of the following.

Update per module name:

composer update aheadworks/module-product-question

Updater per version:

composer require aheadworks/module-product-question:<version>

Run the following commands to upgrade, deploy, and clean the cache.

php bin/magento setup:upgrade --keep-generated 
php bin/magento setup:static-content:deploy
php bin/magento cache:clean

 

 

Set up cron

If you have already configured cron jobs for your Magento installation, you might skip this step. Read the following instructions on setting cron job for your Magento store: Magento user guide 

Generally, it would be enough to run the following command in the SSH console of your server: 

crontab -e

Next, insert the following line:  

*/3 * * * * php -c <ini-file-path> <your Magento install dir>/bin/magento cron:run
*/3 * * * * php -c <ini-file-path> <your Magento install dir>/update/cron.php
*/3 * * * * php -c <ini-file-path> <your Magento install dir>/bin/magento setup:cron:run

Don't forget to confirm the saving request when exit.

Migrating Questions from Magento 1 to Magento 2

Read the following information carefully to avoid an accident data loss.

Magento 2 Product Questions introduces the question migration tool that moves the questions and answers generated by the Product Questions Magento 1 module to the Product Questions Magento 2 module. To do this, follow the steps below:

  1. The Magento Data Migration Tool is required to be installed prior to starting the migration.
    The migration script relies heavily on the Magento Data Migration tool. 

  2. Backup the Magento 2 databases before the migration to have an opportunity to revert any changes.
    Migration might involve rewriting database tables, so backup is strongly advised.

  3. Questions and answers can be properly migrated only from the M1 Product Questions 2.x.x version and above. If you have the previous versions installed, do not try migrating them on your own.

  4. Migration specifics
    You need to make sure that the Magento Webstore and Website IDs are the same;
    Target customers on a destination store are determined and assigned by customer emails. Emails are specified in the source Magento 1 store;
    Target products on a destination store are determined and assigned by product SKUs. SKUs are stored in the source Magento 1 store;
    Target product attribute sets on a destination store are determined and assigned by attribute set names. Attribute set names are provided in the source Magento 1 store.

  5. Sharing options migration specifics
    The product question sharing options are converted in the following way

     - Product(s) -> Selected Products with SKU condition (Certain Product, if only one product is selected)
     - Attribute Set -> Selected Products with Attribute Set condition
     - Website & Global -> All products

    If there is no chance to determine the products suitable for a particular question, the question is shared among all products and receives the 'Unpublished' status. The corresponding notification about such questions is added to the migration log (aw_pq2_migration.log).

1. Install the Data Migration Tool following the instructions provided by the Magento team.

2. Copy the contents of the /etc or /src folders (for Magento 2.1.x and Magento 2.2.x, respectively) found in the Magento 2 Product Questions installation package to the vendor/magento/data-migration-tool/ folder.

3. Navigate to vendor/magento/data-migration-tool/etc/aw_pq2/ and open config.xml for edit.

More information on tag values can be found in the Magento Data Migration Tool configuration instructions.
<source> - the source database questions and answers should be migrated from.
<destination> - the target database the questions and answers should be migrated to.

4. Run the migration process from the console:

bin/magento migrate:data -r vendor/magento/data-migration-tool/etc/aw_pq2/config.xml

5. The migration is completed.

 

 

Uninstalling Product Questions

Manual Removal

1. Disable the module by executing the following commands:

php bin/magento module:disable Aheadworks_Pquestion 
php bin/magento setup:upgrade

2. Remove the extension files from the following folder:

app/code/Aheadworks/Pquestion

Automatic Removal (via Composer)

1. Disable the module by executing the following commands:

php bin/magento module:uninstall Aheadworks_Pquestion

 

 

Introducing Product Questions

The Product Questions extension offers a communication platform with the following functionality:

  • Public/private questions;
  • Answer manual/auto approvals;
  • Q&A helpfulness voting;
  • Guest questions;
  • Email notifications;
  • Question sharing.

Extension Logic

The module introduces a new tab to product pages - Product Questions. The tab contains the communication area where customers can ask new questions, provide answers, rate the helpfulness of questions and answers, sort questions by rating/date.

Each new user's question/answer gets the pending status. It is stored in the Manage Questions dashboard waiting for an admin's approval (or rejection).

Customers can monitor all their questions/answers in the separate Product Questions tab added to their profile page.

In the admin area, the module conditionally consists of the Manage Questions dashboard and the By Product grid. From the dashboard, the admin can manage all customer questions and add new ones. The grid shows questions by related products.

The admin can edit the content of questions/answers, approve, reject, or delete them, make questions public or private. Each question can be shared among multiple products or all products at once.

The additional Configuration menu sets ask/answer and rate permissions for guest users. Besides this, the admin can set up several automation options, define the look of the Q&A tab, and handle the email notification parameters.

 

 

Backend Configuration

Extension Settings

The configuration process starts with setting up the main module's parameters located under Stores > Configuration > AHEADWORKS EXTENSIONS > Product Questions.

The provided parameters are divided into three sections: General Settings, Interface Settings, and Email Notification Settings.

General Settings

  • Module Status - defines if the Product Questions extension is enabled in your store. After saving configurations flush cache;
  • Allow Guests to Ask Questions - defines who can ask questions: only the registered users or all users;
  • Who Can Answer Questions from Product Page - defines who can answer questions: admin only, registered customers who purchased the products, only registered customers or all customers;
  • Approve Answers Automatically - if set to Yes, all users' answers will be approved automatically;
  • Guests can rate - if set to Yes, guest users will be able to rate questions and answers;
  • Subscribe customers to Product Questions emails automatically - defines if users will be automatically subscribed to Q&A email alerts;
  • Customer-defined question visibility (Private or Public)if set to No, users won't be able to define their questions' visibility.

Interface Settings

  • Number of questions to display - defines the number of questions to be displayed in the Product Questions tab on product pages;
  • Number of answers to display - defines the maximum number of answers to be displayed below each question upon expanding it;
  • Default questions sort by - defines how questions are sorted by default (by rating or date);
  • Default sort order - defines if the sort order should be ascending or descending;
  • Admin Answer Caption - defines by what name admin will be displayed on storefront;
  • Display URLs as linksdefines if URLs provided by users in their questions and answers should be clickable.

Email Notification Settings

  • Email Senderdefines the email sender;
  • Send admin notification to this email addressan email address where all admin Q&A notifications should be sent;
  • Admin notification about new questiondefines the email template for new question admin notifications;
  • Admin notification about new answers defines the email template for new answer admin notifications;
  • Customer notification about the question is publisheddefines the email template for published question customer notifications;
  • Customer notification about the question is rejecteddefines the email template for rejected question customer notifications;
  • Customer notification about the answer is publisheddefines the email template for published answer customer notifications;
  • Customer notification about the answer is rejecteddefines the email template for rejected answer customer notifications;
  • Customer notification about his new question defines the email template for new question customer notifications;
  • Auto-Responder to customer about his new questionif enabled, defines the email template for new question customer auto-responders;
  • Auto-Responder to customer about his new answerif enabled, defines the email template for new answer customer auto-responders;
  • Remove the web copies of the emails older than X daysdefines how long email web copies should be stored in the store's database.

Once the extension has been configured, click on the Save Config button at the top right of the Configuration page.

Managing Questions

To access all submitted questions, go to Marketing > PRODUCT QUESTIONS BY AHEDWORKS > Product Questions.

The Manage Questions grid contains data about all customer/admin questions. The data is split into the following columns:

  • ID - the identification number of the question;
  • Question - the question asked;
  • Originally posted on - the related product;
  • SKU - the product's SKU;
  • Display for - the place where the question will show; 
  • Status - the current question status (published, pending, or rejected);
  • Visibility - the question's visibility status (public or private);
  • Total Answers - the total number of answers given to the question;
  • New Answers - the new, 'pending' answers given to the question;
  • Rating - the question rating is given by users;
  • Author Name - the author of the question;
  • Author Email - the email of the author of the question;
  • Date - the date when the question was asked;
  • Asked From - the store view where the question was asked.

From the Actions box above the grid, you can Delete, Change status (to pending, published, rejected) or Change visibility (to public, private) the selected question(s).

To edit the question, click on the required one in the Question column. The values in this column are presented in the form of an active link to the Edit Question page.

The page is divided into three tabs: Question, Answer and Sharing Options.

From the Question tab, you can change the question's status, date, question's content, new answer author name, answer's content, visibility status, rating. 

The Answer grid contains the following columns:

  • ID - the identification number of the question; 
  • Nickname - the nickname of the author of the question;
  • Answer -  the answer was given to the question;
  • Rating - the question rating is given by users;
  • Created - the date of creation; 
  • Store View - the place where the question will display;
  • Action - the current status of the question can be changed to published or rejected.

 

From the Answer tab, you can edit answers one by one, moderate answers individually.

From the Actions box above the grid, you can Delete or Change status (to pending, published, rejected). 

In the Sharing Options tab, you can share questions.

Each question can be displayed with multiple store views and products: selected products, certain product.

In order to change the product click on the Select Product button and choose a needed product. 

New Question

The functionality provided on the New Question page designed for creating new questions. In the Question tab, you can specify the author name, answer, and question to it in the corresponding fields, define the date, question's status, and rating.

As in the case with customer questions, the Sharing Options tab shares your questions among products.

Mail Log

To access all mails, go to Marketing > Product Questions by Aheadworks > Mail log.

The Mail log grid contains the following columns:

  • ID - the identification number of the mail;
  • Recipient Name - the name of the mail recipient;
  • Recipient Email - the recipient's email; 
  • Store View - the information where the question is located;
  • Type of the notification - the notification reason;
  • Status - the current question status (published, pending, or rejected);
  • Created At - the time when the notification was created;
  • Scheduled For - the time when the notification is scheduled to send;
  • Sent At - the time when the notification was sent; 
  • Action - the actions that can you can do with mail are following: send now or cancel.

Questions by Product

To view questions by related products follow Catalog > Products and Select the product you are interested in.

The information in the grid is divided into the following columns:

  • ID - the identification number of the question;
  • Question - the question related to the product;
  • Display for - the place where the question will show; 
  • Status - the current question status (published, pending, or rejected);
  • Visibility - the public or private;
  • Total Answers - the total number of answers related to the product;
  • New Answers - the total number of new answers;
  • Rating - the question rating given by users;
  • Author Name - the author of the question;
  • Author Email - the email of the author of the question;
  • Date - the date when the question was asked;
  • Asked From - the direction from where the question was asked.

 

Product Questions in Customers Area 

To see what kind of questions the customer asked follow these steps: Customers > All Customers > Customer Information > Product Questions by Aheadworks.

The page is consist of: Manage Notification List and Customer Questions.

 At Manage Notification List area you can choose what kind of notifications the client will subscribe to - Question update notification, Answer update notification. If you want to select both hold the Enter button and click on items.

The information in the Customer Questions grid is divided into the following columns:

  • ID - identification number of the question;
  • Question - the question related to the product;
  • Originally posted on - the place where the question will show;
  • SKU - the product's SKU;
  • Display for - the place where the question will show;
  • Status -the current question status (published, pending, or rejected);
  • Visibility - the public or private;
  • Total Answers - the total number of answers related to the product;
  • New Answers - the total number of new answers;
  • Rating - the question rating is given by users;
  • Date - the date when the question was asked;
  • Asked from -  the direction from where the question was asked.

 

Storefront Q&A

Product Questions Tab on Product Pages

The Product Questions tab is located on all product pages. It stores all questions and answers related to the corresponding product. Answers can be provided only for the previously approved questions.

To ask a new question, one should click on the corresponding button at the top right of the section. By clicking on the button, users will see a special form from where they can send questions.

The extension submits both public and private questions. Once the question has been specified, it can be sent for an admin's moderation. By default, all questions are public. To make a question private, one should tick the Private Question box before sending it.

Besides asking questions, users can provide answers to the already existing ones. To give an answer, click on the Add Answer button below the corresponding question.

If the number of answers provided for the question exceeds the value defined in the 'Number of answers to display' field, the next X answers will be shown on the separate page upon clicking on the 'See all' active link. X stands for the specified value.

To see all questions related to the product click on See All. On the All Questions page your customers can ask a question and see already existing questions. In the Product Questions area customers may add an answer, sort questions by date or rating, rate questions and answers. 

Users can rate each question and answer. The provided rating system serves as an additional sorting parameter along with the date the question/answer was posted.

Customer Account

The Product Questions tab in a customer account lists all the customer's questions asked and the answers given to other questions. Here customers can see whether their questions have been answered or whether a particular question or answer has been published.

 

Moreover, with the Product Questions extension, users can subscribe to email notifications about the question and answer updates. The subscription is independent of questions and answers and can be canceled anytime.

To preserve privacy, private questions are not displayed on product pages. At the same time, private questions are available in the email inbox of the customer, and in My Account → Product Questions (available for registered customers only).

 

Product Page

Report incorrect information

Still Have Questions?

Our customer care team is here for you!

Contact Us