Magento connection¶
Introduction¶
A Magento connection, created using the Magento connector, establishes access to Magento. Once a connection is configured, you can create instances of Magento activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Note
This connector supports the Enable Re-authentication on Change organization policy. If enabled, a change to the Magento Host or Magento Username in this connection requires users to re-enter the Magento Password for the connection.
Create or edit a Magento connection¶
A new Magento connection is created using the Magento connector from one of these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The Global Connections page (see Create a global endpoint in Global Connections).
An existing Magento connection can be edited from these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
- The Global Connections page (see Edit a global endpoint in Global Connections).
Configure a Magento connection¶
Each user interface element of the Magento connection configuration screen is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Connection Name: Enter a name to use to identify the connection. The name must be unique for each Magento connection and must not contain forward slashes
/
or colons:
. This name is also used to identify the Magento endpoint, which refers to both a specific connection and its activities. -
Magento Host: Enter the Magento host.
-
Magento Username: Enter the Magento username.
-
Magento Password: Enter the Magento password.
-
Scope: Enter the scope. The default value is All.
-
User Type: Select the user type of the Magento user, either Admin or Customer. Note that the available APIs depend on the user and subsequent user type specified.
-
Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.
-
Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
-
Save Changes: Click to save and close the connection configuration.
-
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
-
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.
Next steps¶
After a Magento connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.
These activity types are available:
-
Search: Searches for items and retrieves them from Magento and is intended to be used as a source in an operation.
-
Put Bulk: Puts items in bulk into Magento and is intended to be used as a target in an operation.
-
Post: Posts an item into Magento and is intended to be used as a target in an operation.
-
Post Bulk: Posts items in bulk into Magento and is intended to be used as a target in an operation.
-
Get: Retrieves an item from Magento and is intended to be used as a source in an operation.
-
Delete Bulk: Deletes items in bulk from Magento and is intended to be used as a target in an operation.
-
Get Bulk Status: Retrieves the status of a bulk operation from Magento and is intended to be used as a source in an operation.
-
Delete: Deletes an item from Magento and is intended to be used as a target in an operation.
-
Put: Puts an item into Magento and is intended to be used as a target in an operation.