ERPLY connector Magento 2

ERPLY CONNECTOR

PURPOSE

This module is a software component that can be added to your Magento installation to provide integration with your Erply inventory management account. 

FEATURES

• Export products, product updates to Magento
• Export price lists to Magento
• Import of translations for categories and products from Erply
• Export categories, product groups
• Import order into Erply, export order status from Erply
• Payment methods mapping
• Import customers into erply
• Import schedules
• Logs, queue list 
• Multi Website support 
• Following translations can be imported from Erply:
• Product name
• Long and short description (webfields)
• Product and service group name
• Product categories name

REQUIREMENTS

• System

There must be sufficient file permissions to install extension.

Connector must be able to communicate with Erply (must be connected to the Internet, no firewall restrictions)

• Magento

Magento 2 Open source

Version 2.2.6 or below

No previous version of Erply Connector installed (uninstall if necessary)

• PHP / extensions

Version 7.1 or above.

PHP Curl extension.

• Cron

To run scheduled imports/exports Magento cron function must be correctly installed and

configured. No cron means no data exchange.

• Composer

Must be installed -  wazaari/monolog-mysql

 

INSTALLATION

• Preparatory activities

Backup!

Uninstall previous version if necessary

• Process

System magento connect manager

“Choose file”, then click “Upload”.

Click “Commit Changes”

• Complementary activities

Logging in and out

Cleaning caches

 

VERSION, LOG OF CHANGES

• Version 0.1.7

Last update: 12.09.19

• Log of changes

ver 0.0.10	Fixed bug in attribute parameter options
ver 0.1.0	Added new feature - assign category URL to all store views   (same url for all store views or not) Fixed bug in Erply category import
ver 0.1.1	Fixed bug in product image name import
ver 0.1.2	Fixed bug in product category Added new feature - assign product URL to all store views   (same url for all store views or not) Added new feature - text attribute mapping Fixed bug in boolean attribute
ver 0.1.3	Added new feature - meta auto-generation logic configuration for product Changed logic of creating product URL: added erply product ID to the url end Added new feature: Change order status in Magento if order completed Added new feature: possibility to add multiple categories Fixed bug in price list import Fixed swatch attribute option bug
ver 0.1.4	Added new feature: use price from product settings or from price lists
ver 0.1.5	fixed bugs in price lists imports fixed bugs in multiple websites price list import
ver 0.1.6	Added compatibility with Omniva, Smartpost parcel terminals module (shipping info sending to Erply) Fixed customer groups mapping bug  Fixed configurable product status bug
ver 0.1.7	Added Full Inventory Update Schedule

 

USER GUIDE

GENERAL SETTINGS

Scope: Global

Stores → Configuration → Devall 

• Enable logging

Devall → Log

For diagnostic purposes. These logs can be helpful for support staff who are troubleshooting problems.

• Enable error email sending

When import fails (any scheduled import), send an email notification of workflow error messages.

• Email

Receiver of error messages.

• Template

Marketing → Email templates → New template → Erply error email template

Email template for error email. 

 

ACCOUNT SETTINGS

• Erply Connection Allowed

Scope: Website

NO - all connection to Erply is disabled.

• Disable order sending

Scope: Website

YES - orders import to Erply is disabled.

• Client Code

Scope: Global

Erply client code

• Username

Scope: Global

Erply account user name, with admin rights.

• Password

Scope: Global

Erply account password

• Test Connection

Scope: Global

Check connection between Magento and Erply.

NB! In default configuration store view “Use system value” checkbox should be unticked.

 

CATEGORY SETTINGS

• Request only "web" categories

Scope: Global

YES - will be imported only Erply groups where “show in webshop” is ticked.

• Category URL assign to all store views

Scope: Website

NO - category url will be different for every store view - will be generated from store view category name.

YES - category url will be the same in all store views (generated from main store view category name - as defined in localization settings - default locale)

• Categories are defined in Erply as

Scope: Website

• Do not use Erply - Disable categories import from Erply
• Group - Categories will be imported from Erply “product and service groups”

NB! If necessary to disable some category - just untick “Show in webshop” in Erply. Don't Delete!

• Category - Categories will be imported from Erply “product categories”
• Multiple categories

Scope: Website

Possibility to assign products to multiple categories in Magento.

For enabling this feature complete the following steps: 

• Create text parameter in Erply 
• Assign parameter group to all service, product groups
• Add parameter name to Erply module → Category settings → Multiple categories
• Look “product categories” ID’s or  “product and service groups” ID’s in Erply URL.

F.e: https://s6.erply.com/363958/?lang=eng&section=prodgroup&edit=19 

In this case group ID will be 19.

• Write down (separated by commas) to Erply product settings

 

LOCALIZATION SETTINGS

• Locale mapping

Scope: Global

To associate Erply language with Magento store view. Used for product, categories, product and service groups, meta auto generation localization.

• Default locale

Scope: Global

Define Erply main language. Erply settings → Configuration → Default language

 

PRODUCT SETTINGS

Supported Erply product types:

• Simple
• Matrix
• Bundle = Magento bundle, functioning like group
• Simple,  Non-stock product or service = Magento virtual

 

• Request only "web" products

Scope: Global

YES - will be imported only products where “show in webshop” is ticked. 

Recommended option: NO 

• Attribute Set

Scope: Store view

Attribute set that will be used as a template for the product record.

• Tax Class

Scope: Website

Magento product tax class and Erply VAT rate id mapping 

(Erply settings → Invoice settings → VAT rates).

If mapped incorrectly in Magento product will be assigned to tax class -  None.

NB! From erply imported Net sales price

• Product URL assign to all store views

Scope: Website

NO - product url will be different for every store view, generated from store view product name.

YES - product url will be the same in all store views (generated from main store view product name - as defined in localization settings- default locale)

