README

To view these docs online, navigate to: https://developers.pixlee.com/docs/magento-2

Use this Magento 2 extension to connect to Emplifi's UGC service. Compatible with Magento Open Source and Adobe Commerce, versions 2.3 - 2.4.

Installation Instructions

Install using Composer (recommended)

Follow the Adobe documentation to Install an extension

Composer Package pixlee/magento2

Run these commands in your root Magento installation directory for composer install:

composer require pixlee/magento2
bin/magento module:enable Pixlee_Pixlee --clear-static-content
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:clean

Configure the module to connect to your Emplifi UGC account. Please see the Setup section below.

Install by copying files

Create a code/Pixlee/Pixlee directory in the app directory of your Magento installation.
Download the latest "Source code" from this page: https://github.com/pixlee/magento2/releases
Extract the file and copy the contents of the Pixlee_Pixlee directory into the app/code/Pixlee/Pixlee directory.

Run following commands from your root Magento installation directory:

bin/magento module:enable Pixlee_Pixlee --clear-static-content
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:clean

Configure the module to connect to your Emplifi UGC account. Please see the Setup section below.

Setup

Configure the Emplifi UGC Magento 2 Module

Select Stores > Configuration on the main menu. Then select Emplifi (Pixlee) > UGC in the left navigation menu.

The Emplifi UGC account settings can be configured at the Website, Store, or Store view depending on account setup. For each UGC account, select the desired cope in the scope (store view) dropdown menu and enter the account configurations.

Set Enable to Yes
Fill in API Key, Private API Key, and Secret Key with the API keys from your Emplifi Account. Getting you API Keys
Click Save Config in the top right corner of the page to save your Account Settings.

Exporting Products from Magento to Emplifi

Recurring Product Export Cron Job

The extension sets up a cron job that exports products to Emplifi on a daily basis. This will keep product data up-to-date in Emplifi by exporting new product data and updated data for existing products to Emplifi.

Change Product Export Run Time

By default, products will be exported daily at 3am UTC. If this time causes an issue, you can change the time that the product export runs by updating the cron schedule in Magento.

Create a copy of the extension's crontab.xml in your Magento 2 directory on the server in the app/code/Pixlee/Pixlee/etc directory.
Update the time to the time you want the export to run. To change the hour in the day at which the products are exported, change the 3 in the schedule tag to the hour you want the export to run. The example below will run the export at one minute after 5am UTC.
```
<job name="export_cronjob" instance="Pixlee\Pixlee\Cron\ExportCron" method="execute">
    <schedule>1 5 * * *</schedule>
</job>
```

Manually Run Product Export

Products can be exported to Emplifi when required by using the Export Products button. In the extension configuration Products section, click the Export Products to Emplifi button to export all products for the currently selected configuration scope to your Emplifi account. This process can be repeated for each scope.

🚧 Note

If the export times out, ensure the max_execution_time configuration for Magento must is set to at least 3600 seconds (1 hour). Magento sets the value to 5 hours by default.

Embedding PDP Widget on Product Pages

After creating a PDP Widget in Emplifi, adding the widget ID to the configuration will add the widget to the product details pages.

Log in to your account and navigate to the Publish Center.
Click the "Publish New PDP Display" button and configure the display per the documentation. NOTE - It is recommended that you leave the "Load Priority" setting to "Low priority" when customizing.
After customizing, click the "Generate Embed Code" button and copy the value for widgetId from the snippet or get the ID from the Publish Center.
To enable the PDP widget, enter the widgetId from the previous step in the PDP Widget ID field under Widget Settings in the Magento store configuration and click Save Config.
To customize the placement of the PDP widget, modify catalog_product_view.xml. And use the move tag to move the widget block.

For example, you can create a new view/frontend/layout/catalog_product_view.xml file in a custom module in the app/code directory and use the move tag to move the widget block.
```
<move element="product.view.community_gallery" destination="content" after="product.info.main" />
```

Embedding a CDP Widget on your Category Pages

The first three steps are exactly the same as embedding a PDP widget as they only involve getting a widgetId from the Control Panel.

Log in to your account and navigate to the Publish Center.
Click the "Publish New PDP Display" button and configure the display per the documentation. NOTE - It is recommended that you leave the "Load Priority" setting to "Low priority" when customizing.
After customizing, click the "Generate Embed Code" button and copy the value for widgetId from the snippet or get the ID from the Publish Center.
To enable the CDP widget, enter the widgetId from the previous step in the CDP Widget ID field under Widget Settings in the Magento store configuration and click Save Config.
To customize the placement of the PDP widget, modify catalog_product_view.xml. And use the move tag to move the widget block.

For example, you can create a new view/frontend/layout/catalog_category_view.xml file in a custom module in the app/code directory and use the move tag to move the widget block.
```
<move element="product.view.community_gallery" destination="category.product.list.additional" before="-" />
```

