Skip to content
This repository has been archived by the owner on Feb 1, 2023. It is now read-only.

Latest commit

 

History

History
339 lines (257 loc) · 37.8 KB

INSTALL_GUIDE.md

File metadata and controls

339 lines (257 loc) · 37.8 KB
Raw

Installation Guide for Facebook Business Extension v4.0.0

  • The latest version of the plugin can be found at here
  • The latest version of the README can be found at here
  • The latest version of the INSTALL_GUIDE can be found at here
  • The latest version of the FAQ can be found at here
  • For other questions or bug reporting regarding the OpenCart plugin, please open a ticket with us at our helpdesk or open a new issue on github
  • For Facebook related issues or enquiries, please open a ticket with Facebook Business Support at Facebook Business Help Centre

Pre-requisites prior to installing the plugin

  1. The plugin supports these OpenCart versions - 2.0.x.x to 2.2.x.x, 2.3.x.x, 3.x.x.x and above.

  2. Remove all existing pixel implementations from the website. Duplicate pixel events may be fired if there are existing pixel implementations.

  3. If you were previously using the Facebook Business Extension plugin version 3.1.2 and below, please follow the Uninstall Guides below to uninstall the existing plugin before attempting to install the new plugin:

    • For Facebook Business Extension version 2.x.x to 3x.x, please click here

  4. Ensure that your web server uses PHP version 7.2 and above. This is because the plugin uses Facebook Business SDK internally and it requires PHP version 7.2 and above.

  5. Download the latest version of the plugin file, Facebook_Business_Extension-OCxxx.ocmod.zip, where xxx is the OpenCart version you are using.

    • You can get the latest version of the plugin from these websites:

    • Ensure that the plugin file ends with .ocmod.zip extension. Screenshot

    • Ensure that you've downloaded the correct zip file for your OpenCart installation.

  6. Installation of the plugin is via the OpenCart Extension Installer for all OpenCart versions. For OpenCart 2.0.x to 2.2.x, the plugin uses OCMOD (OpenCart Modifications) as well.

    • For OpenCart 2.0.x to 2.2.x:

      • You need to either
        • Option 1: Enable FTP option. Screenshot
          • Go to the admin panel of OpenCart and click on Settings.
          • Click on Edit button of your store.
          • Click on FTP tab and setup your FTP details.
        • Option 2: Install QuickFix: Extensions Installer issue when FTP support disabled.
      • Installation of the plugin through manual upload of the plugin's files onto your web server is not recommended as the OCMOD script will not be installed correctly. You should only install the plugin through manual upload if you are able to install the OCMOD script correctly. Otherwise, the extension will not work correctly.
      • vQmod installation is NOT supported.

    • For OpenCart 2.3.x or OpenCart 3.x:

      • There is no additional setup required as the extension uses OpenCart Events instead of OCMOD.
      • Installation of the plugin through manual upload of the plugin's files onto your web server is supported.

  7. Our plugin uses the default OpenCart folder structure, i.e. admin, catalog and system.

    • If your folder structure is not the same AND you are performing the installation of the plugin through manual upload, you will need to change the directory names of the plugin accordingly or ensure that you are uploading into the correct directories.
    • If you are performing installation through the OpenCart Extension Installer, you do not need to take any actions.

  8. Our plugin will generate the catalog feed of all your products and upload it to Facebook after the setup for Facebook Pixel and Catalog has been completed. Depending on your web server and database server configurations, you may experience issues if you have a large product catalog, e.g. more than 5000 products. You may also need to increase the memory settings for your web server and database server. Please kindly refer to the FAQ for more details.

  9. Since our plugin uses the Facebook Business SDK internally, the plugin file size might exceed your pre-defined PHP upload_max_filesize value. You may need to increase the value of upload_max_filesize for your web server in order to install the plugin.

Plugin installation

  1. Download the Facebook for OpenCart plugin from either:

  2. Install the Facebook for OpenCart plugin via the OpenCart Installer.

    • Video guides are available here:

    • Installation instructions:

      • Go to your OpenCart store's admin panel, and click on:

        • Extensions -> Extension Installer. (For OpenCart 2.x) Screenshot
        • Extensions -> Installer. (For OpenCart 3.x) Screenshot

      • Click on the 'Upload' button and select the plugin zip file (Please ensure that the zip file ends with .ocmod.zip). Click on the 'Continue' button if required. Screenshot

      • Go to your OpenCart store's admin panel again, and click on:

        • Extensions -> Modules (For OpenCart 2.0.x to 2.2.x) Screenshot
        • Extensions -> Extensions -> Choose 'Modules' from the Extension type dropdown list Screenshot

      • Locate Facebook Business Extension and click on Install button. Screenshot

      • (Additional Step) Only for OpenCart 2.0.x to 2.2.x:

        • Go to the admin panel of OpenCart and click on Extensions -> Modifications. Screenshot
        • Click on the Refresh button. Screenshot

      • Installation has been completed. You can now proceed with integrating your OpenCart store with Facebook Business by clicking on the 'Get started with Facebook' button.

  3. Setup the permission rights for Facebook Business Extension if you encounter "Permission Denied". Screenshot. Video guide

    • Ensure you are on the latest version of the Facebook Business Extension plugin. Latest version
    • The Facebook Business Extension plugin will automatically enable the permission access for the default Administrator group. For other user groups, you will need to provide the permission access manually.
    • Follow the below steps to provide the permission access:
      • Go to the admin panel and click on Menu -> Settings -> Users -> User Groups. Locate your user group and click on the Edit button. Screenshot
      • Locate extension/module/facebook_business for both Access and Modify permissions. Ensure the permissions are selected and click on Save button.
      • Access the Facebook Business Extension to verify that you are able to view the plugin.

Setup for Facebook business manager, page, pixel and catalog

  1. Access the Facebook Business Extension to setup business manager, page, pixel and catalog.

    • Go to the admin panel of OpenCart and click on Menu -> Facebook Business Extension Screenshot
    • Click on the 'Get Started with Facebook' button. Screenshot
    • Facebook login popup requests you to log in first. Screenshot
    • Read the welcome text and click Continue button. Screenshot
    • The Confirm Settings screen lets you configure the assets which you want to connect. Screenshot
    • Select an existing Facebook Business Manager or create a new Facebook Business Manager and click on Continue button. Screenshot
    • Select an existing Facebook Page or create a new Facebook Page and click on Continue button. Screenshot
    • Select an existing Facebook Catalog or create a new Facebook Catalog and click on Continue. Screenshot
    • Select an existing Facebook Ad Account or create a new Facebook Ad Account and click on Continue. Screenshot
    • Select the Facebook pixel you wish to use for your OpenCart store website. Toggle Advanced matching if you wish to active Facebook Advanced matching and click on Continue button. Screenshot
    • Verify the Business you selected is checked by default. It'll grant OpenCart the permission to manage your business. Screenshot
    • Click Next button to grant user permissions. Screenshot. You'll be asked for more permissions if on the latest version. Screenshot
    • Observe that the Facebook Business Extension setup is completed successfully. Click on Done. Screenshot
    • Close the popup, and wait for the FBE page to refresh automatically. Screenshot

  2. If you are an existing user of previous versions of Facebook Business Extension, you should see a different screen on which all of your previously connected assets were automatically populated. Click Continue button to finish the setup. Screenshot

Launch Management View

