Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Create the user criteria for an OT knowledge base

Create a user criteria record to determine the users who can read or contribute to an Operational Technology (OT) knowledge base.

Before you begin

Role required: user_criteria_admin

Note: To create a user criteria record from the Knowledge module, you must have the user_criteria_admin role in addition to the knowledge role. For more information about access, see Managing access to knowledge bases and knowledge articles.

About this task

Use the user criteria in Knowledge Management to determine whether certain users can access OT knowledge bases and knowledge articles. After you create a user criteria record, you can assign it to an OT knowledge base to control who can read and contribute to a knowledge base and its articles. You can further assign the user criteria at an article level to control who can read it.

Procedure

  1. Navigate to All > Knowledge > Administration > User Criteria.

  2. Select New.

  3. On the form, fill in the fields.

FieldDescription
NameUnique name of the user criteria.
UsersUsers who must match the user criteria.
GroupsGroups that must match the user criteria.
Roles

Roles to match the user criteria. Note:

  • Because the evaluation of a role is cached in the session, any change in the role requires you to log in again.
  • User criteria are not applicable for elevated privilege roles.
AdvancedOption to display or hide the advanced option that includes the Script field on the User Criteria form.
Script

Script to define any additional user criteria that returns true or false. This field is available when the Advanced option is selected on the User Criteria form. Note:

  • A script is evaluated in the scope that the user criteria are created in.
  • The evaluation of a script is cached in the session, so any change in the evaluation requires you to log in again. If a scripted user criterion is defined for a knowledge base, the user access to the knowledge bases is evaluated after every session. If the script results in changes after a session cache is built, the result takes effect in the next session.
  • Don’t use gs.getUser() or other session APIs because they cause conflicts when used in diagnostic tools. Use the predefined user_id variable available in the script to get the user ID of the user being used to evaluate the script.
  • Scripts are evaluated dynamically. Therefore, including scripts in a user criteria can impact the performance of your system.
ActiveOption to activate or deactivate the user criteria.
CompaniesCompanies that the user record must match.
LocationsLocations that the user record must match.
DepartmentsDepartments that the user record must match.
Match All

Option to determine whether all elements from each populated user criteria field must match. If selected, only the users who match all user criteria are given access. If cleared, the user must meet one or more of the set user criteria to be given access. By default, this check box is cleared so that any condition met provides a match.

For example, consider a user criteria record for the following conditions:

  • Locations A or B
  • Company C or D With Match All selected, only the users who meet all of these conditions are matched. For example, a user with a location A and a company C.

If Match All isn’t selected, users who meet any of these conditions are matched. For example, a user with a location B.

Note: If you select Match All, ensure that you don't create contradictory conditions that can never be met. For example, if all users in location A work for company G, the conditions in this example can never be met.

  1. Select Submit.

What to do next

Now you can assign the user criteria to an OT knowledge base. For more information, see Assign the user criteria to an OT knowledge base.

Parent Topic:Configuring Operational Technology Knowledge Management