NB! If product name is changed, url also will change

• Meta auto-generation

Scope: Website

To generate automatically meta information.

• Meta title - from name
• keywords- from name
• description - from long description. 

 

NB! This setting is not connected with Magento default setting: Product fields auto generation

If manually edit meta in Magento, it will be overwritten during the next product import (if current product will be saved in Erply)

If configurable product will be created in Erply, or saved, meta will be created also for variations.

• Product Matrix dimensions

Scope: Store view

Link child products with configurable product.

Devall - Matrix dimension  - attributes automatically imported / deleted  from Erply.

Magento attribute must be:

• Global
• Following attribute types are supported:
• Dropdown
• Multiple - in frontend act like dropdown
• Text swatch 
• Visual swatch

NB! Color must be picked manually in Magento

NB!! For visual swatch and text swatch must be added before one option and name to description (Magento bug).

NB!! Erply product variations not connected with some matrix product - it will be not sent to Magento

• Attributes

Scope: Store view

Erply Attributes (in product attributes tab) are mapped against Magento product attribute.

Magento attribute must be:

• Global
• Following attribute types are supported:
• Text field
• Long Attributes

Scope: Store view

To store strings longer than 255 characters. 

Not all Erply accounts have it. Erply must turn this feature on.

Magento attribute must be:

• Global
• Following attribute types are supported:
• Text field
• Parameters

Scope: Store view

Magento attributes mapped against Erply parameters. 

To work with parameters, you first need to define "parameter groups" in Erply backend, and associate these with product groups. Each parameter group defines parameters for a specific type of product.

Magento attribute must be:

• Global
• Text field → Erply text or number parameter 
• Multiple select → Erply List choice parameter
• Yes / NO → Erply Yes / NO parameter
• Use price from product settings

Scope: Global

• Price list ID

Scope: Website

• Special Price list ID

Scope: Website

Price list ID from URL (f.e: pricelist&edit=2, ID will be 2).

• Warehouse ID

Scope: Store view

Erply warehouse ID (Inventory → Locations → Click on location → id from URL, f.e: section=warehouse&edit=1)

If in Erply more than 1 warehouse to Magento wll be imported mapped warehouse quantity not total.

CUSTOMER SETTINGS

Scope: Website

• Billing address type ID

Customer billing address mapping.

To get id: Settings → Customer registry settings → Address types → Click on necessary address type → get ID from URL

• Shipping address type ID

Customer shipping address mapping.

To get id: Settings → Customer registry settings → Address types → Click on necessary address type → get ID from URL

• Customer group mapping

Magento customer group mapping against Erply customer group. 

If nothing defined, customers by default will go to Erply Default group.

 

ORDER SETTINGS

NB!! Only orders in processing status automatically sent to Erply.

 

• Order type in erply

Scope: Website

Setting have the following order import possibilities:

• Order → Erply Order

NB! Erply order number will appear only after order is confirmed 

• Cashinvoice → Erply Invoice, type: waybill
• Waybill → Erply Invoice, type: waybill 
• Invwaibill → Erply Invoice, type: invoice-waybill

 

• Confirm order in erply

Scope: Website

YES - Erply order automatically will be confirmed in Erply

• Reserve goods in erply

Scope: Website

YES, stock will be reserved in erply (lay-by) upon order is created and confirmed.

• Check order status in erply

Scope: Website

Request order status updates from Erply.  

YES - If order status in Erply is “Completed”, in Magento will be created shipment and order status will be changed to “Complete”.

• Erply invoice payment method 

Scope: Global

Magento payment method mapped against Erply payment type (Erply settings →  Invoice settings → Payment types) and payment method (Erply settings → Invoice settings → Invoice payment methods)  

• Warehouse mapping 

Scope: Global

Shipping country (the country to which the product will be shipped) mapping against erply warehouse. By default product quantity will be decreased from warehouse stated in product settings.

• Shipping VAT rate ID

Scope: Website

VAT rate ID from Erply VAT rates.

Erply settings → Invoice settings → VAT rates → Get ID from URL

Example: If in Magento shipping vat rate 20%, shipping price include tax,  and in erply module settings vat rate ID for 9%.

In Erply order shipping VAT rate will be 9%

If Shipping VAT rate ID field is empty in Erply will be VAT rate as in Magento (if in Erply such rate is created, is not, VAT rate will be 0)

 

UPDATE SCHEDULE

Scope: Global

• Update schedule

Crons can be configured for:

• Product Update
• Product Image Update
• Category Update
• Inventory Update (based on Erply timestamp)
• Full inventory update
• Customer Update
• Price Lists Update

Price lists + Special price lists.

With every special price list import, b4 cleared all special prices, after imported a new one.

• Orders status Updates

Cron expressions: http://en.wikipedia.org/wiki/Cron

QUEUE SETTINGS

Scope: Global

• Loops per run

Loops per single product import

Recommended setting: 2

• Records per Loop

Quantity of products per loop.

Recommended setting: 100

 

CLEANUP SETTINGS

Scope: Global

• Logs record lifetime

Erply logs lifetime in admin (Devall → Log)

• Inactive queue items lifetime 

Inactive items lifetime in queue list (Devall → Queue list)

• Delete log file

Delete log file from server. Cron every day at 4 a.m

 

QUEUE LIST

Devall → Queue list 

Allows to view all active/inactive imports and to manually schedule an import.

MATRIX DIMENSION

Devall →Matrix dimensions

List of mapped matrix dimensions.

NOTES:

• If product deleted from Magento, and after again imported, stock will not be imported (Erply timestamp bug), solutions:
• Change inventory in Erply, and save
• Make full inventory import

• For successful import of photos, in Erply should be filled all product name fields (for all languages).

P.S Image scope should be Global