Product documentation
Workspace Environment Management
Service Current Release 2402 2311 2308 2305 2303 2212 2209 2206 2203
View PDF

Filter conditions

August 27, 2024
Contributed by: 
C C

Workspace Environment Management includes the following filter conditions which you use to configure the circumstances under which the agent assigns resources to users. For more information about using these conditions in the administration console, see Filters.

When using the following filter conditions, be aware of these two scenarios:

  • If the agent is installed on a single-session or multi-session OS:
    • “Client” refers to a client device connecting to the agent host.
    • “Computer” and “Client Remote” refer to the agent host.
  • If the agent is installed on a physical endpoint, conditions that contain “client” in the condition names are not applicable.
Condition Name Always True
Expected value type N/A
Expected result type N/A
Expected syntax N/A
Returns True.
Condition Name ComputerName Match
Expected value type N/A
Expected result type String.
Expected syntax Single name test: Computername Multiple tests (OR): Computername1;Computername2 Wildcard (also works with multiples): ComputerName*
Returns True if the current computer name matches the tested value, false otherwise.
Condition Name ClientName Match
Expected value type N/A
Expected value type String.
Expected syntax Single name test: Clientname Multiple tests (OR): Clientname1;Clientname2 Wildcard (also works with multiples): ClientName*
Returns True if the current client name matches the tested value, false otherwise.
Condition Name IP Address Match
Expected value type N/A
Expected result type IP address.
Expected syntax Single name test: IpAddress Multiple tests (OR): IpAddress1;IpAddress2 Wildcard (also works with multiples): IpAddress* Range (also works with multiples): IpAddress1-IpAddress2
Returns True if the current computer IP address matches the tested value, false otherwise.
Condition Name Client IP Address Match
Expected value type N/A
Expected result type IP address.
Expected syntax Single name test: ClientIpAddress Multiple tests (OR): ClientIpAddress1;ClientIpAddress2 Wildcard (also works with multiples): ClientIpAddress* Range (also works with multiples): IpAddress1-IpAddress2
Returns True if the current client IP address matches the tested value, false otherwise.
Condition Name Active Directory Site Match
Expected value type N/A
Expected result type Exact name of the Active Directory site to test.
Expected syntax Active directory site name.
Returns True if the specified site matches the current site, false otherwise.
Condition Name Scheduling
Expected value type N/A
Expected result type Day of week (example: Monday).
Expected syntax Single name test: DayOfWeek Multiple tests (OR): DayOfWeek1; DayOfWeek2
Returns True if today matches the tested value, false otherwise.
Condition Name Environment Variable Match
Expected value type String. Name of the tested variable.
Expected result type String. Expected value of the tested variable.
Expected syntax Single name test: value Not null test: ?
Returns True if environment variable exists and value matches, false otherwise.
Condition Name Registry Value Match
Expected value type String. Full path and name of the registry value to test. Example: Registry Key HKCU\Software\Citrix\TestValueName
Expected result type String. Expected value of the tested registry entry.
Expected syntax Single name test: value Not null test: ?
Returns True if registry value exists and value matches, false otherwise.
Condition Name WMI Query result Match
Expected value type N/A
Expected result type String.
Expected syntax Valid WMI query. For more information, see https://docs.microsoft.com/en-us/windows/win32/wmisdk/querying-with-wql.
Returns True if query is successful and has a result, false otherwise.
Condition Name User Country Match
Expected value type N/A
Expected result type String.
Expected syntax Two letter ISO language name.
Returns True if user ISO language name matches the specified value, false otherwise.
Condition Name User UI Language Match
Expected value type N/A
Expected result type String. Two letter ISO language name. Example FR.
Expected syntax Two letter ISO language name. Example FR.
Returns True if user UI ISO language name matches the specified value, false otherwise.
Condition Name User SBC Resource Type
Expected value type N/A
Expected result type Select from list.
Expected syntax N/A
Returns True if user context (published desktop or application) matches the selected value, false otherwise.
Condition Name OS Platform Type
Expected value type N/A
Expected result type Select from dropbox.
Expected syntax N/A
Returns True if machine platform type (x64 or x86) matches the selected value, false otherwise.
Condition Name Connection State
Expected value type N/A
Expected result type Select from dropbox.
Expected syntax N/A
Returns True if connection state (online or offline) matches the selected value, false otherwise.
Condition Name Citrix Provisioning Image Mode
Expected value type N/A
Expected result type Select from dropbox.
Expected syntax N/A
Returns True if current Citrix Provisioning image mode matches the selected value, false otherwise.
Condition Name Client OS
Expected value type N/A
Expected result type Select from dropbox.
Expected syntax N/A
Returns True if current client operating system matches the selected value, false otherwise.
Condition Name Active Directory Path Match
Expected value type N/A
Expected result type String. Name of the tested Active Directory Path.
Expected syntax Single name test: strict LDAP path matching Wildcard test: OU=Users* Multiple entries: separate entries with semicolon (;)
Returns True if attribute exists and the value matches, false otherwise.
Condition Name Active Directory Attribute Match
Expected value type String. Name of the tested Active Directory attribute.
Expected result type String. Expected value of the tested Active Directory attribute.
Expected syntax Single value test: value Multiple value entries: separate entries with semicolon (;) Test for not null: ?
Returns True if attribute exists and the value matches, false otherwise.
Condition Name Name or Value is in List
Expected value type String. Full file path of the XML list generated by the Integrity List manager utility.
Expected result type String. Expected value of the name/value to look for in the list.
Expected syntax String
Returns True if the input value is found in the name/value pairs in the specified list, false otherwise.
Condition Name No ComputerName Match
Negative condition behavior Runs ComputerName Match and returns the opposite result (true if false, false if true). See condition ComputerName Match for more information.
Condition Name No ClientName Match
Negative condition behavior Runs ClientName Match and returns the opposite result (true if false, false if true). See condition ClientName Match for more information.
Condition Name No IP Address Match
Negative condition behavior Runs IP Address Match and returns the opposite result (true if false, false if true). See condition IP Address Match for more information.
Condition Name No Client IP Address Match
Negative condition behavior Runs Client IP Address Match and returns the opposite result (true if false, false if true). See condition Client IP Address Match for more information.
Condition Name No Active Directory Site Match
Negative condition behavior Runs Active Directory Site Match and returns the opposite result (true if false, false if true). See condition Active Directory Site Match for more information.
Condition Name No Environment Variable Match
Negative condition behavior Runs Environment Variable Match and returns the opposite result (true if false, false if true). See condition Environment Variable Match for more information.
Condition Name No Registry Value Match
Negative condition behavior Runs Registry Value Match and returns the opposite result (true if false, false if true). See condition Registry Value Match for more information.
Condition Name No WMI Query result Match
Negative condition behavior Runs WMI Query result Match and returns the opposite result (true if false, false if true). See condition WMI Query result Match for more information.
Condition Name No User Country Match
Negative condition behavior Runs User Country Match and returns the opposite result (true if false, false if true). See condition User Country Match for more information.
Condition Name No User UI Language Match
Negative condition behavior Runs User UI Language Match and returns the opposite result (true if false, false if true). See condition User UI Language Match for more information.
Condition Name No Active Directory Path Match
Negative condition behavior Runs Active Directory Path Match and returns the opposite result (true if false, false if true). See condition Active Directory Path Match for more information.
Condition Name No Active Directory Attribute Match
Negative condition behavior Runs Active Attribute Path Match and returns the opposite result (true if false, false if true). See condition Active Attribute Path Match for more information.
Condition Name Name or Value is not in List
Negative condition behavior Runs Name or Value is in List and returns the opposite result (true if false, false if true). See condition Name or Value is in List for more information.
Condition Name Client Remote OS Match
Expected value type N/A
Expected result type Select from dropbox.
Expected syntax N/A
Returns True if current remote client operating system matches selected value, false otherwise.
Condition Name No Client Remote OS Match
Negative condition behavior Runs Client Remote OS Match and returns the opposite result (true if false, false if true). See condition Client Remote OS Match for more information.
Condition Name Dynamic Value Match
Expected value type String. Any dynamic expression using environment variables or Dynamic Tokens.
Expected result type String. Expected value of the tested expression.
Expected syntax Single name test: value Not null test: ?
Returns True if dynamic expression result value exists and value matches, false otherwise.
Condition Name No Dynamic Value Match
Negative condition behavior Runs Dynamic Value Match and returns the opposite result (true if false, false if true). See condition Dynamic Value Match for more information.
Condition Name Transformer Mode State
Expected value type N/A
Expected result type Select from dropbox.
Expected syntax N/A
Returns True if current Transformer state matches selected value, false otherwise.
Condition Name No Client OS Match
Negative condition behavior Runs Client OS Match and returns the opposite result (true if false, false if true). See condition Client OS Match for more information.
Condition Name Active Directory Group Match
Expected value type N/A
Expected result type String.
Expected syntax Single name test: group NetBIOS name (DOMAIN\Groupname) Multiple tests (OR): Groupname1;Groupname2
Returns True if any of the current user groups matches the tested value, false otherwise.
Condition Name No Active Directory Group Match
Negative condition behavior Runs Active Directory Group Match and returns the opposite result (true if false, false if true). See condition Active Directory Group Match for more information.
Condition Name File Version Match
Expected value type String. Full path and name of the file to test.
  Example: C:\Test\TestFile.dll
