Setting Up the Connector In Enterprise Windows

×

Configuration Guide

To get the Magento Connector setup and running properly you will need to perform the following actions:

  1. Create a new Integration on the Magento side
  2. Setup the Magento Connector
  3. Run Connectors immediately to push initial data up to Magento.
  4. Setup a job to automate pushing subsequent changes up to Magento and downloading orders from Magento to your local ERP.

Create a New Integration

On the Magento site, you will need to:

  1. Go to System | Extensions | Integrations
  2. Click on Add New Integration
    • Name this app something like BirdDog or BDSW
    • Your Password: This is your admin password for Magento
    • Click on API tab
      • The Resource Access dropdown list needs to be set to All
    • Click on the Arrow next to Save, then click on Save & Activate
    • Click on Allow on the "popup" to approve access
    • Copy the Access Token

Setup the Magento Connector

To configure Enterprise for Windows to use Magento, you need:

  1. Go to Maintain > Setup > Connector Accounts
  2. Click Add
  3. Enter your Magento Credentials
    • Type: Magento should be selected in this dropdown list.
    • Notify Email: Email address to receive activity reports from the connector.
    • Notify Verbosity: Use this dropdown list to setup how frequently you want to receive notifications:
      • All - receive email alerts every time the connector runs, regardless of activity
      • Activity - receive email alerts when something is uploaded to or downloaded from Amazon
      • Errors - only receive alerts when the connector encounters errors
      • None - receive no email alerts ever
    • Magento Store URL: This is the store URL that is provided to you by Magento.
    • Magento Access Token: Paste that Access Token you copied earlier.
    • Populate the rest of the data from your existing ERP. This will determine what a new customer generated in Magento and downloaded into your ERP will have as defaults.
      • Terms Code: Select the terms code for new customers from this dropdown list.
      • Customer Type: Select the customer type code for new customers from this dropdown list.
      • Sales Person: Select the sales rep for new customers from this dropdown list. Typically, this will be something like WEB.
      • Ship Via: Select the ship via for new customers from this dropdown list.
      • Tax Schedule or Tax Code: Select the appropriate code for new customers from this dropdown list. These are mutually exclusive so you can assign a tax schedule or a tax code to a new customer, but not both.
      • Location: Select the default warehouse location for new customers from this dropdown list.
    • Items To Upload: Select the appropriate options from this dropdown list. This will determine what items are uploaded from your ERP to Magento. The options are:
      • None - self-explanatory
      • All - also self-explanatory. Note that when we say All, we mean it so if you have a lot of items, be prepared for a wait when you run the Connector
      • Webcategory - selecting this unhides a Root Category field. This limits the upload of structure and items, and allows you to upload only items on the specific webcat page to Magento. If blank, all items and customers in the database will be used. You can plug in either the page's GUID or a functional Code which is set when editing the page.
      • Query - selecting this unhides a Query for Items dropdown. On it, you can select queries saved in the system (System Management | System | Queries)
    • Customers To Upload: Select the appropriate options from this dropdown list. This will determine what items are uploaded from your ERP to Magento. Note that Magento requires an email address for their customers, so you will need to ensure that one exists on your ERP's customer. Although it is legal in many ERPs, Magento does not allow multiple customers to share email addresses, so you will need to ensure that is not the case in your system. The options are:
      • None - self-explanatory
      • All - also self-explanatory. Note that when we say All, we mean it so if you have a lot of items, be prepared for a wait when you run the Connector
      • Query - selecting this unhides a Query for Customers dropdown. On it, you can select queries saved in the system (System Management | System | Queries).
        • Note that, due to the logic on the Magento side, when we upload customers using the query process, the process deletes information other than what you are pushing up, so you'll need to be careful with how you set up your query.
    • Customer No For New Customers: Select the appropriate option from this dropdown list. This will determine how the system writes from Macola. The options are:
      • Next Customer Number: Selecting this writes a new customer created in Magento down into the ERP as the next customer number according to the proper range. Note also that if this is selected, the system will also download existing customers from your ERP into Magento.
      • Guest Customer Number: Selecting this option unlocks the Guest Customer No field (which must be populated with your ERP's guest customer number) and then writes all new customers from Magento into your ERP with that guest customer number.
    • Send Item Master Data: Select the appropriate option for the item information you wish to send up to Magento from your ERP. There are only two options here: All or None, both of which are rather self-explanatory in terms of how they function.
      • As of version 9.9.3, we have added Item Details functionality here. Use this option to configure the properties of any item you want to send. If a property is checked, it will overwrite on an update; unchecked properties will only update if the item is new to Magento. The options are:
        • Item Number
        • Description
        • Price
        • Weight
        • Country of Origin
    • Send Customer / Item Price Codes: Select the appropriate option for these price codes you wish to send up to Magento from your ERP. There are only two options here: All or None, both of which are rather self-explanatory in terms of how they function.
    • Send Item / Location Data: Select the appropriate option for the item location info you wish to send up to Magento from your ERP. There are three options here: Default Warehouse (which sends info from only the warehouse that is your default in the ERP), None (which sends no data), and Summary (which sends an overview of all item / location information to Magento).
    • Send Ship Tos as customers: If this checkbox is selected, all ship tos on customers in your ERP will be pushed up to Magento as individual customers. This is designed specifically to allow you to upload ShipTos as customers to Magento without actually uploading customers. As noted previously, Magento requires an email address for their customers so to upload these Ship Tos properly, you will need to ensure each one in your ERP has a unique email assigned to it.
    • Enabled: If this checkbox is unmarked, then this connector will be ignored when you Run Connectors (either manually or via job.)
  4. Once you are satisfied with your setup, click Save and then Close.

Run the Magento Connector Manually

During initial configuration and anytime you want to force the process after that you can run the connector manually; note that is the jobs are unpaused, you will not be able to use this manual process:

  1. Enterprise for Windows > Processes > Run Connectors

Create the Job

To ensure BirdDog keeps the data flowing between your ERP and Magento automatically you will need to:

  1. Go to Maintain > Jobs
  2. Click on the Schedule New Job button
  3. Select Run Connectors in the Job dropdown list
  4. Schedule the job according to how frequently you want it to run (for example, every hour or at a certain time each day.)
  5. Save.