Magento setup

This article contains the integration of Magento stores with Green Story

Client specific inputs

• Client ID: XXXXXXXXXXXXXXXXXXXXXXXXXXX
• SHA-256 Shared Key: XXXXXXXXXXXXXXXXXXXXXXXXXX
• Product Notification Url: https://store-sync- service.greenstory.ca/api/webhooks/products/magento
• Order Notification Url: https://store-sync- service.greenstory.ca/api/webhooks/orders/magento

Generic Inputs

• greenstoryJS value:

<script type="text/javascript" src="https://gsstatic.greenstory.ca/widgets/app/greenstoryinitMagento.min.js"></script>

Email html

 (only if carbon offsetting functionality is enabled)

Summary

• This plugin provides a solution that enables Magento ecommerce Clients to export the products and orders to the greenstory platform and add impact and carbon offset widgets to various pages
• The plugin provides the following main features:
  • Exports the bulk products or recently created products to the green story platform.
  • Export recently placed order to the green story platform
  • Add aggregate and product-specific impact and carbon offset stats via widgets to various pages such homepage, product pages, cart page and customer account page

• Version: 2.0
• Last Updated Date: 15-Jun-2022

Component Overview

Limitations

• The plugin operates within the Magento instance limitations, as allowed by the system.
• This plugin only allows products and orders to be exported.
• Full Product synchronization export option is available, but if it's timing out, we need to execute the script provided below in server

php bin/magento greenstory:sync_all_products

Compatibility

• The magento plugin plugin is compatible with Magento 2.0 and above

Plugin Installation

To integrate Magento plugin in to the website, you will need to follow these steps:

1. Upload the zipped module file to <Magento root dir>/app/code directory
2. Unzip the module file
3. To complete the installation, follow the below steps. These are standard steps for installing any module in Magento (https://devdocs.magento.com/extensions/install/)
   1. Enable the module and clear static view files
      
      
   2. You should see the following output
      
   3.    Register the module
      
   4. Recompile your Magento project
   5. Verify that the module is enabled
   6. you should see output verifying that the extension is no longer disabled
   7. Run the following command
      

   8. Clean the cache

   9. Give Write Permissions required
      
      

Site preferences configuration

The plugin will make use of a set of Magento admin configuration to function properly. These configurations are available at a global level or at an individual store level. Global configurations are carried over as default configurations at the store level

1.  Admin -> Stores -> Configurations -> Green Story -> Impact Visuals

Post Plugin Installation Steps

1. Update the ‘Green Story Client ID’ configuration with the client ID provided for your organization
2. Update the ‘Encryption Key’ configuration with the SHA-256 key provided for your organization
3. Ensure ‘Green Story Library File’, ‘Product Notification Url’ and ‘Order Notification url’ have values as provided in the Client specific input section
4. Complete a full product sync per store by clicking on the Sync All Product Button
5. Turn ON the ‘Enable Product Notification’ configuration
6. Turn ON ‘Enable/Disable Widget Globally’ configuration
7. Turn ON each widget configuration as per which widget needs to be enabled or disabled
8. Change language or locale configurations for each store if a different language or locale then the default of the store is required
9. Turn ON ‘Enable Order Notification’ once the setup is complete and we are ready to go-live

Adding Widgets

• Create a new Widget
• Go to Content > Widgets
• Add a new Widget with following settings
• Type: (Choose any one of the following widget from Green Story)
• Green Story Brand Offset Widget
• Green Story Cart Offset Visual Widget
• Green Story Counter Widget
• Green Story Cart Impact Visual Widget
• Green Story Customer Impact Visual Widget
• Green Story Product Offset Widget
• Green Story Product Widget

1. Design/package Theme: Choose the theme you are using
2. Widget Title: Provide an appropriate name based on the type of widget selected.
3. Assign to store views: Choose the store view you want to assign the widget to
4. Layout updates section

• Display on: Specified Page
• Page: CMS Home Page (or the page which is your home page)
• Container: Choose where on the page you want to show the widget
• Save

View Plugin Logs

To debug product sync or order sync we can get the logs from the below path

1. var/log/api.log
2. var/log/greegreenstory_export.log