Magento Get activity

Introduction

A Magento Get activity, using its Magento connection, retrieves an item from Magento and is intended to be used as a source to provide data in an operation.

Create a Magento Get activity

An instance of a Magento Get activity is created from a Magento connection using its Get activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing Magento Get activity can be edited from these locations:

The design canvas (see Component actions menu in Design canvas).
The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a Magento Get activity

Follow these steps to configure a Magento Get activity:

Step 1: Enter a name and select a service
Provide a name for the activity and select a service.
Step 2: Select an operation
Select an operation.
Step 3: Review the data schemas
Any request or response schemas generated from the endpoint are displayed.

Step 1: Enter a name and select a service

In this step, provide a name for the activity and select a service. Each user interface element of this step is described below.

Magento Get activity configuration step 1

Name: Enter a name to identify the activity. The name must be unique for each Magento Get activity and must not contain forward slashes / or colons :.
Select a Service: This section displays services available in the Magento endpoint.
- Selected Magento Service: After a service is selected, it is listed here.
- Search: Enter any column's value into the search box to filter the list of services. The search is not case-sensitive. If services are already displayed within the table, the table results are filtered in real time with each keystroke. To reload services from the endpoint when searching, enter search criteria and then refresh, as described below.
- Refresh: Click the refresh icon or the word Refresh to reload services from the Magento endpoint. This may be useful if services have been added to Magento. This action refreshes all metadata used to build the table of services displayed in the configuration.
- Selecting a Service: Within the table, click anywhere on a row to select a service. Only one service can be selected. The information available for each service is fetched from the Magento endpoint:
  - Name: The name of the service.
  - Object Description: The description of the service.
Tip

If the table does not populate with available services, the Magento connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select an operation

In this step, select an operation. Each user interface element of this step is described below.

Magento Get activity configuration step 2

Select an Operation: This section displays operations available in the Magento endpoint.
- Selected Magento Service: The service selected in the previous step is listed here.
- Selected Magento Operation: After an operation is selected, it is listed here.
- Search: Enter any column's value into the search box to filter the list of operations. The search is not case-sensitive. If operations are already displayed within the table, the table results are filtered in real time with each keystroke. To reload operations from the endpoint when searching, enter search criteria and then refresh, as described below.
- Refresh: Click the refresh icon or the word Refresh to reload operations from the Magento endpoint. This may be useful if operations have been added to Magento. This action refreshes all metadata used to build the table of operations displayed in the configuration.
- Selecting an Operation: Within the table, click anywhere on a row to select an operation. Only one operation can be selected. The information available for each operation is fetched from the Magento endpoint:
  - Name: The name of the operation.
  - Object Path: The API operation being used from the Magento 2 REST API.
  - Description: The description of the operation.
Tip

If the table does not populate with available operations, the Magento connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Review the data schemas

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

Magento Get activity configuration step 3

Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

The Magento connector uses the Magento 2 REST API. Refer to the API documentation for the version of Magento 2 that you are using for information on the schema nodes and fields.
Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Magento endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.
Edit: Click the edit icon above each data schema to enter the editor for that data schema. The editor allows you to add, delete, and reorganize nodes and fields and change their data types. All newly added nodes and fields are set to [0, 1] cardinality. Changes made to the data schemas must be acceptable to the endpoint and should be made only after consulting any available documentation for the endpoint.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Finished: Click to save the configuration for all steps and close the activity configuration.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring a Magento Get activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Magento Get activities can be used as a source with these operation patterns:

Transformation pattern
Two-target archive pattern (as the first source only)
Two-target HTTP archive pattern (as the first source only)
Two-transformation pattern (as the first or second source)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.