There are a number of system-defined variables available to automation scripts and tasks. HelloID Administrators also have the ability to create user-defined variables when the need arises.
Navigate to Automation > Variable Library to display all currently-defined variables in your HelloID environment.
The variables overview is separated into two sections. The first section contains system-defined variables whose values are pulled from the information saved in Settings > Company and Settings > Appearance. The second section contains user-defined variables that you may modify to suit your organization's needs. Learn more about managing user-defined variables here.
Once a variable has been defined…
…it is accessible from within scripts and tasks using double curly brace syntax.
Use Variables in a Task
Not all task configurations have fields that will accept variables; some simply utilize drop-down selectors and toggle switches outside of the Name fields. Those tasks that accept variables, however, will have form fields in the Tasks tab of their configuration screen where all variables defined within Variable Library are usable.
Whether entering the variable as a single entry or as a part of a more complex script or statement, use the curly brace syntax to call the desired variable(s).
For more information on creating and managing tasks, please refer to Tasks - Overview.
Use Variables in an Event
Events are comprised of tasks, some of which accept the variables defined within Variable Library. The configuration and use of these tasks and their usage of variables is the same as in Automation > Tasks. Use the curly brace syntax to call the desired variable(s).
For more information on creating and managing events, please refer to Events - Overview.
Use Variables in a PowerShell Script
Whether making a new template or writing a stand-alone script within a new task or action, the PowerShell script configuration provides a Variables tab. Under the Variables tab you can create local variables that will be usable within the script being configured.
All of the global variables and user-defined variables that are defined inside of the variable library are automatically usable within the body of the PowerShell script with the syntax of $variable_name. For example, if you wanted to use your companyName variable in your script, it would be referenced as $companyName.
For more details about creating and managing scripts, please refer to PowerShell Scripts - Overview.