Skip to main content

Using user classes with plugin points

User class definitions can be added to the following plugin points:

  • Manage the system > Workflow > Options > Escalation > ESCALATION PLUGIN

  • Manage the system > Workflow > Options > Escalation > FIRST CHANCE ESCALATION PLUGIN

  • Manage the system > Workflow > Options > Plugins > AUTHORIZATION DETAIL MASK PLUGIN

  • Manage the system > Modules> Options > FILTER USER PLUGIN

  • Manage the system > Modules> Options > KEEP USER PLUGIN

  • Manage the system > Modules> Options > GENERATE USER PLUGIN

These plugin points include the Use user classes option, which allows you to filter or generate lists of users based on user user classes.

If you choose to use user classes, then you do not need to write a plugin. However, user classes can also be used in conjunction with a plugin.

For example, if you:

Use user classes

then the specified user classes are used to filter or generate lists of users.

Use user classes and write a plugin

then the specified user classes and plugin script are both used to filter or generate lists of users, with the plugin taking its input from results provided by the user class.

Write a plugin

then the plugin is used to filter or generate lists of users.

For details, see:

To configure the Use user classes option:

  1. Click Use user classes under the field for the plugin point you want to modify.

    A page loads related to the option you are modifying. For example, if you are modifying FILTER USER PLUGIN, then the Filter Criteria filter_user_plugin page loads. If user class definitions already exist for this option, they are listed.

  2. Define your user classes. You can choose existing user classes, create new user classes, or both:

    • To select from existing user classes:

      1. Click Select… .

      2. Enable the checkboxes next to the user classes you want to select, then click Select.

        The list of user class members is displayed.

      3. Complete the participant definitions for the newly added user classes by selecting from the drop-down menu.

      4. Click Update.

    • To create a new user class:

      1. See Adding user classes for details on how to create a user class.

      2. Once created, complete the participant definition for your new user class by selecting from the drop-down menus.

    Once you’ve added at least one user class to the list of user class members, you can also:

    • Delete user classes from the list.

    • Update the participant definitions for the user classes in the list.

    If you have multiple user classes in the list of user class members, then The participants have to match which of the user classes option is displayed.

This can be set so that:

  • The participants can match Any of the user classes listed

  • The participants must match All of the user classes listed

In this section: