.. _define_a_filter:

Define a Filter
---------------

You can define a filter to easily select multiple users to move according
to one or more user attributes (default menu **User Management > Move Users**).

If you specify multiple attributes, a user matches the filter only if the
user matches all of the attributes in the filter. For example, a filter
with State=Missouri and City=Kansas City, does not match a user in Kansas
City, Kansas.

Procedure
.........

1. Open the **Define Filters** form (default menu **User Management > Manage Filters
   > Define Filters**).
#. Click **Add**.
#. Click the **Base**, **Extended**, or **Custom** tab to locate the user attribute
   or attributes you want to filter on. Provide the following information:

   +-------------------+------------------------------------------------+
   | Field             | Description                                    |
   +===================+================================================+
   | Name              | Enter a name for the filter. This field is     |
   |                   | mandatory.                                     |
   +-------------------+------------------------------------------------+
   | Move To Hierarchy | Choose the target hierarchy node. This field   |
   |                   | is mandatory.                                  |
   +-------------------+------------------------------------------------+
   |                   | Choose the role to be assigned to the user     |
   | Move To Role      | after the move. The available roles depend on  |
   |                   | the target hierarchy node selected. This field |
   |                   | is mandatory.                                  |
   +-------------------+------------------------------------------------+
   | Condition         | Choose a condition for at least one of the     |
   |                   | available filters.                             |
   +-------------------+------------------------------------------------+
   |                   | Specify the value to evaluate for the          |
   | Value             | condition. Set this field for at least one of  |
   |                   | the available filters.                         |
   +-------------------+------------------------------------------------+

   Example: Set the City Filter to Condition=isexactly and Value=Toronto
   to move users in Toronto to the target hierarchy node and give them
   the target user role.
   
4. Click **Save**.

The filter is available to be used to manually move users using the **Move Users**
form (default menu **User Management > Move Users**). Filters are automatically
applied during LDAP and Cisco Unified Communications Manager user synchronization,
if the User Move mode is set to automatic.