In Management View, you can add more features such as enable Facebook Page Shop plugin, Facebook Messenger Chat plugin and etc.

  1. Access the Facebook Business Extension Management View.

    • Ensure you are on versions 4.0.0 and above of the Facebook Business Extension plugin. Latest version
    • You must already have completed the setup for business manager, page, pixel and catalog for Facebook Business Extension. Steps here.
    • Go to the admin panel and:
      • Click on Facebook Business Extension (for all OpenCart versions) Screenshot
      • Or, (for OpenCart 2.0.x to 2.2.x) click on Extensions -> Modules -> Facebook Business Extension Screenshot
      • Or, (for OpenCart 2.3.x to 3.x.x) click on Extensions -> Extensions -> Choose 'Modules' from the Extension type dropdown list -> Facebook Business Extension Screenshot
    • Click on Manage Settings button. Screenshot

  2. (Optional) Follow steps here to enable Facebook Page Shop plugin.

  3. (Optional) Follow steps here to enable Facebook Messenger Chat plugin.

Setup for Facebook Page Shop

  1. Enable the Facebook Page Shop plugin.
    • In the Management View popup window, ensure you are on Home tab, locate the feature section and click on View button next to Create a Shop on Your Page. Screenshot
    • In the popup, click on Add plugin button. Screenshot
    • If added successfully, the Page Shop plugin status is shown as Added. Screenshot
  2. Verify that your Facebook Catalog is correctly connected to your Page Shop.
    • In the Managment View popup window, click Catalog tab, and click Open Catalog Manager button. Screenshot
    • In the Catalog Manager, click Settings tab, verify that your Page Shop is correctly connected. Screenshot
  3. Disable the Facebook Page Shop plugin.
    • Ensure you have enabled the Facebook Page Shop plugin, i.e. the Page Shop Plugin status is shown as Added. Screenshot
    • Click on View button next to Create a Shop on Your Page. Screenshot
    • In the popup, click on Delete button. Screenshot

Setup for Facebook Messenger chat

  1. Enable the Facebook Messenger chat plugin.

    • You must already have completed the setup for business manager, page, pixel and catalog for Facebook Business Extension. Steps here.
    • Go to the admin panel and:
      • Click on Facebook Business Extension (for all OpenCart versions) Screenshot
      • Or, (for OpenCart 2.0.x to 2.2.x) click on Extensions -> Modules -> Facebook Business Extension Screenshot
      • Or, (for OpenCart 2.3.x to 3.x.x) click on Extensions -> Extensions -> Choose 'Modules' from the Extension type dropdown list -> Facebook Business Extension Screenshot
    • Click on the 'Manage Settings' button. Screenshot
    • In the popup window, locate the Messenger Chat plugin and click on the Add button. Screenshot
    • Click on Add plugin button. Screenshot
    • Setup and customise your Messenger Plugin's Language, Greeting Message and Appearance settings, then click on the 'Next' button when you are done. Screenshot
    • Add your domain name, e.g. https://yourwebsite.com/ to the Whitelist so that your Messenger Plugin will appear. After adding your domain to the whitelist, click on 'Done'. Screenshot
    • You can now close the popup window.
    • Click on the 'Manage Settings' button again to ensure that the settings are saved correctly into your OpenCart store. Screenshot
    • Proceed to the homepage of your OpenCart store and you should see the Messenger chat plugin at the bottom-right corner. Screenshot

  2. Edit the Facebook Messenger chat plugin settings.

    • Ensure that you have enabled the Facebook Messenger chat plugin, and have already completed the above steps in (1).
    • Go to the admin panel and:
      • Click on Facebook Business Extension (for all OpenCart versions) Screenshot
      • Or, (for OpenCart 2.0.x to 2.2.x) click on Extensions -> Modules -> Facebook Business Extension Screenshot
      • Or, (for OpenCart 2.3.x to 3.x.x) click on Extensions -> Extensions -> Choose 'Modules' from the Extension type dropdown list -> Facebook Business Extension Screenshot
    • Click on the 'Manage Settings' button. Screenshot
    • In the popup window, locate the Messenger Chat plugin and click on View button. Screenshot
    • CLick on the 'Update Plugin' button to modify existing settings and configurations. Screenshot
    • Complete your changes and click on the 'Done' button to save your settings.

  3. Disable the Facebook Messenger chat plugin settings.

    • Ensure that you have enabled the Facebook Messenger chat plugin, and have already completed the above steps in (1).
    • Go to the admin panel and:
      • Click on Facebook Business Extension (for all OpenCart versions) Screenshot
      • Or, (for OpenCart 2.0.x to 2.2.x) click on Extensions -> Modules -> Facebook Business Extension Screenshot
      • Or, (for OpenCart 2.3.x to 3.x.x) click on Extensions -> Extensions -> Choose 'Modules' from the Extension type dropdown list -> Facebook Business Extension Screenshot
    • In the popup window, locate the Messenger Chat plugin and click on the 'Disable' button. Screenshot

