About training rules

With the training rules, you can determine the scope of your training. This means that you determine the training content (pages), the trainees (users) and the circumstances under which the users are assigned to train on pages.

Location

You can configure your rules in: Confluence administrationGeneral configurationRADBEERead & Understood Training Genius for Confluence settings.

You can see the rules in the Filter field, but you can't edit them there. First you have to export them to a text file, which should have a ".rules" extension. You can open this file with any text editor to make the changes.

JSON structure

The rules for the Radbee app are written in JSON and are simple to use. It all starts with the root element rules inside of which you always define four parts:

  • "name": This element is purely for identifying purposes. Its value should be a string.

  • "pageFilter": This element defines which pages are considered training pages.
  • "userFilter": This element defines which users are required to complete the training.
  • "ruleTypes": This element defines how often or under which circumstances the training should occur.

Example

{
    "rules": [
        {
            "name": "Default rule",
            "pageFilter": {
                "type": "PAGE_SPACE_KEY",
                "value": "Documents"
            },
            "userFilter": {
                "type": "USER_GROUP",
                "value": "training_group"
            },
            "ruleTypes": {
                "ruleType": "NOT_TRAINED_PAGE_VERSION"
            }
        }
    ]
}


You can use multiple rule sets within the same "rules" root element. This way you can make different rules for multiple spaces on your Confluence and/or notify a different group of users each time.

Just make sure to give each rule a unique name so you can tell the difference at a glance.