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 Application 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 Application Workspace System.
| Variable | Operating system | Output (Example) |
|---|---|---|
| ${AllUsersProfile} | only Windows | C:\ProgramData |
| ${AppData} | macOS and Windows | Windows: C:\Users\< Username >\AppData\Roaming macOS: /Users/< Username >/Library/Application Support |
| $(Biospasswd) | only macOS | |
| ${CmdLine} | only Windows | Command-line parameters that can be passed from the Application Workspace API or shellapi when launching a package. |
| ${CommonDesktop} | only Windows | C:\Users\Public\Desktop |
| ${CommonProgramFiles} | only Windows | C:\Program Files\Common Files |
| ${CommonProgramFiles32} | only Windows | 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} | only Windows | C:\Program Files\Common Files This variable is only available on 64-bit systems |
| ${CommonPrograms} | only Windows | C:\ProgramData\Microsoft\Windows\Start Menu\Programs |
| ${CommonStartMenu} | only Windows | C:\ProgramData\Microsoft\Windows\Start Menu |
| ${CommonStartup} | only Windows | C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup |
| ${ComputerName} | macOS and Windows | Windows: Computer name of local device, same as %COMPUTERNAME% For example: DESKTOP-123456 macOS: Computername.local |
| ${Desktop} | macOS and Windows | Windows: C:\Users\< Username >\Desktop macOS: /Users/< Username >/Desktop |
| ${Device.Address} | macOS and Windows | Primary IP of device as reported by the agent. For example: 10.1.1.1 |
| ${Device.FQDN} | macOS and Windows | Fully qualified domain name of device. Windows: DESKTOP-123456.recastsoftware.com macOS: < Username >.local |
| ${Device.Name} | macOS and Windows | Active computer name of device. Windows: DESKTOP-123456 macOS: < Username >.local |
| ${Documents} | macOS and Windows | Windows: C:\Users\< Username >\Documents macOS: /Users/< Username >/Documents |
| ${Favorites} | macOS and Windows | Windows: C:\Users\< Username >\Favorites macOS: /Users/< Username >/Library/Favorites |
| ${FontsDir} | macOS and Windows | Windows: C:\Windows\Fonts This variable is only available with 3.1 or later macOS: /var/root/Library/Fonts |
| $(Identity.DisplayName) | only macOS | User Name |
| ${Identity.ID) | only macOS | AzureAD\c7a17eb7-7fe9-419c-a437-df909e2e3ef6 |
| ${Identity.Mail) | only macOS | username@recastsoftware.com |
| ${Identity.Name) | only macOS | username@recastsoftware.com |
| ${Identity.Source) | only macOS | AzureAD |
| ${Identity.UserName) | only macOS | username@recastsoftware.com |
| ${Identity.UserPrincipalName) | only macOS | username@recastsoftware.com |
| ${LIQUIT_INSTALL_PATH) | only macOS | C: |
| ${Liquit_Path) | only macOS | C:\Windows\LiquitInstall |
| ${LiquitAgentBinDir) | only macOS | /Applications/Liquit.app/Contents/MacOS |
| ${LiquitAgentDataDir} | macOS and Windows | Windows: C:\ProgramData\Liquit\Agent macOS: /Library/Application Support/com.liquit.Agent |
| ${LiquitAgentDir} | macOS and Windows | Windows: C:\Program Files\Liquit Universal Agent macOS: /Applications/Liquit.app |
| ${LocalAppData} | macOS and Windows | Windows: C:\Users\< Username >\AppData\Local macOS: /Users/< Username >/Library/Application Support |
| ${PackageCollection} | only Windows | The name of the shortcut being executed. |
| ${PackageExecuteStage} | only Windows | 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} | only Windows | Contains the ID of the current package. |
| ${PackageSnapshotName} | only Windows | The name of the current package snapshot being executed. |
| ${PackageStage} | only Windows | The stage of the current package snapshot being executed. |
| ${PackageTempDir} | only Windows |
|
| ${PackageVersion} | only Windows | Contains the snapshot ID of the current package. |
| ${Platform.SessionID} | macOS and Windows | Windows and macOS Session ID For example: 2 |
| ${Platform.UserID} | only Windows | Windows User SID For example: 4B296B08-6BB6-4084-A8F9-B1B1DE303E4A This variable is only available with 3.7 or later |
| ${Platform.UserName} | macOS and Windows | The Windows and macOS User Name used to log on to the local device. For example Administrator |
| ${ProgramData} | macOS and Windows | Windows: C:\ProgramData macOS: /Library/Application Support |
| ${ProgramFiles} | macOS and Windows | Windows: C:\Program Files macOS: /Applications |
| ${ProgramFiles32} | macOS and Windows | Windows: 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) macOS: /Applications |
| ${ProgramFiles64} | macOS and Windows | Windows: C:\Program Files This variable is only available on 64-bit systems macOS: /Applications |
| ${Programs} | only Windows | C:\Users\< Username >AppData\Roaming\Microsoft\Windows\Start Menu\Programs |
| ${Public} | only Windows | C:\Users\Public |
| ${SendTo} | only Windows | C:\Users\< Username >\AppData\Roaming\Microsoft\Windows\SendTo |
| ${StartMenu} | only Windows | C:\Users\< Username >\AppData\Roaming\Microsoft\Windows\Start Menu |
| ${Startup} | only Windows | C:\Users\< Username >\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup |
| ${SystemDrive} | macOS and Windows | Windows: C: macOS: / |
| ${SystemRoot} | macOS and Windows | Windows: C:\Windows macOS: /System |
| ${TaskBar} | only Windows | C:\Users\< Username >\AppData\Roaming\Microsoft\Internet Explorer\Quick Launch\User Pinned |
| ${TEMP} | macOS and Windows | Windows: C:\Users\< Username >\AppData\Local\Temp macOS: /var/folders/89/q2p58g1s07s3dqww9npc16500000gn/T/ |
| $(Test Variable) | only macOS | |
| ${UserDomain} | macOS and Windows | The Windows and macOS Domain used to log into the local device. For example RECASTSOFTWARE |
| ${UserName} | macOS and Windows | The Windows and macOS User Name used to log into the local device. For example Administrator |
| ${UserProfile} | macOS and Windows | Windows: C:\Users\< Username > macOS: /Users/< Username > |
| ${WinDir} | only Windows | C:\Windows |
| $(WindowsApps) | only Windows | C:\Program Files\WindowsApps |
| ${WinSysDir} | only Windows | C:\Windows\System32 |
| ${WinSysDir32} | only Windows | 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} | only Windows | C:\Windows\System32 This variable is only available on 64-bit systems |
Identity Variables
The following identity variables are predefined in Application Workspace, are detected by the Agent and Application 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. |