ErpConnector (optional)
GitHub - magesuite/erp-connector
ERP connector module offers a solution to configure and control the connection to ERP systems. The functionality makes managing the exchange of data with an external system simpler as some changes can be made directly in the admin panel, without the need to change the code. This allows for a quick reaction, for example, when communication with a system needs to be shut down for a certain period of time.
Â
- 1 Installation
- 2 User manual
- 3 Admin settings
- 3.1 General
- 3.2 Manage providers
- 3.2.1 Provider fields
- 3.2.2 Connector fields
- 3.2.2.1 FTP connector
- 3.2.2.2 SFTP connector
- 3.2.2.3 SOAP connector
- 3.2.2.4 HTTP connector
- 3.2.2.5 Email connector
- 4 Backend
- 5 Frontend
Installation
This module is optional.
composer require "creativestyle/magesuite-erp-connector" ^1.0.0
User manual
Admin settings
General
It’s the general configuration of the Erp Connector.
Configuration can be found in the admin panel:
Stores > Configuration > MageSuite > Erp Connector
General
Â
Enabled
- field allows to enable/disable ERP integration. If disabled, data won’t be sent to providers.
Additional Code List
- Additional codes, which are used in the provider configuration
Scheduler
Method
- Which method should be used by the scheduler, Cron
or RabbitMQ
Â
Manage providers
The provider section allows management of specific providers (ERPs), connections configuration, order export, stock import, and order tracking.
It can be found in the admin panel:Sales > Erp Connector > Providers
Provider fields
Â
Provider Name
- Name of provider
Provider Email
- Email to provider
Provider Code
- Code, used to find correct mapping in the code
Additional Configuration
- Additional configuration, Name => Value, Names can be set in the global configuration. It can be used to add some custom values for each provider.
Connector fields
FTP connector
Name
- Name of connector
Host
- FTP server host
Port (default: 21)
- FTP server port
User Name
- FTP server username
Password
- FTP server password
Passive Mode (default: enabled)
- select if passive mode should be used. Passive is a safer mode and helps to avoid firewall issues
Source Directory
- directory on the FTP server where the file should be placed
Destination Directory
- directory, where processed by the provider file should be moved
Skip Exported File Validation (default: disabled)
- after uploading the file to the server, the script checks if the file was sent correctly and contains the correct content. If this option is unchecked, the script does not check the file after sending
Check connection
- button allows a user to check the FTP configuration, display the connection to FTP status
SFTP connector
Name
- Name of connector
Host
- SFTP server host
User Name
- SFTP server username
Password
- SFTP server password
Timeout (default: 10)
- how long the system should wait for a connection
Source Directory
- directory on the SFTP server where the file should be placed
Destination Directory
- directory, where processed by the provider file should be moved
Skip Exported File Validation (default: disabled)
- after uploading the file to the server, the script checks if the file was sent correctly and contains the correct content. If this option is unchecked, the script does not check the file after sending
Check connection
- button allows a user to check the SFTP configuration, display connection to SFTP status
SOAP connector
Name
- Name of connector
Type
- Type of soap protocol (1.1 or 1.2)
WSDL
- Path to WSDL file
Login
- SOAP connection login
Password
- SOAP connection password
Location
- SOAP connection location
Soap Action
- Action, which will be used to send data
Check connection
- button allows a user to check the SOAP configuration, display connection to SOAP status
HTTP connector
Name
- Name of connector
Url
- URL to the endpoint
Login
- Login can be set if required
Password
- Password can be set if required
Authorization Bearer
- Bearer Authorization Token
Content Type
- Json or Xml
Timeout
- how long the system should wait for a connection
Custom Headers
- Additional headers can be set here
Email connector
Name
- Name of connector
Email
- Email address, where the files will be sent
Template
- Email template
Backend
To be added
Â
Frontend
The is no frontend functionalities in this module.