Skip to Content

YAMI Connector

Summary

The Harmony YAMI Connector establishes access to YAMI.

The YAMI connector provides an interface for creating a YAMI connection, the foundation used for generating instances of YAMI activities. These activities, once configured, interact with YAMI through the connection.

The YAMI connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Connector Overview

This connector is used to first configure a YAMI connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific YAMI connection and its activities are referred to as a YAMI endpoint:

YAMI activity types

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

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

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

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

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The YAMI connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The YAMI connector uses the YAMI API. Refer to the API documentation for information on the schema nodes and fields.

Troubleshooting

If you experience issues with the YAMI connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can check the agent logs for more information.