[Index]

Model: data/HcsMoveFilterDAT

Define Filters

Full HTML Help

This procedure creates a filter that will allow you to select multiple users, based on one or more user attributes, so that you can use the filter to move these users to a different hierarchy.

Note

To define the filter:

  1. Go to (default menu) User Management > Manage Filters > Define Filters.

  2. Click Add.

  3. On each tab, locate user attributes for the filter: Base, Extended, or Custom

    Provide the following information:

    Field Description
    Name Mandatory. Enter a name for the filter.
    Move To Hierarchy Choose the target hierarchy node. This field is mandatory.
    Move To Role

    Choose the role to be assigned to the user after the move. The available roles depend on the target hierarchy node selected. This field is mandatory.

    The list of available roles will include those where the Hierarchies Allowed list of the role contains the target hierarchy selected in the Move To Hierarchy list. [1]
    Condition Choose a condition for at least one of the available filters.
    Value Specify the value to evaluate for the 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.

  1. Click Save.

    You can use the filter to manually move users using the Move Users form (default menu User Management > Move Users).

[1]See: Role Management.

HcsMoveFilterDAT

Model Details: data/HcsMoveFilterDAT

Title Description Details
Name * The name of the move filter.
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Move To Hierarchy * The business key of the hierarchy node to which the user will be moved if the conditions are satisfied.
  • Field Name: move_to_hn_uri
  • Type: String
  • Target: data/HierarchyNode
  • MaxLength: 1024
  • Format: uri
Move To Role (default) * The default role to assign to the moved user (if no other LDAP Custom Role Mappings are applicable for the moved user, then this fallback/default role will be applied).
  • Field Name: move_to_role
  • Type: String
  • Target: data/Role
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Street Filter A filter based on matching against the user's street.
  • Field Name: street_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's street.
  • Field Name: street_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's street.
  • Field Name: street_filter.value
  • Type: String
  • MaxLength: 1024
City Filter A filter based on matching against the user's city.
  • Field Name: l_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's city.
  • Field Name: l_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's city.
  • Field Name: l_filter.value
  • Type: String
  • MaxLength: 1024
State Filter A filter based on matching against the user's state.
  • Field Name: st_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's state.
  • Field Name: st_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's state.
  • Field Name: st_filter.value
  • Type: String
  • MaxLength: 1024
Postal Code Filter A filter based on matching against the user's postal code.
  • Field Name: postal_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's postal code.
  • Field Name: postal_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's postal code.
  • Field Name: postal_filter.value
  • Type: String
  • MaxLength: 1024
Building Name Filter A filter based on matching against the user's building name.
  • Field Name: building_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's building name.
  • Field Name: building_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's building name.
  • Field Name: building_filter.value
  • Type: String
  • MaxLength: 1024
Department Number Filter A filter based on matching against the user's department number.
  • Field Name: dept_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's department number.
  • Field Name: dept_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's department number.
  • Field Name: dept_filter.value
  • Type: String
  • MaxLength: 1024
Country Filter A filter based on matching against the user's country.
  • Field Name: c_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's country.
  • Field Name: c_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's country.
  • Field Name: c_filter.value
  • Type: String
  • MaxLength: 1024
Directory URI Filter A filter based on matching against the user's directory URI.
  • Field Name: directory_uri_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's directory URI.
  • Field Name: directory_uri_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's directory URI.
  • Field Name: directory_uri_filter.value
  • Type: String
  • MaxLength: 1024
Display Name Filter A filter based on matching against the user's display name.
  • Field Name: display_name_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's display name.
  • Field Name: display_name_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's display name.
  • Field Name: display_name_filter.value
  • Type: String
  • MaxLength: 1024
Employee Number Filter A filter based on matching against the user's employee number.
  • Field Name: employee_number_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's employee number.
  • Field Name: employee_number_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's employee number.
  • Field Name: employee_number_filter.value
  • Type: String
  • MaxLength: 1024
Employee Type Filter A filter based on matching against the user's employee type.
  • Field Name: employee_type_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's employee type.
  • Field Name: employee_type_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's employee type.
  • Field Name: employee_type_filter.value
  • Type: String
  • MaxLength: 1024
FAX Number Filter A filter based on matching against the user's FAX number.
  • Field Name: facsimile_telephone_number_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's FAX number.
  • Field Name: facsimile_telephone_number_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's FAX number.
  • Field Name: facsimile_telephone_number_filter.value
  • Type: String
  • MaxLength: 1024
