Magento Connector Configuration

Version 21.0.8222

Magento Connector Configuration

The Magento connector allows you to integrate Magento into your data flow by pushing or pulling data from Magento. Follow the steps below to connect ArcESB to Magento.

Establish a Connection

To allow ArcESB to use data from Magento, you must first establish a connection using login credentials. You can create the connection from either the connector configuration pane or the Connections tab of the Settings page.


  • The login process is only required the first time the connection is created.
  • Connections to Magento can be re-used across multiple Magento connectors.

From the Connector Configuration Pane

  1. Drag the Magento connector into an ArcESB flow and give it a name.

  2. In the Connector Configuration pane, click + Create next to the Connection drop-down list.

  3. The Add Connection modal appears. Provide the requested information:

    • Name — The static name of the connection. Set this as desired.
    • Type — This is always set to Magento.
    • Auth Scheme — The authorization scheme (basic or token) to use for the connection.
    • URL — The Magento URL to connect to.
    • User — (Basic auth scheme only) The Magento username to use for logging in.
    • Password — (Basic auth scheme only) The password for the user entered above.
    • Access Token — (Token auth scheme only) The access token for establishing the connection.
  4. If needed, click Advanced to open the drop-down menu of advanced connection settings. These should not be needed in most cases.

  5. Click Test Connection to ensure that ArcESB can connect to Magento with the provided information. If an error occurs, check all fields and try again.

  6. Click Add Connection to finalize the connection.

  7. In the Connection drop-down list of the connector configuration pane, select the newly-created connection.

  8. Click Save Changes.

From the Settings Page

  1. Open the Settings page, and then click the Connections tab.

  2. Click Add to open the Connection Type modal.

  3. Click Magento, then click Next.

  4. Continue from step 3 above for Connection Configuration Pane.

Select an Action

After establishing a connection to Magento, you must choose the action that the Magento connector will perform. The table below outlines each action and where it belongs in an ArcESB flow.

Action Description Position in Flow
Upsert Inserts or updates Magento data. By default, if a record already exists in Magento, an update is performed on the existing data in Magento using the values provided from the input. End
Lookup Retrieves a value from Magento and inserts that value into an already-existing Arc message in the flow.
The Lookup Query determines what value the connector will retrieve from Magento. It should be formatted as a SQL query against the Magento tables.
Select Retrieves data from Magento and brings it into ArcESB.
You can use the Filter panel to add filters to the Select. These filters function similarly to WHERE clauses in SQL.
Execute Stored Procedures Treats data coming into the connector as input for a stored procedure, and then passes the result down the flow.
You can click the Show Sample Data button to provide sample inputs to the selected Stored Procedure and preview the results.