Delete the existing settings for Facebook for OpenCart

  1. Delete the existing settings. Video guide
    • You must already have completed the setup for business manager, page, pixel and catalog for Facebook Business Extension. Steps here.
    • Go to the admin panel and:
      • Click on Facebook Business Extension (for all OpenCart versions) Screenshot
      • Or, (for OpenCart 2.0.x to 2.2.x) click on Extensions -> Modules -> Facebook Business Extension Screenshot
      • Or, (for OpenCart 2.3.x to 3.x.x) click on Extensions -> Extensions -> Choose 'Modules' from the Extension type dropdown list -> Facebook Business Extension Screenshot
    • You should see an 'Uninstall' button at your Facebook Business Extension plugin page. Screenshot
    • A pop up confirmation should appear. Click on the OK button to proceed with deletion. Screenshot
  2. Once deleted successfully, you should see the page with 'Get Started' button. Screenshot

Uninstall the plugin

  • If you are using Facebook Business Extension v3.x.x and below:

    1. Video guide

    2. You must already have installed the Facebook for OpenCart plugin on your OpenCart website.

    3. Go to the admin panel of your OpenCart website and click on Menu -> Extensions -> Modifications. Screenshot

    4. Locate and select the Facebook Business Extension plugin. Click on the Delete button on the top right of the screen. Screenshot

    5. Click on Ok button to delete the plugin. Screenshot

    6. Click on Refresh button to refresh the existing plugins on your OpenCart website. Screenshot

  • If you are using Facebook Business Extension v4.0.0 and above:

    • For OpenCart 2.0.x to 2.2.x:

      1. You must already have installed the Facebook for OpenCart plugin on your OpenCart website.

      2. Go to the admin panel of your OpenCart store and click on Extensions -> Modules -> Facebook Business Extension. Click on 'Uninstall'. Screenshot

      3. Then, proceed to Extensions -> Modifications, and locate 'Facebook Business Extension'. Screenshot

      4. Click on the 'Uninstall' button for 'Facebook Business Extension'.

      5. Click on the 'Refresh' button to refresh the existing plugins on your OpenCart website. Screenshot

      6. Do note that if you want to remove the plugin files from your web server, you will have to remove them manually. Please check on the location of the files at our GitHub Repository here

    • For OpenCart 2.3.x:

      1. You must already have installed the Facebook for OpenCart plugin on your OpenCart website.

      2. Go to the admin panel of your OpenCart website and click on Extensions -> Extensions -> Modules -> Facebook Business Extension. Click on 'Uninstall'. Screenshot

      3. Do note that if you want to remove the plugin files from your web server, you will have to remove them manually. Please check on the location of the files at our GitHub Repository here

    • For OpenCart 3 and above:

      1. You must already have installed the Facebook for OpenCart plugin on your OpenCart website.

      2. Go to the admin panel of your OpenCart website and click on Extensions -> Extensions -> Modules -> Facebook Business Extension. Click on 'Uninstall'. Screenshot

      3. To remove the plugin files from your web server, proceed to Extensions -> Installer, and locate the .ocmod.zip file you uploaded previously to install the Facebook Business Extension plugin. Then, click on the 'Uninstall' button. Screenshot

