Introduction

This document describes and sub-documents describe the processes how registration rules offering rules (for registrations and instructors) are generated and updated using the Registration Offering Rule Matrix (RRMaka Registration Rule Generator) and the Offering Rule Generator (aka 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. in combination with the Core client command GetOfferingRuleMatrix.

The Offering Rule Matrix is usually extracted with the Core client command GetOfferingRuleMatrix before any changes are made to the existing rules. This ensures an accurate picture of what is in the system before any change is made. The section Customer Specific Processes below describes any customer specific requirements.

...

Workflow to Create

...

and Update Offering Rules

1. The customer would get a pre-filled

   RRM

   Offering Rule Matrix (with courses

   /

   and 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

Customer Specific Processes

...

1. which has been extracted from the LMS via Core command GetOfferingRuleMatrix

   • The Offering Rule Matrix can be split into sub-matrices so only a portion of the courses' offering rules are replaced.
     Important: if a course has multiple rules a sub-matrix must contain all rules for that course - rules for one course can’t be split across multiple sub-matrices (this is automatically considered by the Core command GetOfferingRuleMatrix).

2. Generate the offering rules (either instructor or registrations) using the Offering Rule Generator

3. Pause the offering rule background thread via command PauseAutomaticOfferingRuleProcessing. Check the status of the background thread with the command GetOfferingRuleStatus to make sure the thread is paused and not in the middle of processing. It may take a bit to finish if the background thread is paused in the middle of processing.

4. Remove previous offering rules for courses (the commands to remove offering rules is created by the Offering Rule Generator) by executing the commands provided by the Offering Rule Generator

5. Add new offering rules - commands created by the Offering Rule Generator
   Note: The commands to add new offering rules automatically checks if the OPF single choice values exist

6. Re-evaluate the rules for courses for which the rules have been changed (student and/or instructor) via command ReEvaluateOfferingRulesByCoursePathMatch (task 

   Jira Legacy
   server System JIRA serverId 23f523ea-1678-3ca2-a1e8-2de53fd3b74a key PSDEV-760

    will add the proper commands to the output file of the Offering Rule Generator)
   Note: while re-evaluation is being executed you can check the progress of the re-eval command by executing GetOfferingRuleStatus in a new pages/dev client window.

7. Continue rule background thread via command ContinueAutomaticOfferingRuleProcessing once all re-eval commands have finished.

8. Check the that the background thread is not paused anymore with GetOfferingRuleStatus

Offering Rule Matrix (general information)

The Offering Rule Matrix (aka Registration Rule Matrix) is a csv representation of registration and instructor rules for courses. The instructor and registration rules matrix’s format are slightly different.

In general, one column determines one rule for a course. Multiple columns for the same course are allowed - a user gets registered/added as instructor if at least one rule applies to the user.

The offering rule matrix may change over time/LMS versions as the offering rules' capabilities are being extended. Please refer to the corresponding LMS version in sub documents for format references.

Rows specify the requirements for a user to get registered/added as instructor.

De-Registration and Remove Instructor Rules

Offering rules are able to add registrations for users or add the user as instructor. You can also specify offering rules to remove registrations or instructors from a course, as soon as the offering rule requirements doesn’t apply for a user anymore (i.e. due to a vessel change). The matrix usually contains a row similar to De-Registration or Remove Instructor. Adding an 'x' in this row and course (column) will add de-registration/remove instructor rules.

Multiple columns for one course must have all the same value - either an ‘x' or nothing. Multiple offering rules for the same course can’t be mixed.

OPFs as Offering Rule Requirement

Org Profile Fields (OPFs) and values can be specified as offering rule requirement as well. An ‘x' in a course column and OPF value row specifies that a user requires that OPF value in order to get registered. ‘!x' specifies that a user gets registered/added as instructor if they DON’T have that specific value - see Invert OPF Selection for more details on '!'.

Invert OPF Selection

If you need the opposite of an OPF value as registration/instructor requirement you can invert the selected OPF value. In order to do that we use the Boolean NOT character '!' in front of 'x'.
OPF values selections can be marked with an ‘x' or ‘!x' (for the inverse) for a course (column). Selected values of one OPF name must have either all ‘x' or all '!x' within one course. You can't have a mix of 'x' and '!x' in one column within one OPF name. The Offering Rule Generator will throw an exception if '!x' and 'x' are mixed within one column and OPF name.

Example

For example, if all users should be registered who are NOT assigned to Vessel: Shore use '!x' for OPF value Shore. This will result in a simpler offering rule which uses !ProfileValueIn(Vessel,Shore) instead of ProfileValueIn(Vessel,[list all vessels])

Registration Rule Matrix

Instructor Rule Matrix

Example Offering Rule Matrices

Get Offering Rule Matrix via GetOfferingRuleMatrix (general information)

The command GetOfferingRuleMatrix is able to extract registration/instructor rules into an Offering Rule Matrix (csv format) accepted by the Offering Rule Generator and makes it easy to update any rules.

Limitations for GetOfferingRuleMatrix

All limitations for the client command also apply to the Offering Rule Generator:

• some rule predicates are not supported and can't be extracted. If a rule does contain one of those not (yet) supported predicates it will list them in the command output

• Manual rules are not included in the matrix - in order to include in the matrix the rule needs to be marked as AUTO

• De-registration rules are interpreted as inverts of registration rules. Therefore, asymmetric registration/de-registration rules pair will loose the asymmetry, using the registration rule as truth. 

Offering Rule Generator (general information)

The Offering Rule Generator (aka Registration Rule Generator) creates LMS Core commands to replace and add new offering rules based on an Offering Rule Matrix. The DOS prompt tool input can be the old (deprecated) or new transposed (preferred) format of an Offering Rule Matrix. The tool generates LMS Core client commands to remove any old registration/instructor rules for which the Offering Rule Matrix has a course for and commands to add the new registration/instructor rules.
The Offering Rule Generator tool itself can be found attached to the sub-document with the proper version. Unzip the latest version to a local folder and run DOS prompt (Ctrl+R, type 'cmd' and hit enter).

Customer Specific Processes (deprecated?)

Some customers will have certain workflows how the Offering Rule Matrix will be updated. This section contains a list and description of the common process for customers.

Moran Tug

Maintain the up to date RRM Moran Tug usually provides an updated Offering Rule Matrix file on their shared OneDrive: https://morantug-my.sharepoint.com/:f:/p/louisew/ElaWorMNr_9FkAfKd4mu6LoBfqE4pwv-8hT8p4WE0i_D8gEiPxFVLmbhlBlo4XITf3dhcB_ZrEtzDsriaCGiVRMDBiMg?e=5%3aTmOPYT&at=5%3ab6a80c75e1bf4883bed19030ccb784c59

Login as support@marinels.com.

New Courses

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

Update Existing Courses

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

Related articles

...