Model filter criteria defines how users (for example, Microsoft Active Directory or MS Entra MSOL user) are matched to corresponding data in VOSS Automate, to move users and related data to the correct system levels (Customer or Site) on import (in a sync or overbuild), based on one or attributes defined for the model type.

Administrator users with access to the data/ModelFilterCriteria model can manage instances of this model so that these are available for selection in the Site Defaults Doc (SDD) of a site.

The SDD provides options to choose a predefined model filter criteria (depending on the user type). Options are:

Field	Description
Unary Operator	None, or NOT: to operate on the match Condition with the target value
Attribute	The field from the source model, for example `City` from `device/msgraph/MsolUser`.
Condition	Options are exact and non-exact types of contains and equals, as well as a regex search option.
Value	The target value that identifies the site in VOSS Automate. The value can also be a named macro, for example, `{{ macro.OVERBUILD_SITE_CITY_NAME }}`.
Conditional Operator	AND or OR: only needed and used to indicate the type of Boolean combination with the following criteria instance, if an additional instance is added.

New model filter criteria functionality is available from release 21.4-PB3. For Model Filter Criteria of Type device/msgraph/MsolUser, the Attribute called Groups.displayName is available to create a filter that can be used to sync in and automatically onboard - move and provision users - based on their Microsoft Entra ID group membership.

Important

A number of caveats need to be considered when creating filters using Groups.displayName:

The Value of the Groups.displayName attribute should be an exact case-sensitive match of the Microsoft Entra ID group name.

For example, a Value of Northwood will match Northwood, but will not match northwood, Northwoodly, WestNorthwood or Westnorthwood.
The Condition should be Equals Exactly.
Multiple conditions using the Groups.displayName attribute are supported, but require the use of AND as the Conditional Operator. All conditions in the filter should therefore be true for the filter to apply; in other words, the user needs to belong to all the groups matching the Value field.

Note that:
- If a single matching filter condition is added whereas a user belongs to more than one Microsoft Entra ID group, the user is matched if the filter matches.
- If an OR conditional operator is used, this will be interpreted as an AND operator.
The Groups.displayName attribute cannot be combined with other attributes in a filter: other attributes will be ignored.
Verify that these caveats are taken into consideration, since model filter criteria can be saved in the system without their considersation.

Model Details: data/ModelFilterCriteria

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title			Description	Details
Name *			Name of the Model Filter Criteria.	Field Name: name Type: String
Description				Field Name: description Type: String
Usage			Usage of the Model Filter Criteria, example FTP, Overbuild. This is a free text field and can be used to filter on by usage.	Field Name: usage Type: String
Type			Type of element to check for Filter Criteria	Field Name: type Type: String Format: uri
	Criteria			Field Name: criteria.[n] Type: Array Cardinality: [1..n]
		Unary Operator	Unary operator NOT or nothing.	Field Name: criteria.[n].unary_operator Type: String Choices: ["NOT"]
		Attribute *	Attribute or property of the element to check.	Field Name: criteria.[n].attribute Type: String
		Condition *	List of string conditions.	Field Name: criteria.[n].condition Type: String Choices: ["Contains", "Contains Exactly", "Equals", "Equals Exactly", "Regex Search"]
		Value *	The value to check against the attribute or property.	Field Name: criteria.[n].value Type: String
		Conditional Operator	The operator to apply to the next step, OR or AND.	Field Name: criteria.[n].conditional_operator Type: String Choices: ["AND", "OR"]

Model: data/ModelFilterCriteria

Model Filter Criteria

Model Details: data/ModelFilterCriteria