Skip to end of metadata
Go to start of metadata

Introduction

A Magento Get activity finds an object at Magento and is intended to be used as a source to provide data to an operation. After configuring a Magento connection, you can configure as many Magento activities as you like for each Magento connection.

Creating a Magento Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Use the Show dropdown to filter on Endpoints, and then click the Magento connection block to display activities that are available to be used with a Magento connection:

Magento activities

To create an activity that can be configured, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After a Magento activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: Opens the activity configuration screen for you to configure the activity. For details, see Configuring a Magento Get Activity later on this page.

  • Delete: Permanently deletes the activity. A message asks you to confirm that you want to delete the activity.

  • Rename: Positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: Changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Removes the activity as a step in the operation without deleting it from the project. (This is available only from the actions menu on the design canvas.) When you remove an activity that is adjacent to a transformation and schemas are provided within that activity, the schemas are no longer referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: Deploys the activity and any components it is dependent on.

  • Configurable Deploy: Opens the deployment screen, where you can select project components to deploy.

  • Add to Group: Opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: Creates a copy of the activity as a new, unreferenced component. On creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring a Magento Get Activity

Follow these steps to configure a Magento Get activity:

  • Step 1: Select a Service
  • Step 2: Select an Operation
  • Step 3: Review Data Schema

Step 1: Select a Service

Magento Get Activity Configuration Step 1

  • Name: Enter a name to use to identify the Magento Get 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. When reopening an existing activity configuration, only the selected service is displayed instead of reloading the entire service list.

    • Selected Magento Service: After a service is selected, it will be listed here.

    • Search: Enter any part of the service name 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 will be 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 Refresh icon or the word Refresh to reload services from the Magento endpoint. This may be useful if you have recently added services 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 service name from Magento.

      • Object Description: The service object description from Magento.

    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 continue to the next step and temporarily store the configuration. 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

Magento Get Activity Configuration Step 2

  • Select an Operation: This section displays operations available in the Magento endpoint. When reopening an existing activity configuration, only the selected operation is displayed instead of reloading the entire operation list.

    • Selected Magento Service: The service selected in the previous step will be listed here.

    • Selected Magento Operation: After an operation is selected, it will be listed here.

    • Search: Enter any part of the operation name 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 will be 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 Refresh icon or the word Refresh to reload operations from the Magento endpoint. This may be useful if you have recently added operations 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 operation name from Magento.

      • Description: The operation description from Magento.

    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 return to the previous step and temporarily store the configuration.

  • Next: Click to continue to the next step and temporarily store the configuration. 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 Data Schema

Magento Get Activity Configuration Step 3

  • Data Schema: The request and response data schemas for Magento will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    For information on the schema fields, refer to the API documentation for the version of Magento 2 that you are using. The Magento connector uses the Magento 2 REST API that matches the server version.

  • Back: Click to return to the previous step and temporarily store the configuration.

  • 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 an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

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

Other patterns are not valid using Magento Get activities. See the validation patterns on the Operation Validity page.

A typical use case is to use a Magento Get activity in the Two-Transformation Pattern.

In this example, the first transformation (Magento Get Request) creates a request structure that is passed to the Magento Get activity. The second transformation (Magento Get Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Magento Get Response) and a message is then logged by the Write to Operation Log script:

Magento Get operation

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.

On This Page

Last updated:  Mar 06, 2020

  • No labels