Variables
  • 2 Minutes to read
  • Dark
    Light
  • PDF

Variables

  • Dark
    Light
  • PDF

Article Summary

Overview

Variables are an option available to users on the Rivery platform. These can be employed to enhance the creation of connections, automate procedures, and transfer values between Rivers.

Rivery variables are denoted by curly brackets { }. This format can be used to save data as a variable or to write/reference a variable throughout the Rivery platform.

Please Note:
  • Variables have the capacity to accommodate as many as 20,000 characters.
  • Variable names can only contain letters, digits, or underscores; other characters are not permitted.

Variable Fundamentals

There are 2 types of Variables:

  • River Variables
  • Environment Variables

River Variables

River Variables are only used within a specific River. It is possible to define multiple variables.
This is applicable in both Logic and Action Rivers.

To use River variables in a River, follow the steps below:

  1. Create a new Logic or Action River.

  2. Click the Variables tab in the upper right corner.

    image.png

  3. To add a new River variable, click the '+Add Variable' button.

    image.png

  4. To create an Array, use square brackets to save it as the variable's value, then check the 'Contains Multiple Values' box.

  5. Click Apply Changes.

    image.png

Please Note:
If the item 'Clear Value On Start' is checked, the value of the variable will always be updated to the original value when a new River is formed, regardless of what happens to it during a River.


Encrypted Variables

Users can encrypt sensitive values stored in River variables for use in Python steps.

When you select the "Encrypt" option, the variable's value is encrypted and hidden. Encrypted variables cannot be decrypted, and new values cannot be saved into encrypted variables using in-line Python code.
To create the same variable with the same name, you must delete the previously encrypted variable and create a new one.

Before selecting Apply Changes, click the unhide icon to ensure the value you entered was is correct. You will be unable to view the Encrypted variables value once you click Apply Changes.

image.png

Please Note:

  • Encrypted Variables can only be used within a Logic River and is only supported in Python logic steps.
  • To create an Array, use square brackets to save it as the variable's value, then check the 'Contains Multiple Values' box.
  • The item 'Clear Value On Start' is not supported in Encrypted variables.

Environment Variables

Environment variables can be used throughout the entire platform. These can be configured by clicking on the 'Variables' tab on the Rivery main menu.

Please Note:
Environment variable names can only contain letters, digits, or underscores and must start with a letter; other characters are not permitted.

Environment variables can be used in Rivers, but only when they are defined as River variables. Values for Environment variables can be modified in the 'Variables' tab of the main menu, not anywhere along the River.

To use Environment Variables in a River, follow the steps below:

  1. Click on 'Variables' tab in the main menu.

    image.png

  2. in the upper right corner, click + Add Variable.

    image.png

  3. Add a value to the variable.

    image.png

Please Note:
To create an Array, use square brackets to save it as the variable's value.

4. After creating an Environment variable, go to your River and select the 'Variables' tab in the upper right corner.

image.png

5. Set up a new River variable and put the name of the Environment variable inside curly brackets to use it's value (Test_River_Variable's value will now be 10).

  1. Click Apply Changes.

    image.png

Techniques for Using Variables


Was this article helpful?

What's Next