Skip to Content

BMC Helix for CSP Connector

Summary

The BMC Helix for CSP connector establishes access to BMC Helix for CSP (Communication Service Provider) version 21.3.0 or later.

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

The BMC Helix for CSP connector is accessed from the design component palette's Project endpoints and connectors tab (see Design Component Palette).

Connector Overview

This connector is used to first configure a BMC Helix for CSP 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 BMC Helix for CSP connection and its activities are referred to as a BMC Helix for CSP endpoint:

BMC Helix for CSP activity types

  • Get: Retrieves all entity data (for a selected entity) from BMC Helix for CSP and is intended to be used as a source in an operation.

  • Query: Queries specified entity data (for a selected entity) in BMC Helix for CSP and is intended to be used as a source in an operation.

  • Create: Inserts entity data in BMC Helix for CSP and is intended to be used as a target in an operation.

  • Update: Updates entity data in BMC Helix for CSP 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 BMC Helix for CSP 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 BMC Helix for CSP connector uses the BMC Helix for CSP REST API. Refer to the API documentation for information on the schema nodes and fields.

Troubleshooting

If you experience issues with the BMC Helix for CSP 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.