Skip to Content

Chroma (Beta) Upsert Records activity

Introduction

A Chroma (Beta) Upsert Records activity, using its Chroma (Beta) connection, updates existing records or creates new records in a Chroma collection and is intended to be used as a target in an operation.

Note

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

Create a Chroma (Beta) Upsert Records activity

An instance of a Chroma (Beta) Upsert Records activity is created from a Chroma (Beta) connection using its Upsert Records activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing Chroma (Beta) Upsert Records activity can be edited from these locations:

Configure a Chroma (Beta) Upsert Records activity

Follow these steps to configure a Chroma (Beta) Upsert Records activity:

Step 1: Enter a name and select a collection

In this step, provide a name for the activity and select a collection. Each user interface element of this step is described below.

  • Endpoint menu: If you have multiple endpoints of the same connector type configured, a menu at the top of the screen displays the current endpoint name. Click the menu to switch to a different endpoint. For more information, see Change the assigned endpoint in Configuration screens.

    • Edit endpoint: Appears when you hover over the current endpoint name. Click to edit the currently selected endpoint's connection configuration.

  • Name: Enter a name to identify the activity. The name must be unique for each Chroma (Beta) Upsert Records activity and must not contain forward slashes / or colons :.

  • Select a Collection: This section displays collections available in the Chroma (Beta) endpoint.

    • Selected Collection: After a collection is selected, it is listed here.

    • Search: Enter any column's value into the search box to filter the list of collections. The search is not case-sensitive. If collections are already displayed within the table, the table results are filtered in real time with each keystroke. To reload collections from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon or the word Refresh to reload collections from the Chroma (Beta) endpoint. This may be useful if collections have been added to Chroma. This action refreshes all metadata used to build the table of collections displayed in the configuration.

    • Selecting a Collection: Within the table, click anywhere on a row to select a collection. Only one collection can be selected. The information available for each collection is fetched from the Chroma (Beta) endpoint:

      • Name: The name of the collection.

      • Description: The description of the collection.

    Tip

    If the table does not populate with available collections, the Chroma (Beta) connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Optional settings: Click to expand additional optional settings:

    • Continue on error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

  • Data schema: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The Chroma (Beta) connector uses the Chroma REST API. Refer to the API documentation for information on the schema nodes and fields.

  • Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Chroma (Beta) endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring a Chroma (Beta) Upsert Records activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Chroma (Beta) Upsert Records activities can be used as a target with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.