Upgrade the plugin to a newer version

  • If you are using Facebook Business Extension v4.x.x, and upgrading to Facebook Business Extension v4.x.x and above:

    1. You must already have installed the Facebook Business Extension plugin on your OpenCart website.

    2. To upgrade the existing Facebook Business Extension for versions 4.0.0 and above, you can choose one of the following:

      • Simply install the extension again through the Extension Installer. You can refer to the steps here for installation through the Extension Installer.

        • For OpenCart 2.0.x to 2.2.x, you need to uninstall the existing Facebook Business Extension OCMOD at Extensions -> Modifications. Screenshot
        • For OpenCart 3 and above, you may want to uninstall the existig Facebook Business Extension at Extensions -> Installer. Simply locate the .ocmod.zip file you uploaded previously to install the Facebook Business Extension plugin. Then click on the 'Uninstall' button. Screenshot

      • Manually upload the contents of the 'upload' folder into your web server and replace the existing files.

        • Do note that this will only work with OpenCart v2.3.x and above.

    3. After the new version of the plugin has been uploaded, you will have to:

      • For OpenCart 2.0.x to 2.2.x:
        • Go to the admin panel of your OpenCart store and click on Extensions -> Modules -> Facebook Business Extension. Click on 'Uninstall'. Screenshot
        • Then, on the same page, click on 'Install' again.
        • This is to install/uninstall any Events or database changes that might have been made in the new version of the plugin. Do note that this will not remove your connection with Facebook Business but your OpenCart settings for the Facebook Business Extension (i.e. syncing of special prices as discount to Facebook Catalog option and enabling of cookie bar option) will be reset.
        • Go to the admin panel of OpenCart and click on Extensions -> Modifications. Screenshot
        • Click on the Refresh button. Screenshot

      For OpenCart 2.3.x to 3.x.x: - Go to the admin panel of your OpenCart website and click on Extensions -> Extensions -> Modules -> Facebook Business Extension. Click on 'Uninstall'. Screenshot - Then, on the same page, click on 'Install' again. - This is to install/uninstall any Events or database changes that might have been made in the new version of the plugin. Do note that this will not remove your connection with Facebook Business but your OpenCart settings for the Facebook Business Extension (i.e. syncing of special prices as discount to Facebook Catalog option and enabling of cookie bar option) will be reset.

  • If you are using Facebook Business Extension v3.x.x and below, and upgrading to Facebook Business Extension v4.x.x:

    1. You must already have installed the Facebook Business Extension plugin on your OpenCart website.

    2. Delete the existing Facebook Business Extension plugin. Video guide

    3. Install the new Facebook Business Extension version 4.0.0 and above by following the steps here.

Cookie bar on your OpenCart website

  1. Disable the cookie bar.

    • Ensure you are on the versions 2.0.3 and above of the Facebook Business Extension plugin. Latest version

    • For Facebook Business Extension version 3.1.2 and below:

      • Go to the admin panel of OpenCart and click on Menu -> Facebook Business Extension -> Facebook Business Extension. Screenshot
      • Uncheck the Show cookie bar on store website option and click on Save button. Screenshot

    • For Facebook Business Extension version 4.0.0 and above;

      • Go to the admin panel of your OpenCart website and click on Facebook Business Extension. Screenshot
        • Alternatively, go to:
          • Extensions -> Modules -> Facebook Business Extension (for OpenCart 2.0.x to 2.2.x) Screenshot
          • Extensions -> Extensions -> choose 'Modules' from the Extension type dropdown list -> Facebook Business Extension (for OpenCart 2.3.x and above) Screenshot
      • Click on the 'Settings' tab and select 'Disable' for the 'Show cookie bar on store website' option. Then click on the Save button. Screenshot

  2. Enable the cookie bar.

    • Ensure you are on the versions 2.0.3 and above of the Facebook Business Extension plugin. Latest version

    • For Facebook Business Extension version 3.1.2 and below:

      • Go to the admin panel and click on Menu -> Facebook Business Extension -> Facebook Business Extension. Click on Manage Settings button. Screenshot
      • Check the Show cookie bar on store website option and click on Save button. Screenshot

    • For Facebook Business Extension version 4.0.0 and above;

      • Go to the admin panel of your OpenCart website and click on Facebook Business Extension. Screenshot
        • Alternatively, go to:
          • Extensions -> Modules -> Facebook Business Extension (for OpenCart 2.0.x to 2.2.x) Screenshot
          • Extensions -> Extensions -> choose 'Modules' from the Extension type dropdown list -> Facebook Business Extension (for OpenCart 2.3.x and above) Screenshot
      • Click on the 'Settings' tab and select 'Enable' for the 'Show cookie bar on store website' option. Then click on the Save button. Screenshot

