.png){kind=logo}
Variables
- 07 Nov 2024
- 3 Minutes to read
- Print
- DarkLight
- PDF
Variables
- Updated on 07 Nov 2024
- 3 Minutes to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Variables give you the tools to be as dynamic as possible, and can be used within actions and filters.
Variables can currently be defined on 3 different levels;
- Variables (Zone)
- Contexts
- Packages (Snapshots)
The inheritance flows top-down and variables can be overwritten. This means a variable defined at the zone level can be overwritten in contexts and/or packages. This allows you to change the value of variables based on the context(s) of a user or device.
The syntax of a variable is ${<VARIABLE NAME>}
System Variables
The following system variables are predefined in Liquit Workspace and are detected by the Agent.
Some of them are only available starting a specific version of the Agent and it is specified where applicable.
Note that the paths used as examples in the table below, might not match your Liquit System.
| Variable | Output (Example) |
|---|---|
| ${AllUsersProfile} | C:\ProgramData |
| ${AppData} | C:\Users\< Username >\AppData\Roaming |
| ${CmdLine} | Command-line parameters that can be passed from the Workspace API or shellapi when launching a package. |
| ${CommonDesktop} | C:\Users\Public\Desktop |
| ${CommonProgramFiles} | C:\Program Files\Common Files |
| ${CommonProgramFiles32} | On 32-bit systems this path is set to C:\Program Files\Common Files On 64-bit systems this path is set to C:\Program Files (x86)\Common Files |
| ${CommonProgramFiles64} | C:\Program Files\Common Files This variable is only available on 64-bit systems |
| ${CommonPrograms} | C:\ProgramData\Microsoft\Windows\Start Menu\Programs |
| ${CommonStartMenu} | C:\ProgramData\Microsoft\Windows\Start Menu |
| ${CommonStartup} | C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup |
| ${ComputerName} | Computer name of local device, same as %COMPUTERNAME% For example: DESKTOP-123456 |
| ${Desktop} | C:\Users\< Username >\Desktop |
| ${Device.Address} | Primary IP of device as reported by the agent. For example: 10.1.1.1 |
| ${Device.FQDN} | Fully qualified domain name of device. For example: DESKTOP-123456.liquit.com |
| ${Device.Name} | Active computer name of device. For example: DESKTOP-123456 |
| ${Documents} | C:\Users\< Username >\Documents |
| ${Favorites} | C:\Users\< Username >\Favorites |
| ${FontsDir} | C:\Windows\Fonts This variable is only available with 3.1 or later |
| ${LiquitAgentDataDir} | C:\ProgramData\Liquit\Agent |
| ${LiquitAgentDir} | C:\Program Files\Liquit Universal Agent |
| ${LocalAppData} | C:\Users\< Username >\AppData\Local |
| ${PackageCollection} | The name of the shortcut being executed. |
| ${PackageExecuteStage} | The stage of the calling package which can be different from ${PackageStage} if the depend package was executed in a different stage then the current package supports. |
| ${PackageID} | Contains the ID of the current package. |
| ${PackageSnapshotName} | The name of the current package snapshot being executed. |
| ${PackageStage} | The stage of the current package snapshot being executed. |
| ${PackageTempDir} |
|
| ${PackageVersion} | Contains the snapshot ID of the current package. |
| ${Platform.SessionID} | Windows Session ID For example: 2 |
| ${Platform.UserID} | Windows User SID For example: 4B296B08-6BB6-4084-A8F9-B1B1DE303E4A This variable is only available with 3.7 or later |
| ${Platform.UserName} | The Windows User Name used to log on to the local device. For example Administrator |
| ${ProgramData} | C:\ProgramData |
| ${ProgramFiles} | C:\Program Files |
| ${ProgramFiles32} | On 32-bit systems this path is set to C:\Program Files On 64-bit systems this path is set to C:\Program Files (x86) |
| ${ProgramFiles64} | C:\Program Files This variable is only available on 64-bit systems |
| ${Programs} | C:\Users\< Username >AppData\Roaming\Microsoft\Windows\Start Menu\Programs |
| ${Public} | C:\Users\Public |
| ${SendTo} | C:\Users\< Username >\AppData\Roaming\Microsoft\Windows\SendTo |
| ${StartMenu} | C:\Users\< Username >\AppData\Roaming\Microsoft\Windows\Start Menu |
| ${Startup} | C:\Users\< Username >\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup |
| ${SystemDrive} | C: |
| ${SystemRoot} | C:\Windows |
| ${TaskBar} | C:\Users\< Username >\AppData\Roaming\Microsoft\Internet Explorer\Quick Launch\User Pinned |
| ${TEMP} | C:\Users\< Username >\AppData\Local\Temp |
| ${UserDomain} | The Windows Domain used to log into the local device. For example LIQUIT |
| ${UserName} | The Windows User Name used to log into the local device. For example Administrator |
| ${UserProfile} | C:\Users\< Username > |
| ${WinDir} | C:\Windows |
| $(WindowsApps) | C:\Program Files\WindowsApps |
| ${WinSysDir} | C:\Windows\System32 |
| ${WinSysDir32} | On 32-bit systems this path is set to C:\Windows\System32 On 64-bit systems this path is set to C:\Windows\SysWOW64 |
| ${WinSysDir64} | C:\Windows\System32 This variable is only available on 64-bit systems |
Identity Variables
The following identity variables are predefined in Liquit Workspace, are detected by the Agent and Liquit Workspace Server and contain information of the logged in user account.
Some of them are only available starting a specific version of the Agent and it is specified where applicable.
| Variable | Output (Example) |
|---|---|
| ${Identity.ID} | Unique user ID of the currently logged in account. |
| ${Identity.UserName} | Username of the currently logged in account. |
| ${Identity.DisplayName} | Display Name of the currently logged in account. |
| ${Identity.Mail} | Mail address of the currently logged in account. |
| ${Identity.Source} | Identity Source name of the currently logged in account. |
| ${Identity.UserPrincipalName} | User Principal Name of the currently logged in account. |
Was this article helpful?