Redis v2 (Beta) Set activity

Introduction

A Redis v2 (Beta) Set activity, using its Redis v2 (Beta) connection, sets keys in Redis and is intended to be used as a target to consume data in an operation.

Create a Redis v2 (Beta) Set activity

An instance of a Redis v2 (Beta) Set activity is created from a Redis v2 (Beta) connection using its Set 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 Redis v2 (Beta) Set 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 Redis v2 (Beta) Set activity

Follow these steps to configure a Redis v2 (Beta) Set activity:

• Step 1: Enter a name and specify settings
  Provide a name for the activity and specify the set behavior, key value pairs, and optional settings.

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

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify the set behavior, key value pairs, and optional settings. Each user interface element of this step is described below.

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

• Select set behavior: Select one of Always set (SET), Set only if exists (XX), or Set only if not exists (NX). Refer to the Redis SET command documentation for additional information on the differences between these behaviors.

• Enter key value pairs: Click the add icon to add a row to the table below and enter Key, Value, and Expire (in seconds) parameters.

  Alternatively, the parameters can be provided in the request transformation. If the same key is specified both in this field and in the request transformation, the key specified in the transformation takes precedence.

  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.

  Important

  Fields in the Enter key value pairs table display the variable icon only in edit mode. For these fields' variable values to be populated at runtime, the agent version must be at least 10.75 / 11.13.

  Fields in the Enter key value pairs table do not support using variables to pass in raw JSON. If your use case does not support defining raw JSON in the fields directly, escape the JSON content before passing it in with a variable. For example, escaping {"success": "true"}; becomes {\"success\": \"true\"};.

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

  Note

  Data supplied in a transformation takes precedence over the activity configuration.

  The Redis v2 (Beta) connector uses the Redis client API. Refer to the Redis SET command documentation for more information.

  The request and response data schemas consist of these nodes and fields:

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Redis v2 (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 Redis v2 (Beta) Set 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.

Redis v2 (Beta) Set 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.