Using OpenCart Product Specials as Sale price in Facebook Catalog

  1. Disable the special price to be used as discount.

    • Ensure you are on the versions 2.1.11 and above of the Facebook Business Extension plugin. Latest version

    • For Facebook Business Extension version 3.1.2 and below:

      • Go to the admin panel of OpenCart and click on Menu -> Facebook Business Extension -> Facebook Business Extension. Screenshot
      • Uncheck the Sync product special price as discount option and click on Save button. Screenshot
      • Click on Resync Products to Facebook button to resync the product details to Facebook.

    • For Facebook Business Extension version 4.0.0 and above:

      • Go to the admin panel of your OpenCart website and click on Facebook Business Extension. Screenshot
        • Alternatively, go to:
          • Extensions -> Modules -> Facebook Business Extension (for OpenCart 2.0.x to 2.2.x) Screenshot
          • Extensions -> Extensions -> choose 'Modules' from the Extension type dropdown list -> Facebook Business Extension (for OpenCart 2.3.x and above) Screenshot
      • Click on the 'Settings' tab and select 'Disable' for the 'Sync product special price as discount to Facebook catalog' option. Then click on the Save button. Screenshot
      • Force a resync of the products to Facebook Catalog by:
        • Click on the 'Connection' tab and click on 'Manage Settings' button. A popup window should appear. Screenshot
        • In the popup window, look for the 'Catalog' card and click on the 'View' button. This should open a new window in your browser. Screenshot
        • In the new window, locate the 'Data Source' item in the left column menu and click on it. Screenshot
        • Look for the Catalog Feed that belongs to your OpenCart store and click on its name. Screenshot
        • Click on the 'Upload Now' button to force a resync of your products from your OpenCart store to Facebook Catalog. Screenshot

  2. Enable the special price to be used as discount.

    • Ensure you are on the versions 2.1.11 and above of the Facebook Business Extension plugin. Latest version

    • For Facebook Business Extension version 3.1.2 and below:

      • Go to the admin panel and click on Menu -> Facebook Business Extension -> Facebook Business Extension. Click on Manage Settings button. Screenshot
      • Check the Sync product special price as discount option and click on Save button. Screenshot

    • For Facebook Business Extension version 4.0.0 and above:

      • Go to the admin panel of your OpenCart website and click on Facebook Business Extension. Screenshot
        • Alternatively, go to:
          • Extensions -> Modules -> Facebook Business Extension (for OpenCart 2.0.x to 2.2.x) Screenshot
          • Extensions -> Extensions -> choose 'Modules' from the Extension type dropdown list -> Facebook Business Extension (for OpenCart 2.3.x and above) Screenshot
      • Click on the 'Settings' tab and select 'Enable' for the 'Sync product special price as discount to Facebook catalog' option. Then click on the Save button. Screenshot
      • Force a resync of the products to Facebook Catalog by:
        • Click on the 'Connection' tab and click on 'Manage Settings' button. A popup window should appear. Screenshot
        • In the popup window, look for the 'Catalog' card and click on the 'View' button. This should open a new window in your browser. Screenshot
        • In the new window, locate the 'Data Source' item in the left column menu and click on it. Screenshot
        • Look for the Catalog Feed that belongs to your OpenCart store and click on its name. Screenshot
        • Click on the 'Upload Now' button to force a resync of your products from your OpenCart store to Facebook Catalog. Screenshot