Skip to content

Latest commit

 

History

History
138 lines (99 loc) · 8.82 KB

README.md

File metadata and controls

138 lines (99 loc) · 8.82 KB
Raw

Magento Community plugin

Sales Layer Magento Community plugin

PHP Version Magento Version GitHub release

This is the official Sales Layer's plugin for Magento Community (Open Source).

Description

This plugin allows you to easily synchronize your Sales Layer catalogue information with your Magento Community. And you can find more detailed documentation at our website.

Important Notes

Please check the important notes for the installation. (In some cases, a Sales Layer account might be needed to access the documentation).

Requirements

  • cUrl extension installed; In order to call and obtain the information from Sales Layer.
  • Define the fields relationship in the Sales Layer Magento connector:
    • Most Magento fields are already defined in each section, extra fields for products or variants will be Stores -> Attributes -> Product and they must have been created in Magento in order to synchronize.
    • When synchronizing a product with variants, Magento attributes that are synchronized will be marked as Used for variations, then, attribute values from the product and variants will be combined and assigned to the parnet product. Variations must have only one value for each attribute.
  • Inside categories, products and variants there will be attributes; Sales Layer Product Identification, Sales Layer Product Company Identification and Sales Layer Format Identification, don't modify or delete this attributes or its values, otherwise, the products will be created again as new ones in the next synchronization.
  • Inside the connector configuration you can set different values before the synchronization in the different tabs, such as:
    • Auto-synchronization and preferred hour for it.
    • The stores where the information will be updated.
    • The root category where the incoming category branch will be set.
    • Avoid stock update. (stock will be updated only at creation of new items)
    • Variant configurable attributes.

How To Start

1. Module package install process

The recommended way to install this extension is through Composer.

Warning. If you have previously installed the plugin manually in root folder 'app/code', uninstall it. Then install the plugin automatically through composer. If you try to install it in both ways at the same time, in step 1.2 Magento will return an error.

1.1 Through Composer. In your Magento root folder, execute command:

composer require saleslayer/magento-community-plugin

See install extensions on Magento Open Source for more info.

Info If you have a previous version of the plugin installed in root folder 'app/code', please delete the complete folder of the plugin before moving forward with the plugin's installation via Composer.

Once executed and installed, the plugin will be found in your Magento installation root path, inside the folder 'vendor/saleslayer/magento-community-plugin/

1.1.1 Composer command examples

To install the latest valid version of the main branch:

composer require saleslayer/magento-community-plugin

To install the latest valid version having the 2.7.* tag (the number of version can be changed to any tag number that includes Composer):

composer require saleslayer/magento-community-plugin "2.7.*"

Branch feature-295 will be installed (the branch name can be changed to any branch that includes Composer):

composer require saleslayer/magento-community-plugin:dev-feature_295

To install the latest dev version:

composer require saleslayer/magento-community-plugin:2.7.x-dev

1.1.2 Composer requirements

Following Version guidance, check the plugin version to check which PHP and Magento version are required to install the plugin.

In case a requirement is not met, an error will be given by Composer.

Info This will only happen if your Magento installation doesn’t met the requirements of the specific branch or tag version being installed, or by default, none of the main branch releases.

1.2 From Magento root folder execute commands:

php bin/magento setup:upgrade
php bin/magento setup:di:compile (if there's an error with 'var/di/' folder just delete it and execute this command again)
php bin/magento setup:static-content:deploy
php bin/magento cache:clean

1.3 After executing the commands, Sales Layer module will be installed

2. Create a Sales Layer Magento connector and map the fields

2.1 The plugin needs the connector ID code and the private key, you will find them in the connector details of Sales Layer.

3. Add the connector credencials in Magento

3.1 Go to Sales Layer -> Import -> Add connector and add the connector id and secret key.

3.2 Finally, In Sales Layer -> Import -> The connector you created, push Synchronize Connector to import categories, products and variants automatically.

Version Guidance

Branch Status Magento Open Source Version PHP compatibility Changelog Composer
2.5.x EOL >= 2.1.4, <= 2.4.0 7.3 Changelog 2.5.x No
2.6.x Fixes only >= 2.1.4, <= 2.4.5 >= 7.3, <= 8.1 Changelog 2.6.x No
2.7.x Stable >= 2.4.4, <= 2.4.7 8.1, 8.2 Changelog 2.7.x Yes

Branch 2.7.x Release recommended configuration

Release Magento2 Version PHP Web Server
2.7.0 Magento Open Source 2.4.6-p3 PHP 8.1 Apache2.4
2.7.1 Magento Open Source 2.4.6-p3 PHP 8.1 Apache2.4
2.7.2 Magento Open Source 2.4.7 PHP 8.2 Apache2.4

Warning. Adobe releases frequently new Magento Open Source versions, fixing bugs and/or adding new functionallity. Some of this versions could be in conflict with this plugin. We highly encourage you to set up the configuration recommended in the guidance table for running correctly this extension.

Note. See also Magento system requirements for the right environment choice.