[Index]

Model: data/ModelFilterCriteria

Model Filter Criteria

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Overview

Model filter criteria defines how users (for example, LDAP or 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 (for example, Microsoft, LDAP, or CUCM users).

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:

Create Model Filter Criteria

Pre-requisites:

Perform these steps:

  1. Identify the source and target model and field that will be used in the filter.

  2. Go to (default menu) Customizations > Model Filter Criteria.

    Note

    Alternative step: Go to (default menus) Flow Through Provisioning Configuration > Model Filter Criteria.

  3. Click Add to add a new record, or clone an existing model filter criteria and update it to create a new model filter.

  4. Provide a Name, Description, and Usage for the filter.

    Note

    The Model Filter Criteria with usage set to Move User is used to move the user. Model Filter Criteria with usage set to Flow Through Provisioning is used to provision the user.

    The flow through provisioning usage does not move a user, and will run only if the user is at a site.

  5. From the Type (model type) drop-down, select the source model, for example device/msgraph/MsolUser (for Microsoft users) or device/ldap/user (for LDAP users).

    Note

    The model type defines the available attributes you can use in the model filter criteria.

  6. Click the Plus sign (+) in the Criteria group to add one or more criteria.

    Each criteria is defined by the following:

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.

  1. Save the model filter criteria.

    You will be able to choose this new model filter criteria in the site's SDD, and it will be, for example, applied in the Microsoft overbuild if Include Site for Overbuild and Microsoft Users is enabled.

    When running the overbuild, the system loops through the site defaults to identify sites with Include Site for Overbuild enabled, and moves related user data to the site based on the chosen model filter criteria rule.

    In this example, all device/msgraph/MsolUser instances synced in will be moved to the site matching {{ macro.OVERBUILD_SITE_CITY_NAME }} if their City value matches.

Related Topics

Microsoft Overview in the Core Feature Guide

Sync with Flow Through in the Core Feature Guide

Flow Through Provisioning in the Core Feature Guide

This captures criteria for filter rules.

Model Details: data/ModelFilterCriteria

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"]