First Name Filter A filter based on matching against the user's first name.
  • Field Name: given_name_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's first name.
  • Field Name: given_name_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's first name.
  • Field Name: given_name_filter.value
  • Type: String
  • MaxLength: 1024
Home Phone Filter A filter based on matching against the user's home phone number.
  • Field Name: home_phone_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's home phone number.
  • Field Name: home_phone_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's home phone number.
  • Field Name: home_phone_filter.value
  • Type: String
  • MaxLength: 1024
IP Phone Filter A filter based on matching against the user's IP phone number.
  • Field Name: ip_phone_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's IP phone number.
  • Field Name: ip_phone_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's IP phone number.
  • Field Name: ip_phone_filter.value
  • Type: String
  • MaxLength: 1024
Jabber ID Filter A filter based on matching against the user's Jabber ID.
  • Field Name: jabber_id_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's Jabber ID.
  • Field Name: jabber_id_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's Jabber ID.
  • Field Name: jabber_id_filter.value
  • Type: String
  • MaxLength: 1024
Mail Filter A filter based on matching against the user's mail.
  • Field Name: mail_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's mail.
  • Field Name: mail_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's mail.
  • Field Name: mail_filter.value
  • Type: String
  • MaxLength: 1024
Manager Filter A filter based on matching against the user's manager.
  • Field Name: manager_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's manager.
  • Field Name: manager_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's manager.
  • Field Name: manager_filter.value
  • Type: String
  • MaxLength: 1024
Member Of Filter A filter based on matching against the user's member of.
  • Field Name: member_of_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's groups.
  • Field Name: member_of_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's member of.
  • Field Name: member_of_filter.value
  • Type: String
  • MaxLength: 1024
Mobile Filter A filter based on matching against the user's mobile.
  • Field Name: mobile_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's mobile number.
  • Field Name: mobile_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's mobile.
  • Field Name: mobile_filter.value
  • Type: String
  • MaxLength: 1024
Organization Name Filter A filter based on matching against the user's organization name.
  • Field Name: o_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's organization name.
  • Field Name: o_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's organization name.
  • Field Name: o_filter.value
  • Type: String
  • MaxLength: 1024
Object Class Filter A filter based on matching against the user's object class.
  • Field Name: object_class_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's object class.
  • Field Name: object_class_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's object class.
  • Field Name: object_class_filter.value
  • Type: String
  • MaxLength: 1024
Other Mailbox Filter A filter based on matching against the user's other mailbox.
  • Field Name: other_mailbox_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's other mailbox.
  • Field Name: other_mailbox_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's other mailbox.
  • Field Name: other_mailbox_filter.value
  • Type: String
  • MaxLength: 1024
Organization Unit Name Filter A filter based on matching against the user's organization unit name.
  • Field Name: ou_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's organization unit name.
  • Field Name: ou_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's organization unit name.
  • Field Name: ou_filter.value
  • Type: String
  • MaxLength: 1024
Photo URL Filter A filter based on matching against the user's photo URL.
  • Field Name: photo_url_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's photo URL.
  • Field Name: photo_url_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's photo URL.
  • Field Name: photo_url_filter.value
  • Type: String
  • MaxLength: 1024
Physical Delivery Office Name Filter A filter based on matching against the user's physical delivery office name.
  • Field Name: physical_delivery_office_name_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's physical delivery office name.
  • Field Name: physical_delivery_office_name_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's physical delivery office name.
  • Field Name: physical_delivery_office_name_filter.value
  • Type: String
  • MaxLength: 1024
Preferred Language Filter A filter based on matching against the user's preferred language.
  • Field Name: preferred_language_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's preferred language.
  • Field Name: preferred_language_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's preferred language.
  • Field Name: preferred_language_filter.value
  • Type: String
  • MaxLength: 1024
Last Name Filter A filter based on matching against the user's last name.
  • Field Name: sn_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's last name.
  • Field Name: sn_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's last name.
  • Field Name: sn_filter.value
  • Type: String
  • MaxLength: 1024
Telephone Number Filter A filter based on matching against the user's telephone number.
  • Field Name: telephone_number_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's telephone number.
  • Field Name: telephone_number_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's telephone number.
  • Field Name: telephone_number_filter.value
  • Type: String
  • MaxLength: 1024
