Skip to main content
Feedback

Managing variables in action rivers

You can manage variables in REST Actions and Multi Action within Data Integration. Variables serve as the interface between Actions and other components within the platform.

Action variables types

  • Action Variables: These are manually added into the Action River and can be used as API URL parameters and as Header values.
    • Interval Params: These are related to the selected Time Period of the Action River, prefixed with "time_range."
  • Action Output Variables: These are used when a variable needs to be output and employed beyond the scope of the Action River. They apply in Logic, Multiaction, and Rest-API Source to Target Rivers.

Accessing variables

To access the variables, click Variables on the right side of the River interface.

Adding variables to an action

Procedure

  1. Navigate to the Data Integration console.
  2. Click the River tab from the left-hand menu.
  3. Create "Action River" or choose a river from the list.
  4. Click Add Variable.
  5. Enter the name and value of the variable.
  6. Select is_private if you want the variable to remain restricted to the Action River, making it inaccessible in Source to Target Rivers or Logic Rivers.
  7. Opt for Add to Results to generate a new column displaying each instance of this variable's values in the results table.

Output variables

Procedure

  1. Navigate to the Results menu.
  2. Click the Variables tab
  3. Create a variable in the Output Variable Field.
  4. Set the variable's value to reflect the outcome of your request.
  5. Use this variable in Logic, Multi Action, and REST-API Source to Target Rivers.
note

Selecting the Hide Output Value option hides the variable's value in the logs, making it inaccessible in Logic Rivers.

Scopes of variables

  • Variables in a REST Action are accessible throughout the Action's configuration.
  • Multi Action has a distinct variable scope. Variables within an Action called within a Multi Action are separate and do not share the Multi Action's scope.
  • To pass variables from a Multi Action to an Action within it, use the input variables of the internal action.

Using variables in actions

REST actions

Enter variables into any input fields using curly braces . A list of variables appears for selection.

image.png

Multi action

A Multi-Action consists of multiple REST Actions. Variables are used in the input fields of actions within the Multi-Action. Additional output variables are specific to the Multi-Action, capturing data returned from internal actions.

note
  • Environment variables are not automatically displayed within Action Rivers. You can include them in the request body using curly brackets. The request body is accessible in all requests except GET.
  • When a "Time Period" is selected, additional time components (time_range.start_date.day) become available in the variables list.
On this Page