Chroma (Beta) Delete Records activity

Introduction

A Chroma (Beta) Delete Records activity, using its Chroma (Beta) connection, deletes records from a Chroma collection and is intended to be used as a target in an operation.

Create a Chroma (Beta) Delete Records activity

An instance of a Chroma (Beta) Delete Records activity is created from a Chroma (Beta) connection using its Delete 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) Delete Records activity can be edited from these locations:

• The design canvas (see Component actions menu in Design canvas).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a Chroma (Beta) Delete Records activity

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

• Step 1: Enter a name and select a collection
  Provide a name for the activity and select a collection.

• Step 2: Specify settings
  Specify the filter criteria for record deletion.

• Step 3: Review the data schemas
  Any request or response schemas are displayed.

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) Delete 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.

• 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: Specify settings

In this step, specify the filter criteria for record deletion. 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.

• Delete-by: Select the method to filter records for deletion, one of Hybrid, ID (default), Meta, or Text.

  • Hybrid: Select to use a combination of ID, Meta, and Text filter options. The options revealed by Delete by ID, Delete by meta filter, and Delete by text filter are described in their respective areas below.

  • ID: Select to specify record IDs for deletion.

    • IDs: Define IDs for deletion in the table.

      Click the add icon to add a row to the table and enter an ID value.

      To save the row, click the submit icon in the rightmost column.

      To edit or delete a single row, hover over the rightmost column and use the edit icon or delete icon .

      To delete all rows, click Clear All.

  • Meta: Select to specify a metadata filter for record deletion.

    • Metadata key name: Enter the metadata key name for the filter.

    • Metadata operator: Select one of Contains (default), Equals, Not_Contains, Not_Equals, or Regex to specify the operator to use between the metadata key and value for filtering. For example, filter for a key (Metadata key name) that Contains a specific value (Metadata value).

    • Metadata value: Enter the metadata value for the filter.

    • Meta value-type: Select one of Boolean, Int, or String (default) to specify the type of value for Metadata value.

  • Text: Select to specify a text filter for record deletion.

    • Text operator: Select one of Contains (default), Not_Contains, or Regex to specify the operator to use for text filtering.

    • Text value: Enter the text value for the filter.

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

• 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 3: 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) Delete 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) Delete Records activities can be used as a target with these operation patterns:

• Transformation pattern
• Two-transformation pattern (as the first or second target)

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.