Skip to end of banner
Go to start of banner

Registration Rule Matrix and Registration Rule Generator

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current Restore this Version View Version History

« Previous Version 11 Next »

Introduction

This document describes the processes how registration rules are generated and updated using the Registration Rule Matrix (RRM) and Registration Rule Generator (RRG) DOS prompt tool.

For every customer we should have one RRM which is the truth and applied to the LMS. Maintain the files within the Professional Services Google Drive folder of every customer (https://drive.google.com/drive/folders/0B7g9LwWIoQa2Vnlacmhobk1xRjQ). Some customers will have slightly different workflows on where the RRM file is being maintained (i.e. a shared drive the customer provides) and how they update/add courses. The section Offering Rule Matrix and Offering Rule Generator#Customer Specific Processes below describes any customer specific requirements.

Preliminary Workflow to Create Registration Rules

  1. The customer would get a pre-filled RRM (courses/OrgProfileField values) where they are able to tick all the requirements for their courses
    1. Preferably, we would fill in the course paths ahead of sending the file to the customer rather than let the customer fill in courses. The customer would only need to tick the OrgProfile values for the courses and decide on de-/re-registration/expiry periods,...
  2. We will double check the validity of the returned RRM
  3. Generate the registration rules using the RRG
  4. Upload/replace all registration rules with the freshly generated reg rules
  5. Upload the RRM file to Google Drive location (and possibly to the customer as a reference)

Handle PDR Registration Rules

Currently, we have 'manual' registration rules - generated by the PDR generator - for all PDRs. PDRs won't be part of any RRM for now and any new PDR upload will contain a somewhat manual process to crafting the rules.

Update Registration Rules

If a customer needs to add/update registration rule requirements for courses we have 2 proposals at the moment
  • Send the full RRM to the customer
  • Send a partial RRM which only contains the new courses/courses they need to update. Because of the amount of courses some customers have, this may make it easier for the customer and us to manage the changes

Generate Registration Rules via RRG Tool

TODO: add full manual on how to use/where to get the RRG tool.

Replace/Upload Registration Rules in LMS

TODO: add full manual on how to replace/upload registration rules created by the RRG.


Since release v3.0.5+ any updated registration rule needs to be run manually to bring the rule engine up to date. The rules need to be run because rule changes/invalidate the ‘from’ date that the new rule engine uses internally to scan for changes. If you just let the engine run normally after rule updates it might miss people who are: (a) affected by the new rule, and (b) have not changed since the internal from date the engine records.

There are command lines to run the rules only for specific courses, so if you have only changed the rules for a small set you can just run the rules for those (i.e. reEvaluateOfferingRulesByCoursePathMatch (-logOnly, -debug) [RuleType (Registration, Instructor, All)] [string: startPath] [string: terminalElement] [batchSize: optional, default Core.OfferingRuleEvaluatorBatchSize])

The rule engine doesn’t care that the attributes have been updated (i.e. by the rule generator) and doesn’t make any attempt to determine if rules have changed. So its up to a human in this case to decide what rules have changed semantically and ensure to manually run the rules for those courses.

Before updating any registration rule the rule engine needs to be paused.

Commands to pause/continue/check status of the automatic registration rule processing:

  • PauseAutomaticOfferingRuleProcessing

  • getOfferingRuleStatus

  • ContinueAutomaticOfferingRuleProcessing


 

Customer Specific Processes

Some customers will have certain workflows how the RRM will be updated and where the file will be maintained. This section contains a list and description of the common process for customers.

Moran Tug

Maintain the up to date RRM file on their shared OneDrive: https://morantug-my.sharepoint.com/:f:/p/louisew/ElaWorMNr_9FkAfKd4mu6LoBfqE4pwv-8hT8p4WE0i_D8g?e=5%3ab6a80c75e1bf4883bed19030ccb784c5

Login as support@marinels.com.

New Courses

Provide Moran with an empty RRM (found here: TBD) whenever they need to add new courses. We will check correctness and add the courses to the full RRM on their OneDrive.

Update Existing Courses

Moran will use the full RRM to update any existing courses. After the changes we will check correctness and upload the new registration rules to the LMS.

Related articles

Filter by label

There are no items with the selected labels at this time.