(Stonebranch) Environment Variables
Overview
Variables and functions are used in Stonebranch to add dynamic values to tasks, triggers, and workflows. When a variable or function is specified in a task, trigger, or workflow field, the Stonebranch Controller inserts a value into this field at runtime.
Details
Getting Started - Guidelines
Variable Naming Conventions
- Variable names must begin with your assigned Designator (four-letter Department Code, plus two-digit code), followed by an underscore, the string "VAR", and another underscore. Example: "DEPT01_VAR_"
- Variable names can contain letters and numbers. Underscore ( _ ) is the only available character available as a separator. Do not use the hyphen ( - ) as a separator as it might cause some undesired results.
- Spaces are not permitted.
- Variable names are not case-sensitive.
- Do not use variables beginning with the name ops_; these are built-in names reserved by Stonebranch.
Example
Variable name: DEPT01_VAR_current_semester_CCYYS
Stonebranch Reserved Variables
Built-in variables are maintained by Universal Controller and provide information about task instances, agents, Universal Message Service (OMS), and cluster nodes. The built-in variables can be used in free text fields in triggers, tasks, task actions, and email notifications for agents, OMS servers, and cluster nodes.
To view the list and description of available built-in variables, click Universal Controller's list of built-in variables.
Format for Using Variables
To use a variable in a text field, always precede the variable with the dollar sign ( $ ) and always enclose the variable inside curly braces { }. The variable formatting will look like this: ${DEPT_01_VAR_current_semester_CCYYS}
Advanced Variable Features - Functions
Stonebranch offers advanced variable features that are intended for experienced users and developers. This topic is covered in greater detail in this guide provided by Stonebranch. The guide covers the following topics:
- Conditional functions
- Credential functions
- Date functions
- Mathematical functions
- Output functions
- SQL/Stored Procedure functions
- String functions
- System functions
- Universal task functions
- Web service functions
Troubleshooting
Problem | Cause | Solution |
Variable name is shown instead of the variable value. | Variable was formatted incorrectly. | Variables should follow the format ${DEPT_01_Var_*}. |
Output from the variable is incorrect. | Incorrect variable name was used or the variable was misspelled. | Verify that the variable name typed in free text field matches the name of the defined variable. |
Error while saving a variable:
|
Variable name begins with ops_ |
|
You don't receive emails after configuring an email action on a task or workflow. | A variable name was used in the To: field on the email notification action. |
|
Environment-specific variables mysteriously change values and break tasks or workflows. | The variable was unintentionally promoted. |
|
Global variables are not available. | Correct permissions are lacking. |
|