Resetting a Learner's Curriculum Version/User Tree

The curriculum tags connected to an individual learner are stored in a user tree. Especially in the context of programs using a Royal College structure, there can be circumstances where an administrator needs to reset a user tree. For example,

  • if learner stages weren't correctly set before a curriculum was versioned,

  • if learners were not set as CBME enabled on a course enrolment tab before a curriculum was versioned,

  • if a competency committee decides to modify the version of curriculum a learner needs to complete for a specific stage.

For existing schools using CBE and a Royal College curriculum framework, the option to modify a User Tree through the user interface replaces the previous work developers had to do to manually adjust a learner's curriculum version if a mistake was made in promoting them or otherwise.

For schools using CBE who do not use a RC curriculum framework, if you version your curriculum, you will be required to manually reset the user trees for all learners to move them forward to the new curriculum version.

To effectively modify a user tree an administrator needs to know:

  • which learner to use

  • which curriculum version is applicable to the learner

    • in the context of Royal College programs, you need to know which curriculum version is applicable to which stage of training

After an administrator has reset a user tree, the version badge on a learner dashboard may take some time to update. It relies on a behind the scenes task which at most schools happens once a night; if you wish to see immediate changes to the version badge on the learner dashboard, you'll need a developer to run the cbme-learner-dashboard-statistics-generator cron job for you.

To reset a user tree:

  • Navigate to the CBME tab of a program.

  • Click Configure CBME.

  • From the Actions dropdown, select Modify User-Tree Versions.

  • Select a learner (or multiple if applicable).

  • The Tree ID will be pre-populated based on the course/program you are working in. This is presented for information only.

  • Under Reset Mode, make a selection.

    • Override user tree(s) with a specific version

      • Use this option if your curriculum framework does not include stages of progress and you need to assign a complete new curriculum version to a user.

      • For most organizations using their own curriculum framework (not Royal College structure), learner are locked onto a full version of a curriculum and DO NOT automatically get pushed to a new version once one is published.

        • Click Next.

        • Select a curriculum version.

        • Click Set user tree version.

        • You will get a success message and see a list of users who were migrated.

        • Click Reset another tree or click on another tab to move to another task.

    • Build useable tree from versionable root

      • Use this option if you use a Royal College curriculum framework and need to assign different curriculum versions to different learner stages.

      • For each version and each stage, indicate if the version should be included or excluded in the user tree. For example, in a Royal College framework you could indicate that stages D and F should be on Version 1 and stages C and P should be on Version 2.

        • Click Next.

        • Click to include or exclude each version within each stage (for RC programs).

        • Click Submit branch modifiers.

        • You will get a success message and a view of the resulting user tree.

        • Click Reset another tree or click on another tab to move to another task.