Graduation validation rules (i50pkg)

This package contains functions that are used to validate graduation applications in {STGRDOP-7}, identifiy possible graduates {STGRDOP-16} and identy actual graduates {STGRDOP-17}. The functions are linked to validation rules that are defined in {STGRDMN-3}. One function can be used for more than one validation rule where different parameter values are applicable. Validation is done against active rules only.

Most of the validation rules have parameters that users can use to link particular values for that parameter. These values are then compared with the applicant's value e.g.

A rule specifies that an applicant must have a particular certificate/indicator linked in {SREGB-8}
Parameter 1 of the rule indicates the set of possible certificate codes that will satisfy the requirement of the rule
The function linked to the rule will then check that any one of the values linked to the specific parameter of the rules matches that of the applicant.

The logic that will determine the outcome of a rule for a particular applicant is 'hard coded' in the function. A new rule can be defined and an existing function linked to the rule with different values for the different parameters. If a new function is linked to a new rule, users must remember that the logic for the rule must be programmed before the rule can be applied in the application validation process.

These validations have four possible outcomes:

'A' - Not applicable. This means that the rule does not apply to the particular application.
'D' - Data Problem. The function expects parameter values but it does not exist. Users must define the parameter values before the validation is done.
'N' - Not successful. The applicant did not comply with the requirements of the rule.
'Y' - Successful. The applicant complies with all the requirements of the rule.

Each of these functions first performs a check to determine if the parameters that it will be using have parameter values defined for those parameters where it expects values. If these values are not defined, it will stop the processing of that rule and return a 'D' value indicating that a data problem exists. The validation rule is deemed to be not successfully as the rule validation could not be completed.

When the validation action is started, a record for each active validation record is created for the application. The program to view the results is called from the graduation application program {STGRDOP-7}.

If the validations are done as 'Final Validations', and a route is defined for the rule, a work flow route will be started that will simply inform the responsible persons of the failure of an applicant of a specific rule. This is done by e-mail and it is of utmost importance that each person that is linked to a rule parameter that defines a route has an e-mail address in the personnel system.

With the install of Integrator 1, a pre-defined set of rules with parameters will be installed on the client's database. These rules can be set to active or in-active according to the institution's requirements.

These pre-defined functions linked to the default set of graduation application rules are described below:

Function Name/ Rule/ Detail displayed	Procedure	Rule Set up / Updates
CERTIFICATE Rule A1	Did the applicant presented specific required documentation? The function checks if the applicant is linked to the certificate values in parameter 1 in {SREGB-8}. If no records are found, the function sets the 'Success' field equal to 'Y' If all the records to which the applicant is linked, have the value 'Y' in the 'Seen' field, and the 'Expiry Date' is empty or greater that today's date the function sets the 'Success' field equal to 'Y', else the function sets the 'Success' field equal to 'N' If one of the certificates from parameter 1 that is linked to the applicant has the value 'N' in the 'Seen' field, the function sets the 'Success' field equal to 'N'.	{STGRDMN-3} List Required Documents
CERTPERQUAL Rule A2	Did the applicant presented specific required documentation? This function check if student has presented all required documents for awarding of a qualification If no records are found, the function sets the 'Success' field equal to 'Y' If all the records to which the applicant is linked, have the value 'Y' in the 'Seen' field, and the 'Expiry Date' is empty or greater that today's date the function sets the 'Success' field equal to 'Y', else the function sets the 'Success' field equal to 'N' If one of the certificates from parameter 1 that is linked to the applicant has the value 'N' in the 'Seen' field, the function sets the 'Success' field equal to 'N'.	{SSTUD3-4} Required certificates per Qualification
FEES Rule B1	Does the applicant have outstanding fees? The function checks if the applicant has outstanding fees > R100.00 for previous registrations.
SAMEQUAL Rule C1	Did the student change qualifications ? The function checks if the applicant had no qualification change. The check is done against the approved ID of the qualification. If the qualification code changed but the qualifications are all linked to the same approved ID , the student will pass the rule.
ALLEXEMPTIONS Rule D1	Did the student obtain less than the allowed 50% exemptions? Check percentage subject exemptions the student obtained for the listed exemption types If no records are found, the function sets the 'Success' field equal to 'Y' If a student has any exemption for the type specified and the number of subjects > 50%, the function sets the 'Success' field equal to 'N'.	{STGRDMN-3} List exemption types
EXITEXEMPTIONS Rule E1	Did the student obtain less than the allowed 50% exemptions in his final year? The function checks the percentage subject exemptions the student obtained for the exemption type defined in parameter 1 in his final year. If no records are found, the function sets the 'Success' field equal to 'Y' If a student has any exemption for the type specified and the number of subjects > 50%, the function sets the 'Success' field equal to 'N'.	{STGRDMN-3} List exemption types
STATBLOCK Rule F1	Does the student have status blocks? The function checks if the applicant status blocks as linked on {SREGL-2} or {FSAO-12} for the action codes listed If no records are found, the function sets the 'Success' field equal to 'Y' If any record which the applicant is linked to, has no end date or is linked to a status where the end date > that today's date the function sets the 'Success' field equal to 'N', else the function sets the 'Success' field equal to 'Y'.	{STGRDMN-3} List status codes
CREDITS Rule G1	Did the student obtain enough credits? The function checks if the student obtained enough credits for the type defined in parameter Values are 1 - Stats, - 2 - National or - 3 - Subject. The minimum number of credits is defined on the Qualification {SSTUD3-3} or Qualification Type on {SCODE3-1}.	{STGRDMN-3} Type of Credits 1-Stats {SACADO-17} Credit 2-National {SACADO-10} National Credit 3 {SACADO-10} Internal Credit
QUAL_GROUPS Rule GN	Are 3 level Curriculum groupe rules met? Check if the student passes all rules defined on {SACAD-40} for Qualification and offering type	{SACAD-40} Curriculum Group rules Possible credits (Assuming student passes all registered subjects) OR Actual result
SUBJMARKS Rule H1	Do all the subjects have final marks? The function checks that all marks for a student have been entered. Cancelled subjects are excluded.
MINREGPERIOD Rule I1	Did the student register for the required minimum period? The function checks that student was registered for minimum period entered for the Approved Qualification {SACADO-7}.
PASSALLSUBJFORQUAL Rule J1	Did the student obtain a result leading to a pass for all the compulsory subjects? The function checks if student passed all the compulsory subjects for the qualification as in the Curriculum {SACADO-17}.
CUMLAUDE Rule K1	Did the student obtain the required averages? The function checks if the student has passed his subjects as follows: An overall average for qualification > 75% for qualification types defined in parameter 1. All subjects passed first time (No re-exams, except special / sick exams) An average for Level 1 + Level 2 Subjects >= 75% . This refers to the study periods defined in parameter 2. An average for Final year Subjects >= 75% for the study periods defined in parameter 3.	{STGRDMN-3} Qualification Types to be Included in Cum Laude Test Subject Levels - Not Exit Level Subjects Subject Levels - Exit Level Subjects
DECEASED	Will the student receive the qualification Posthumous? The function checks if a deceased date exists on {SREGB-1}
Graduation_Pre_Requisite Rule M1	Was the student awarded a pre-requisite qualification? The function checks if the student was awarded a pre-requisite qualification. Used when parameter 'Check Graduation Pre-Requisite (Y)es / (N)o' is set to Yes	{SACADO-6} Prerequisite qualification {SSTURC-2} Check Graduation Pre-Requisite

History of Changes

Date	System Version	By Whom	Job	Description
22-Seo2010	v01.0.0.0	Melanie Zeelie	1t68478	New manual format.
07-Aug-2017	v04.0.0.0	Katlego Modikoe	t221154	Add function 'Graduation_Pre_Requisite'. Development was done on T206592
26-Jun-2019	v04.1.0.0	Frans Pelser	t237245	Update Academic Structure references
11-Aug-2022	v04.1.0.1	Esther Nel	t254204	Add rule GN