Testing and Troubleshooting

To test that everything was implemented correctly, we need to check two things -

Were all the products exported?
Are API calls being successfully made to the Emplifi UGC API?

Were all the products exported?

Before testing, please make sure that the Product Export job has at least run once. If you have already run the exports once, skip to step 3.

In order to run it manually. Open Admin Panel > Stores > Configuration > Emplifi > UGC. Press the Export Products to Emplifi button to start the exports.
Login to your Emplifi account and navigate to Products under the Album tab.
You should see a list of products on this page.
Try searching for a few products on this page that you know exist in your catalog.
In case the list is empty or you were not able to search for a particular product, proceed to the next step. Otherwise, proceed straight to the next section Are API calls being successfully made to the Emplifi UGC API?
There can be several causes of failure to export products so first, we need to find out the exact cause of the failure. The Product Exports job logs the progress and all exceptions to the server logs. So the next step for us is to get the both Magento server logs and the PHP (Apache or equivalent) logs.
The Magento server logs are usually located in var/log so navigate to that location and look for the file named pixlee.log.
For the PHP logs location, it depends on your setup. For example, if you're using Apache the logs should be in $Apache Root$/logs. We're looking for the file named php_error.log in this directory.
One of the most common issues that we encounter is a lack of allocated memory to the Magento or PHP/Apache server. Open the php_error.log file using your favorite text editor and search for a log entry similar to the following line

Allowed memory size of 33554432 bytes exhausted (tried to allocate 43148176 bytes) in PHP
If you found a similar looking error, please increase the allocated memory and run the product export job again.
Another common issue we encounter is a low setting for the max_execution_time. Look for a log entry similar to the following

Fatal error: Maximum execution time of 999 seconds exceeded in ...

If you found a similar log entry please increase the max_execution_time setting inside your php.ini file to at least 3600. And then try exporting the products again.
If at this point you're still not able to see any products exported to Emplifi, please contact us at support@emplifi.io and attach the both pixlee.log and php_error.log with the email.

Are API calls being successfully made to the Emplifi UGC API?

API calls are made to Emplifi UGC API when a customer adds something to their cart and when they buy something on your store. We need to make sure that these calls are being made at the right time.

Open your favorite browser and open a product page of your store. And click Add to Cart.
Open the pixlee.log file located in var/log using your favorite text editor and scroll down to the very end.
There should be an entry beginning with AddToCart
If you found the AddToCart calls then your analytics were integrated correctly. If not, contact us at support@emplifi.io and attach the pixlee.log file with the email.
Switch back to the browser and proceed to checkout and buy the product that you added to cart previously. Use a test payment method for the checkout.
When you reach the order confirmation page switch open the pixlee.log file again and ensure that you are viewing the latest copy of the file.
This time look for log entries beginning with CheckoutSuccess
If you do not see the CheckoutSuccess calls like in the screenshot, please contact us at support@emplifi.io and attach the pixlee.log file with the email.

🚧 Disclaimer: Mobile Analytics

Based on the design of Magento2, user agents are not passed in the add to cart and conversion events. This means that there is no current ability to split between mobile and desktop conversion data.

RequireJS error on pages containing widgets

To verify that you are encountering this issue, do the following:

Open your website on your browser and navigate to a page where a UGC widget should appear.
Open the developer tools for your browser, navigate to the console tab and verify that you are seeing this error:

🚧 Note

The cause of this error is that the Publish Center only generates embed code in plain HTML. Whereas the extension is compliant with RequireJS standards and expects scripts to be only embedded via RequireJS. This problem can be resolved by creating a widget with these steps here instead of directly adding the widget embed code from the Publish Center. However, if you wish to keep the generated embed code, follow the steps below.

Find the generated embed code for the widget. It should look like this:

    <div id="pixlee_container"></div>
    <script type="text/javascript">
      window.PixleeAsyncInit = function() {
        Pixlee.init({apiKey:'YOUR_API_KEY'});
        Pixlee.addSimpleWidget({widgetId:YOUR_WIDGET_ID});
      };
    </script>
    <script src="https://assets.pxlecdn.com/assets/pixlee_widget_1_0_0.js"></script>

Use the require function to change the embed code using these steps:

Use the require function and add the asset.pixlee.com url as a parameter.
Move the JavaScript code in the window.PixleeAsyncInit function to the require function's callback.
Call the Pixlee.resizeWidget() function at the end of the callback.

The new code should look like this:

<div id="pixlee_container"></div>
<script type="text/javascript">
  require(['https://assets.pxlecdn.com/assets/pixlee_widget_1_0_0.js'], function() {
      Pixlee.init({apiKey:'YOUR_API_KEY'});
      Pixlee.addSimpleWidget({widgetId:YOUR_WIDGET_ID});
      Pixlee.resizeWidget();
    }
  );
</script>

pixlee / magento2

Maintainers

Details