Chroma (Beta) connection

Introduction

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

A new Chroma (Beta) connection is created using the Chroma (Beta) connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Endpoints page (see Create a global endpoint in Global Endpoints).

An existing Chroma (Beta) connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design Component Palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Endpoints page (see Edit a global endpoint in Global Endpoints).

Configure a Chroma (Beta) connection

Each user interface element of the Chroma (Beta) connection configuration screen is described below.

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

• Instance type: Select the type of Chroma instance, either Cloud (default) or On-Premise.

  • Cloud: Select to connect to a Chroma cloud instance.

    • Auth type: Chroma cloud instances support the X-Chroma-Token header scheme only. It is selected by default.

    • API token: Enter the Chroma API key for authentication using the X-Chroma-Token header scheme.

  • On-Premise: Select to connect to an on-premises Chroma instance.

    • Host: Enter the hostname of the Chroma instance.

    • Port: Enter the port of the Chroma instance.

    • Authentication type: Select the type of authentication to use, one of API Key, Basic Auth, or No Auth (default).

      • API Key: Select to authenticate with a Chroma tenant API key.

        • Token type: Select the header scheme to use for API token authentication, either Authorization (default) or X-Chroma-Token.

        • API token: Enter the Chroma API key for authentication using the header scheme selected for Token type.

      • Basic Auth: Select to authenticate with a Chroma user's username and password combination.

        • Username: Enter the Chroma user username.

        • Password: Enter the Chroma user password.

      • No Auth: Select if the Chroma instance does not require authentication.

• Database name: Enter the name of the database. Specific collections from the database are chosen during activity configuration.

• Optional settings: Click to expand additional optional settings:

  • 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 specified 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 Chroma (Beta) 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:

• 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.