Expected result type String. Expected file version value of the tested file.
Expected syntax Single name test: value Not null test: ?
Returns True if registry value exists and value matches, false otherwise.
Condition Name No File Version Match
Negative condition behavior Runs File Version Match and returns the opposite result (true if false, false if true). See condition File Version Match for more information.
Condition Name Network Connection State
Expected value type N/A
Expected result type Select from dropbox.
Expected syntax N/A
Returns True if current network connection state matches selected value, false otherwise.

Important:

Before you use Published Resource Name as the filter condition type, keep the following in mind: If the published resource is a published application, type the browser name of the application in the Matching Result field. If the published resource is a published desktop, type the published name of the desktop in the Matching Result field.

Condition Name Published Resource Name
Expected value type N/A
Expected result type String. Name of the published resource (Citrix Virtual Apps/Citrix Virtual Desktops/RDS).
Expected syntax Single name test: published resource name Multiple tests (OR): Name1;Name2 Wildcard test: Name*
Returns True if the current published resource name matches the tested value, false otherwise.
Condition Name Name is in List
Expected value type String. Full file path of the XML list generated by the Integrity List manager utility.
Expected result type String. Expected value of the name to look for in the list.
Expected syntax String
Returns True if there is a name match in the name/value pairs in the specified list, false otherwise.
Condition Name Name is not in List
Negative condition behavior Runs Name is in List and returns the opposite result (true if false, false if true). See condition Name is in List for more information.
Condition Name File/Folder exists
Expected value type N/A
Expected result type String.
Expected syntax Full path of the file system entry (file or folder) to test. The path must not include any quotes (“).
Returns True if the specified file system entry exists, false otherwise.
Condition Name File/Folder does not exist
Negative condition behavior Runs File/Folder exists and returns the opposite result (true if false, false if true). See condition File/Folder exists for more information.
Condition Name DateTime Match
Expected value type N/A
Expected result type DateTime as String. Date/time to test.
Expected syntax Single Date: 06/01/2016 Date Range: 06/01/2016-08/01/2016 Multiple entries: entry1;entry2 Ranges and single dates can be mixed
Returns True if execution date/time matches any of the specified entries, false otherwise.
Condition Name No DateTime Match
Negative condition behavior Runs DateTime Match and returns the opposite result (true if false, false if true). See condition DateTime Match for more information.

