This article is about installing the Brightpearl Magento extension for the first time. If you are upgrading to a newer version you will need to remove the old version first, learn more here.
Extension for Magento version 1
Please contact Brightpearl support or your account manager to request the installation files.
The installation pack will contain two folders with all the required installation files:
Extension for Magento version 2
The extension for version 2.x Magento is not available for download online so, please contact Brightpearl support or your account manager to request the installation files.
The installation pack will contain two folders containing all the required installation files:
Installing the Brightpearl Magento extension for the first time
Before beginning the installation:
- Take a current backup of the Magento site
Do this in the Magento admin panel, at System > Tools > Backups. Take a backup of the system, database and media, and database.
- Disable the Magento compilation function
Do this in the Magento admin panel, at:
Version 1.x: System > Tools > Compilation.
Version 2.x: System > Web Setup Wizard.
- Enable the Magento configuration cache
Do this in the Magento admin panel, at System > Cache Management.
Installing the files:
- Unzip the two files and place the contents of each onto the Magento server
The Install location and method is different depending on which Magento version:
Version 1.x: Copy the contents of the extension files to the root folder of your Magento integration. Note: Do not copy the folders, only the contents.
Version 2.x: Use the standard module folders. A Magento developer should be able to assist with this. There are also numerous resources available online from Magento and from developers regarding the various methods of doing this. The important part to note is the vendor name should be Hotlink and there are two modules to install (one named Framework and another named Brightpearl) which are within the zip file.
- Refresh the cache
Do this in the Magento admin panel, at System > Cache Management. Select the cache types and use the actions to refresh.
- Logout and back in to the Magento admin panel
This will ensure the session is refreshed and will prevent 404 errors.
- Re-enable the Magento compilation functionality
This was disabled prior to installation and can now be re-enabled from the same screens.
- Confirm new menus are available in the Magento admin panel
In Magento 1.x versions look for a main menu called ‘Interactions’.
In Magento 2.x version look for the main menu called ‘Brightpearl’.
I can’t open the Brightpearl Magento extension configuration screens (404 errors)
404 errors when trying attempting to access the modules configuration screens may be caused by an expired session. Try logging out and back in to refresh the session. This usually occurs when the Magento account was logged in during installation of the extension.