Timezone Filter A filter based on matching against the user's timezone.
  • Field Name: timezone_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's timezone.
  • Field Name: timezone_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's timezone.
  • Field Name: timezone_filter.value
  • Type: String
  • MaxLength: 1024
Title Filter A filter based on matching against the user's title.
  • Field Name: title_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's title.
  • Field Name: title_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's title.
  • Field Name: title_filter.value
  • Type: String
  • MaxLength: 1024
Uid Filter A filter based on matching against the user's uid.
  • Field Name: uid_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's uid.
  • Field Name: uid_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's uid.
  • Field Name: uid_filter.value
  • Type: String
  • MaxLength: 1024
Unverified Mail Box Filter A filter based on matching against the user's unverified mail box.
  • Field Name: unverified_mail_box_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's unverified mail box.
  • Field Name: unverified_mail_box_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's unverified mail box.
  • Field Name: unverified_mail_box_filter.value
  • Type: String
  • MaxLength: 1024
Username Filter A filter based on matching against the user's username.
  • Field Name: username_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's username.
  • Field Name: username_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's username.
  • Field Name: username_filter.value
  • Type: String
  • MaxLength: 1024
Custom String 1 Filter A filter based on matching against the user's custom string 1.
  • Field Name: custom_string_1_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's custom string 1.
  • Field Name: custom_string_1_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's custom string 1.
  • Field Name: custom_string_1_filter.value
  • Type: String
  • MaxLength: 1024
Custom String 2 Filter A filter based on matching against the user's custom string 2.
  • Field Name: custom_string_2_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's custom string 2.
  • Field Name: custom_string_2_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's custom string 2.
  • Field Name: custom_string_2_filter.value
  • Type: String
  • MaxLength: 1024
Custom String 3 Filter A filter based on matching against the user's custom string 3.
  • Field Name: custom_string_3_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's custom string 3.
  • Field Name: custom_string_3_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's custom string 3.
  • Field Name: custom_string_3_filter.value
  • Type: String
  • MaxLength: 1024
Custom String 4 Filter A filter based on matching against the user's custom string 4.
  • Field Name: custom_string_4_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's custom string 4.
  • Field Name: custom_string_4_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's custom string 4.
  • Field Name: custom_string_4_filter.value
  • Type: String
  • MaxLength: 1024
Custom String 5 Filter A filter based on matching against the user's custom string 5.
  • Field Name: custom_string_5_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's custom string 5.
  • Field Name: custom_string_5_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's custom string 5.
  • Field Name: custom_string_5_filter.value
  • Type: String
  • MaxLength: 1024
Custom List of Strings 1 Filter A filter based on matching against the user's custom list of strings 1.
  • Field Name: custom_list_of_strings_1_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's custom list of strings 1.
  • Field Name: custom_list_of_strings_1_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's custom list of strings 1.
  • Field Name: custom_list_of_strings_1_filter.value
  • Type: String
  • MaxLength: 1024
Custom List of Strings 2 Filter A filter based on matching against the user's custom list of strings 2.
  • Field Name: custom_list_of_strings_2_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's custom list of strings 2.
  • Field Name: custom_list_of_strings_2_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's custom list of strings 2.
  • Field Name: custom_list_of_strings_2_filter.value
  • Type: String
  • MaxLength: 1024
Custom List of Strings 3 Filter A filter based on matching against the user's custom list of strings 3.
  • Field Name: custom_list_of_strings_3_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's custom list of strings 3.
  • Field Name: custom_list_of_strings_3_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's custom list of strings 3.
  • Field Name: custom_list_of_strings_3_filter.value
  • Type: String
  • MaxLength: 1024
Custom List of Strings 4 Filter A filter based on matching against the user's custom list of strings 4.
  • Field Name: custom_list_of_strings_4_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's custom list of strings 4.
  • Field Name: custom_list_of_strings_4_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's custom list of strings 4.
  • Field Name: custom_list_of_strings_4_filter.value
  • Type: String
  • MaxLength: 1024
Custom List of Strings 5 Filter A filter based on matching against the user's custom list of strings 5.
  • Field Name: custom_list_of_strings_5_filter
  • Type: Object
Condition The specified condition used to match the specified value against the user's custom list of strings 5.
  • Field Name: custom_list_of_strings_5_filter.condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["isexactly", "contains"]
Value The specified valued used to match against the user's custom list of strings 5.
  • Field Name: custom_list_of_strings_5_filter.value
  • Type: String
  • MaxLength: 1024