WEM supports the following filter conditions for use in your Citrix DaaS (formerly Citrix Virtual Apps and Desktops service) and Citrix Virtual Apps and Desktops deployment. The conditions apply to all currently supported versions. When using the version match condition, be aware of the following considerations:

  • You can specify the version numbers in different formats. For example, type 7.30, 7.30.0, or 7.30.0.0. If needed, you can also use the asterisk (*) as a wildcard. For example, 7.30*. The asterisk matches zero or more characters.

  • The specified version is the version number of the Delivery Controller rather than that of the Virtual Delivery Agent. To view the version number, locate the AutoSelect application (the AutoSelect.exe file) on the installation media, right-click AutoSelect, and click the Details tab. The Product version field displays the version number that you can specify in WEM.

Condition Name Citrix Virtual Apps Version Match
Expected value type N/A
Expected result type String. Citrix Virtual Apps Version. Example: 7.30
Expected syntax N/A
Returns True if version matches the selected value, false otherwise.
Condition Name Citrix Virtual Apps Farm Name Match
Expected value type N/A
Expected result type String. Citrix Virtual Apps Farm Name. Example: Farm.
Expected syntax N/A
Returns True if name matches the selected value, false otherwise.
Condition Name Citrix Virtual Apps Zone Name Match
Expected value type N/A
Expected result type String. Citrix Virtual Apps Zone Name. Example: Zone.
Expected syntax N/A
Returns True if name matches the selected value, false otherwise.
Condition Name Citrix Virtual Desktops Farm Name Match
Expected value type N/A
Expected result type String. Citrix Virtual Desktops Farm Name. Example: Farm.
Expected syntax N/A
Returns True if name matches the selected value, false otherwise.
Condition Name Citrix Virtual Desktops Desktop Group Name Match
Expected value type N/A
Expected result type String. Citrix Virtual Desktops Desktop Group Example: Group.
Expected syntax N/A
Returns True if name matches the selected value, false otherwise.
Condition Name No Citrix Virtual Apps Version Match
Negative condition behavior Runs Citrix Virtual Apps Version Match and returns the opposite result (true if false, false if true). See condition Citrix Virtual Apps Version Match for more information.
Condition Name No Citrix Virtual Apps Farm Name Match
Negative condition behavior Runs Citrix Virtual Apps Farm Name Match and returns the opposite result (true if false, false if true). See condition Citrix Virtual Apps Farm Name Match for more information.
Condition Name No Citrix Virtual Apps Zone Name Match
Negative condition behavior Runs Citrix Virtual Apps Zone Name Match and returns the opposite result (true if false, false if true). See condition Citrix Virtual Apps Zone Name Match for more information.
Condition Name No Citrix Virtual Desktops Farm Name Match
Negative condition behavior Runs Citrix Virtual Desktops Farm Name Match and returns the opposite result (true if false, false if true). See condition Citrix Virtual Desktops Farm Name Match for more information.
Condition Name No Citrix Virtual Desktops Desktop Group Name Match
Negative condition behavior Runs Citrix Virtual Desktops Desktop Group Name Match and returns the opposite result (true if false, false if true). See condition Citrix Virtual Desktops Desktop Group Name Match for more information.
Filter conditions
August 27, 2024
Contributed by: 
C C
August 27, 2024
Contributed by: 
C C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.