Mirakl Connection¶

Introduction¶

A Mirakl connection, created using the Mirakl connector, establishes access to Mirakl. Once a connection is configured, you can create instances of Mirakl 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).

Create or Edit a Mirakl Connection¶

A new Mirakl connection is created using the Mirakl connector from one of these locations:

• The design component palette's Connections tab (see Design Component Palette).
• The Global Connections page (see Create a Global Connection in Global Connections).

An existing Mirakl connection can be edited from these locations:

• The design component palette's Connections 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 Connection in Global Connections).

Configure a Mirakl Connection¶

Each user interface element of the Mirakl connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each Mirakl connection and must not contain forward slashes / or colons :. This name is also used to identify the Mirakl endpoint, which refers to both a specific connection and its activities.

• Token: Enter the authentication token provided by Mirakl.

• Instance name: Enter the customer name that is used in your Mirakl instance's custom URL in the format of https://marketplace.{environment}.{customerName}.com.br.

• Environment: Select the environment that corresponds with that used in your Mirakl instance's custom URL:

  • Production: Production corresponds with a Mirakl production environment.
  • Sandbox: Sandbox corresponds with a Mirakl preprod environment.

• Optional Settings: Click to expand additional optional settings:

  • Instance URL: Enter your Mirakl instance's custom URL.

• 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 Mirakl 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:

• Read: Retrieves object data from Mirakl and is intended to be used as a source in an operation.

• Create: Creates object data in Mirakl and is intended to be used as a target in an operation.

• Update: Updates object data in Mirakl and is intended to be used as a target in an operation.

• Delete: Deletes object data from Mirakl and is intended to be used as a target in an operation.