Variables

Variables give you the tools to be as dynamic as possible.

Variables can currently be defined on 3 different levels;

  • System (Global)
  • Location
  • Package

The inheritence flows top-down and support local override. This means a variable defined on the System level, can be used in Locations and Packages. That same variable could be overriden on a Location level, to provide dynamic customization based on the location of the Identity.

This allows very dynamic setups while using a simple mechanic.

To use variables, you specify them in the following way: ${<VARIABLE NAME>}
For a variable named 'MY_CUSTOM_VAR' you would use the notation: ${MY_CUSTOM_VAR}

System Variables

The following system variables are available for use within Liquit, these variables are pre-defined and detected by the agent. Some variables are only available since a specific version of the agent, this will be listed in the remarks section of each variable. The paths used as example, might not match your environment.

Variable Output
${AllUsersProfile} C:\ProgramData
${AppData} C:\Users\<Username>\AppData\Roaming
${CommonDesktop} C:\Users\Public\Desktop
${CommonProgramFiles} C:\Program Files\Common Files
${CommonProgramFiles32} On 32-bit systems this path is resolved to: C:\Program Files\Common Files
On 64-bit systems this path is resolved 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
${ComputerName} Computer name of local device, same as %COMPUTERNAME%
For example: DESKTOP-123456
${CommonStartup} C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup
Requires at least agent version 2.3
${Desktop} C:\Users\\Desktop
${Device.Address} Primary IP of device as reported by the agent.
For example: 10.1.1.1
Requires at least agent version 2.3
${Device.FQDN} Fully qualified domain name of device.
For example: DESKTOP-123456.liquit.com,
Requires at least agent version 2.3
${Device.Name} Active computer name of device.
For example: DESKTOP-123456
Requires at least agent version 2.3
${Documents} C:\Users\<Username>\Documents
${Favorites} C:\Users\<Username>\Favorites
${LiquitAgentDir} C:\Program Files (x86)\Liquit Workspace\Agent
${LiquitAgentDataDir} C:\ProgramData\Liquit Workspace\Agent\
Requires at least agent version 2.5
${PackageID} Contains the ID of the current package.
Requires at least agent version 2.5
${PackageVersion} Contains the snapshot ID of the current package.
Requires at least agent version 2.5
${PackageTempDir} Contains a temporary sub-directory for the current execution instance.
Requires at least agent version 2.5
${LocalAppData} C:\Users\<Username>\AppData\Local
${Platform.SessionID} Windows Session ID
For example: 2
Requires at least agent version 2.3
${Platform.UserName} Windows User Name, that was used to log on to the local device.
For example: Administrator
Requires at least agent version 2.3
${ProgramData} C:\ProgramData
${ProgramFiles} C:\Program Files
${ProgramFiles32} On 32-bit systems this path is resolved to: C:\Program Files
On 64-bit systems this path is resolved 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}
${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\\AppData\Local\Temp
Requires at least agent version 2.5
${UserDomain} Windows Domain that the user is logged on to on the local device.
For example: LIQUIT
${UserName} Windows User Name, that was used to log on to the local device.
For example: Administrator
${UserProfile} C:\Users\
${WinDir} C:\Windows
${WinSysDir} C:\Windows\System32
${WinSysDir32} On 32-bit systems this path is resolved to: C:\Windows\System32
On 64-bit systems this path is resolved to: C:\Windows\SysWOW64
${WinSysDir64} C:\Windows\System32
This variable is only available on 64-bit systems