Introduction

We love making things easy for you! This is why we are putting loads of effort to develop plugins, add-ons and modules for widely used platforms, which you can use to make integration an issue of a few clicks. 

In this article you can find how to integrate e-satisfaction.com on Magento by using the Magento add-on that our team developed for you to use.

Information Needed

Gather all the required data as pointed out in the Web Integration article, in the section "Information Needed".

Step 1: Preparation

Before you do anything else, you must find and download the correct module package, from the following links, depending on the Prestashop version you use:

• Magento 1.9: https://github.com/esatisfaction/esat-magento/tree/1.9

After downloading the package, you should do the following actions:

1. Download release zip
2. Open zip and extract files
3. Upload the app folder to your magento root directory
4. Clear your cache
5. Log-out and log-in again to allow the plugin to be installed properly

You should be able to find the module in your menu.

Step 2: Configure IDs

After successfully installing the plugin, navigate to the "e-satisfaction" section, as shown in the following snapshot:

You will need to set an Application Id and an Authentication token

Application ID: The Application ID can be found in the Application Settings page of the application that has been created.

Setup Authentication Token

Read how to Create a new Token.

The token should have at least the following scope actions:

• List Questionnaires
• List Pipelines
• Create Queue Item
• Update Queue Item

Once you are done with these actions, the token will have been generated and you can copy it (ideally using the copy icon on the right side of the line) and paste it in the Module settings section of your Magento installation.

On save, you should be able to see the questionnaires and the pipelines in the options below.

Step 3: Custom or Automatic Flows

We are trying to make everything ready for you but still we believe it is good to control what is been communicated to your consumers and how or when you send them something, especially via email. This is why we provide the ability to choose whether the sending of messages after the delivery or the store pickup will be sent automatically or not. This is done in the "Custom Flows" configuration which is shown below:

Enable this option to manually handle your questionnaire flow.

NOTE: Before enabling this, you should deactivate the flows in the e-satisfaction Dashboard.

Step 4: Separate store pickup from home delivery

As previously mentioned, we provide two different questionnaires for the stages of store pickup and home delivery. You can define which of your orders are delivered home or not by linking the Carriers that you have setup in your Magento installation to each stage.

Step 5: Define when messages will be sent

The last part of the add-on setup is to define when to send after delivery and after store pickup messages to your consumers. For each of the above mentioned stages, you must define:

• Days after to send the questionnaire: the time period after which an after delivery message (home delivery or store pickup will be sent (i.e. 5 days after order/shipping/Payment Accepted/etc.)
• Order status(es) to send questionnaire: what will be the status that will begin the countdown defined by this period
• Order status(es) to cancel a questionnaire: what will be the status that will cancel a previously created queue item

These two parameters are defined in the module add-on settings page, separately for store pickup and home delivery orders, by checking the statuses you select through this screen:

Example cases:

IMPORTANT NOTE: The statuses that appear in the list shown above are retrieved by the statuses that have been configured (and updated) in your Magento installation. It is advised to exam what each status means in your Magento installation, before setting up this time frame.

Final check

After going through all these steps mentioned above, you should be up and running and the questionnaires should be displayed, collecting feedback from your customers. If you face any  issues in collection and you have cross checked that you completed the above mentioned steps correctly, please see these articles to make a quick troubleshooting. 

Of course we are always here to help and you can Submit a request or just using the chat box you see on the right.

Push Metadata

Browse

In order to add extra metadata for your Browse questionnaire, you should edit the following file, based on your version:

Magento 1.9:

~/app/design/frontend/base/default/template/esatisfaction/header.phtml

 You should add the following script and add all the extra needed metadata like the following example:

{literal}
<script>
    Esat.updateMetadata("BROWSE-QUESTIONNAIRE-ID", {
        responder: {
            "metadata_name": "metadata_value"
        },
        questionnaire: {
            "metadata_name": "metadata_value"
        }
    });
</script>
{/literal}

NOTE: You should add the metadata at the Application Settings panel in the e-satisfaction Dashboard first, if they do not exist already.

Checkout

In order to add extra metadata for your Checkout questionnaire, you should edit the following file, based on your version:

Magento 1.9:

~/modules/esatisfaction/views/templates/hook/checkout.tpl

You should edit the metadata script and add all the needed metadata like the following example:

<script>
    // Metadata update script
    Esat.updateMetadata("<?php echo $questionnaire_id; ?>", {
            responder:
                {
                    "email": "<?php echo $_order_data['email']; ?>",
                    "phone_number": "<?php echo $_order_data['telephone']; ?>",
                    "metadata_name": "metadata_value"
                },
            questionnaire:
                {
                    "transaction_id": "<?php echo $_order_data['increment_id']; ?>",
                    "transaction_date": "<?php echo $_order_data['created_at']; ?>",
                    "store_pickup": <?php echo $_order_data['store_pickup']; ?>,
                    "metadata_name": "metadata_value"
                }
        }
    );
</script>

NOTE: You should add the metadata at the Application Settings panel in the e-satisfaction Dashboard first, if they do not exist already.