Variables in BDI [Rivery]
What is a Data Integration ?
Data Integration is a cloud-based data integration and orchestration platform that enables organizations to collect, transform, and manage their data in a single environment. It is an end-to-end solution that supports the entire data development lifecycle, offering a unified and easy-to-use interface for modern data teams. With this platform, users can seamlessly build, orchestrate, and manage all their data pipelines, workflows, and transformations from one centralized location.
What is a Variables in Rivery ?
Variables in Rivery allow dynamic configuration of pipelines. Instead of hardcoding values such as schema names, file names, or API endpoints, variables enable reusable and environment-specific configurations.
Types Covered in This Document:
- Environment Variables
- River Variables
Environment Variables
Environment Variables are defined at the environment level (Dev, Test, Prod). They allow the same River to run across multiple environments without modification.
Example:
DEV_SCHEMA = sales_dev
PROD_SCHEMA = sales_prod
River Variables
River Variables are defined inside a specific River. They are used to dynamically control file names, table names, filters, and execution logic within the Rivers.
Example:
file_date = {{execution_date}}
target_table = sales_{{execution_date}}
Usecase:
How to Utilize Environment Variables and River Variables More Efficiently in Rivery
Environment Variables
Environment Variables are defined at the environment level (Dev / QA / Prod) and can be reused across multiple Rivers.
Step 1: Login into the console.rivery.io https://console.rivery.io/
Step 2: Click Variables Section to configure the Environment Variables
Step 3: Click on Add Variable add the New Variables
Step 4: Provide:
- Variable Name
- Variable Value
Then click Add Variable.
Step 5: Confirm the variable is created under the correct environment (e.g., Development). Repeat the same configuration in other environments (QA / Prod) if required.
Step 6: Click on Create River and Select Source to Target River
Step 6 : Select the source as Salesforce.
Step 7: Provide:
- Username
- Password
- API Token
Click Test Connection and confirm it is successful.
Step 8: Select River Mode
- River Mode: Multiple Tables
- Extraction Type: Bulk API
Step 9: Select Send by Email as the target.
Step 10: In the Send To field, reference the variable using
Copy the variable name which we have defined and the paste it in the send to place
Step 11: Select the Schema and choose for the Account Object and select the Object
Step 12: Provide proper naming conventions.
Click Save → Click Run.
Step 13: Verify that the configured email address receives the email successfully.
River Variables
River Variables are defined within a specific River and are not shared globally.
Step 14: Repeat Steps 6–10.
Step 15: Inside the River:
- Click Variables
- Add a new variable
- Provide:
- Variable Name
- Value
- Click Apply Changes
Step 16: River Variables are defined within a specific River and are not shared globally.
Step 17 : Confirm the email is received successfully.
Environment Variable and River Variable
| Environment Variable | River Variable |
|---|---|
| Defined at environment level | Defined inside a specific River |
| Reusable across multiple Rivers | Used only within that River |
| Must be configured per environment | Exists only in that River |
Important Pointers While Working with Variables
- Variables support up to 20,000 characters
- Multi-value variables support up to 10,000 values
- Variable names can contain:
- Letters
- Digits
- Underscores
- Special characters are not allowed in variable names
- Values exceeding limits will be truncated
- To create an array, use square brackets:
Reserved Variable Names (Cannot Be Used)
- run_id
- env_id
- account_id