Skip to Content

Chroma (Beta) connector for Jitterbit Integration Studio

Summary

The Chroma (Beta) connector establishes access to Chroma.

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

The Chroma (Beta) connector is accessed from the design component palette's Project endpoints and connectors tab (see Design component palette).

Note

For beta access and to provide feedback, contact the Jitterbit Product Team.

Connector overview

This connector is used to first configure a Chroma (Beta) 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 Chroma (Beta) connection and its activities are referred to as a Chroma (Beta) endpoint:

Chroma (Beta) activity types

  • Delete Records: Deletes records from a Chroma collection and is intended to be used as a target in an operation.

  • Search Records: Retrieves records from a Chroma collection and is intended to be used as a source in an operation.

  • Upsert Records: Updates existing records or creates new records in a Chroma collection 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.

Endpoints created with this connector are included in endpoint usage reporting and count toward your license.

Prerequisites and supported API versions

If using an API key to create a Chroma (Beta) connection, ensure any key intended for use with the connection has sufficient permission to access all databases necessary for your implementation. Tokens are associated with the Chroma tenant and not a specific user.

API keys are configurable in the API keys section of your Chroma instance's dashboard:

Chroma API keys section

If using user credentials (basic authentication) to create a Chroma (Beta) connection, ensure the associated user has sufficient permission to access all databases necessary for your implementation.

The Chroma (Beta) 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 Chroma (Beta) connector uses the Chroma REST API. Refer to the API documentation for information on the schema nodes and fields.

Troubleshooting

If you experience issues with the Chroma (Beta) 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 enable connector verbose logging for this connector by adding this logger configuration entry to your private agent's logback.xml file:

    <logger name="org.jitterbit.connector.chroma" level="DEBUG"/>

    For more information on connector verbose logging, see Verbose logging for connectors using Jitterbit private agents.

  5. If using private agents, you can check the agent logs for more information.