Magento Extension Install¶
In order for the Magento connector to access Magento it must be extended with the various provided extensions. The base extension is required, the others should be installed according to your integration requirements.
You will need access to the Magento 2 file system and the ability to run the installation commands from a console on the server.
Requirements: Magento 2.2.x, 2.3.x and 2.4.x
Base Extension¶
EC Internet Base Extension serves as the core extension for all other EC Internet extensions to build on top of.
Features¶
It adds the following features to Magento 2:
- SyncComplete() API call to fire off other extension's events once a sync has been completed.
- GetAttributes() API call for the Customer object to give IMan knowledge of all customer attributes on the site.
- Adds 'customer_number' attribute to the Customer object for linking Magento customers with Accounting System customer IDs.
- Adds 'ship_to_id' attribute to the CustomerAddress object for linking Magento addresses with Accounting System address IDs.
Install¶
- Extract the zip to your Magento 2 root directory to create the following folder structure:
app/code/ECInternet/Base - Run
php -f bin/magento module:enable ECInternet_Base - Run
php -f bin/magento setup:upgrade - Run
php -f bin/magento setup:di:compile - Flush the Magento cache
Customer Features¶
The ECInternet_CustomerFeatures extension assists in syncing customers by adding missing functionality and fields and improving existing Magento 2 customer functionality where needed.
Features¶
- Adds ability to disable Customer registration.
- Adds ability to disable Customer welcome email.
- Adds ability to set default password for new Customers.
- Adds ability to limit CustomerGroups which can add new or edit existing addresses.
- Enhances new customer notification email.
Attributes
The extension adds the following attributes:
- Customer
- company_name
- ecinternet_cust_active_sent
- ecinternet_customer_activated
- ecinternet_is_active
- CustomerAddress
- contact_name
Install¶
- Extract the zip to your Magento 2 root directory to create the following folder structure:
app/code/ECInternet/CustomerFeatures - Run
php -f bin/magento module:enable ECInternet_CustomerFeatures - Run
php -f bin/magento setup:upgrade - Run
php -f bin/magento setup:di:compile - Flush the Magento cache
Order Features¶
OrderFeatures contains multiple pieces of functionality which extend existing logic in the Magento 2 "Sales" module, specifically the Order sub-module.¶
Features¶
- Payment Method]
- ERP Terms (
ecinternet_erpterms) - Admin-Only Free Payment Method (
ecinternet_free)
- ERP Terms (
- Shipping Method
- Admin-Only Shipping Method (
ecinternet_admin_only)
- Admin-Only Shipping Method (
- Order Status
- Partially Shipped (
partially_shipped) - Staging (
staging)
- Partially Shipped (
Attributes¶
The extension adds the following attributes to Magento
- Customer
- ERP Terms (
erp_terms) - ShipVia Code (
ship_via_code)] - ShipVia Desc (
ship_via_desc)
- ERP Terms (
- CustomerAddress
- ShipVia Code (
ship_via_code) - ShipVia Desc (
ship_via_desc)
- ShipVia Code (
- Invoice
- ERP Terms (
erp_terms) - Order Comment (
order_comment) - PO Number (
po_number)
- ERP Terms (
- Order
- ERP Terms (
erp_terms) - External Order Reference (
external_order_reference) - Order Comment (
order_comment) - PO Number (
po_number) - ShipVia (
ship_via)
- ERP Terms (
- OrderItem
- Invoice Document Number (
invoice_docnumber)
- Invoice Document Number (
- Invoice
- ERP Terms (
erp_terms) - Order Comment (
order_comment) - PO Number (
po_number)
- ERP Terms (
Install¶
- Extract the zip to your Magento 2 root directory to create the following folder structure:
app/code/ECInternet/OrderFeatures - Run
php -f bin/magento module:enable ECInternet_OrderFeatures - Run
php -f bin/magento setup:upgrade - Run
php -f bin/magento setup:di:compile - Flush the Magento cache
Sage Account Extension¶
The Sage Account module adds Sage invoice and order history information to the Magento 2 backend for viewing historical invoices and orders.
Installation¶
- Unzip the zip file in
app/code/ECInternet - Enable the module by running
php bin/magento module:enable ECInternet_Sage300Account - Apply database updates by running
php bin/magento setup:upgrade - Recompile code by running
php bin/magento setup:di:compile - Flush the cache by running
php bin/magento cache:flush
Attributes¶
The extension adds the following attributes to Magento
- Order
is_invoice_paymentuom
- order_item
invoice_docnumber
- sales_order_status
invoice_payment_complete
- quote_item
invoice_docnumberuom
- Product
uom
Notes¶
Reorder Custom Products - Requests
- Add 'uom'
- Add "Last purchased date"
- Add ± to quantity box
Reorder Custom Products – Issues¶
- Requesting quantity which does not exist redirects user to product page. We want to block this because these products will have visiliby = 1 so product isn't viewable.
Sage Pricing Extension¶
The Sage Pricing module adds the ability to synch the pricing records from Sage to Magento.
Installation¶
- Extract the zip to your Magento 2 root directory to create the following folder structure:
app/code/ECInternet/Sage300Pricing - Run
php -f bin/magento module:enable ECInternet_Sage300Pricing - Run
php -f bin/magento setup:upgrade - Run
php -f bin/magento setup:di:compile - Flush the cache by running
php bin/magento cache:flush
Attributes¶
The extension adds the following attributes to Magento.
Customer- Customer Type (
customer_type) - Currency Code (
currency_code)
RAPID web Sync¶
RAPIDWebSync adds IMan sync information to the Magento 2 backend for viewing sync progress and state and adds needed API methods for rapid sync of product and simple pricing data to Magento 2.
Features¶
- Manage Product Info
- Manage Inventory
- Create Categories on Import
- Manage Group/Contract/Tier Pricing
- Set Product Images
Install¶
- Extract the zip to your Magento 2 root directory to create the following folder structure:
app/code/ECInternet/RAPIDWebSync - Run
php -f bin/magento module:enable ECInternet_RAPIDWebSync - Run
php -f bin/magento setup:upgrade - Run
php -f bin/magento setup:di:compile - Flush the Magento cache