Auto Progression functions (i8cpkg)

This package contains the rules and functions that are used in the Auto progression process (PROG).


The functions are linked to Auto progression stage rules that are defined in {SSTUDP-15}.
One function can be used for more than 1 progression stage rule where different parameter values are applicable.
The functions defined in the Auto progression process are executed in {SSTUDP-17}.

Progression stage rules may have parameters used to link specific values to a parameter. These values are compared to the corresponding value for the student.
The logic that will determine the outcome of a rule is hard coded into 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.

Validations have four possible outcomes. A Data Problem (D) or Not successful (N) outcome will result in a ‘failed’ rule outcome.
Function Name/
Rule/
Detail displayed
Procedure Rule Set up /
Updates
VALIDATIONMAINFUNCTION Manage the processing of all active auto progression stage rules

This function manages the processing of all active auto progression stage rules as defined in {SSTUDP-15} and linked to active stages of the PROG process in {SSTUDP-16}. It performs the following actions for each rule for the student being processed:
  • Check if the rule set up was done
  • Each rule will be evaluated for the student against values indicated in the Set up for the rule.
  • The outcome of each rule evaluated and associated detail is displayed in {SSTUDP-18}.


{SSTUDP-15} Auto Progression Stage Rules
{SSTUDP-16} Link Auto Progression Stage Rules
Pre-Progression (PPRO) rules generally indicate if a student should be evaluated (Y) or not (N)
CHK_NO_RETURN_RES
Rule  Z490
  • Result Success
  • Annual Result
  • SQLERRM
Check for Non-Returner annual result. (This rule is used by Te Kura.)

If the Annual Result of the student is listed as a non-returner result in {GOPS-21} Internal Code
  • If true, set Result Success  to Not successful (N)
  • if not true, set Result Success to Successful (Y)
 

{GOPS-21} Insert annual results that are defined as a non-returner result into
  • External Body = MOE
  • External Code Type = PS1
  • Internal code = annual result
RESULT_PASS_FAIL
Rule Z491
  • Result Success
  • Annual Result
  • SQLERRM
Check for Fail annual result

If the Annual Result of the student leads to a Fail on {SCODE-23} Pass/Fail
  • If true, set  Result Success  to Not successful (N)
  • If not true, set Result Success to Successful (Y)


{SCODE-23} Pass/Fail
Progression Validation (PVAL) rules generally determine if a student can progress to a next study period. 
PROG_VALIDATIONS
Rule  Z604
  • Result Success
  • SQLERRM
Progression Validations {SSTUDP-12}

Perform Progression Validations that evaluates all active rules for the student that are linked  to process=PRGV and stage=PRGV on {SSTUDP-11}
  •  If the process did not complete successfully, set Result Success  to Not Successful (N)
  • If the process completed successfully, check if any of the rules failed
    •   If all rules passed, set Result Success to Successful (Y)
    •   If any rule failed, set Result Success to Not successful (N)


{SSTUDP-11} Link Progression Validation Rules
{SSTUDP-10} Progression Validation Rules
SET_NP_RESULT
Rule  Z600
  • Result Success
  • Validation Rule Failed
  • SQLERRM
Set No Progress annual result.

If the student failed one of the progression validation rules,
  • If true, set the Annual Result of the student enrolment to No Progress Result (Parameter 1 of rule Z600)
  • Otherwise set Result Success to Successful (Y)


{SSTUDP-15} Rule  Z600 No Progress Result

Update:
{SSTUDA-1} Annual Result


Progression Path (POUT) rules generally indicate how the application should be processed.
RESULT_PROG_PATH
Rule  Z602
  • New Qualification
  • New Study Period
  • SQLERRM

Get Progression Path from Annual Result

Get the progression information using the annual result from {SCODE-23}
  • If the Application Qualification Indicator is
    •  Different (D), get the New Qualification from {SACADO-6} pre-requisites where the Involved Qualification is same as the current enrolment Qualification and Academic Year we are progressing to.
    •  Same (S or NULL) the New Qualification remains the same as the current enrolment Qualification. 
  •  If the Application Study Period Indicator is
    • Same (S or NULL) and Pass/Fail is set to fail, the New Study Period
      is set to to the current study period.
    • Next (N or NULL) and Pass/Fail is set to Pass, the New Study Period is determined from {SCODE-30}.



{SCODE-23} Application Qualification Indicator, Application Study Period Indicator, Pass/Fail

{SCODE-30} Period of Study and Previous Period of Study

{SACADO-6} Prerequisite Qualification and Involved Qualification
CREATE_APPLICATION
Rule Z603

  •  Qualification status (only available in SQL)
  •  Subject and Qualification info (only available in SQL)
  •  Subject and Qualification info
  •  Error/warning information from student Application module 

Create application
  • Get  the information needed to create (qualification) application for the new qualification and study period for the next application choice.
  • Get the information needed to create  planned subjects-not passed subjects (mains) from previous year
  • Validate that these subjects are active
  •  when there are active planned subjects to create      
  •  Get the information needed to create more planned subjects-not passed subject-not passed subjects (modules linked to the mains) from previous year      
  • Validate that these subject are active
  • Validate that these subject were not passed in other years
  • Validate that these subject are still valid modules
  • use the student Application module to create the application and any valid planned subject identified


Update:
{SNAPPA-1} Admit Status
{SNAPPA-11} Planned Subjects
CANCEL_EXTRA_IER
Rule Z605
  • Results Success
  • SQLERRM
Cancel extra application

Determine if there is an application to cancel:
  • The qualification, offering type and block code must be the same as values of the current application
  • The application choice must be less than the choice used to create the current application
  • The study period must NOT be the same as the study period of the current application
If there is no application to cancel, set Results Success  to  Not applicable (A)

If there is an application to cancel
  • Clear Admit Status (NULL)
  • Set cancellation date to SYSDATE
  • Set Cancellation Reason to SOD CA, subsystem SR, defined on {SMNT-12}
  • Log the transaction with program number 116
  • Cancel the planned subjects linked to the cancelled application in the same way.
  • Set Result Success  to Successful (Y)


{SMNT-12} SOD CA,/SR Cancellation Reason

Update:
{SNAPPA-1} Admit Status
SET_APL_STATUS
Rule Z606

  • Admit Status
  • Quota available
  • SQLERRMSG

Set Application Status

If the student had a failed result, use event P3 to determine the Admit Status.

If the student had a pass result
  • If {SMNT-1} QU validation determines that the Quota should not be checked, use event P1 to determine the  Admit Status.
  •  If {SMNT-1} QU validation determines that the Quota should checked:
    • If the Quota is not set up, use event P2 to determine the Admit Status
    • If the Quota is setup, use the Quota and Number_of_admitted_application to determine if there are any quota left/available.
      • If there is no quota available, use event P2 to determine the Admit Status
      • If there is quota available, use event P1 to determine the Admit Status

  • Set the Admit Status of the Application
  • Set the Admit Status of the planned subjects (if any)
    {SMNT-1} validation QU to determine if the Quota should be checked

    {SCODE-23} Pass/Fail

    {SACADO-5} Quota

    {SCAO1-6} Admit Status for Event
    • P1 Progress: With Admission
    • P2 Progress: Waitlisted
    • P3 Progress: No Admission

    Update:
    {SNAPPA-1} Admit Status

    See also:
     
    History of Changes

    Date System Version By Whom Job Description
    07-Jul-2020
    v04.1.0.0
    Rofhiwa Nemauluma
    T243997
    New Manual
    28-Jun-2022 v04.1.0.1 Esther Nel
    T254589
    Expand manual