Residence Registration Rules {SMNT-19}

This option is used to define rules against which students will be tested during the iEnabler Residence Registration and iEnabler Residence Application.

Note that the Residence Registration / Movements {SREG-4}/{SRESIDE-50} and Residence Application and Admission {SNAPPA-2}/{SNAPPA-4}/{SRESIDE-10}/{SRESIDE-11} does not validate against the rules, Users need the flexability to enter the Residence they want.

To use this option the following must be in place:

Residences are Buildings {SPCS-4} defined with Aggregate Code equal to 9.

The individual Residence Rooms {SPOPS-1} must have a Space Use category between 1900 and 1999 and the number of stations must indicate the number of places in the room.

Campus code must be linked to offering type codes in {GCS-5}
Qualification codes must be correctly linked to Approved Qualification codes and Approved Qualification codes must be correctly linked to Qualification Types. Qualification and Approved Qualification codes are defined in {SACAD-13} and Qualification Types in {SCODE3-1}
Qualification Group code defined in {SRESIDE-4}

Both the Import and Export functionality are enabled in this option.

Fields in this option:

Block 1: Registration Rules

Before the user define the content of the rules in Block 1, the user must define active rules in block 2.

Most of the fields in Block 1 pertaining to data elements can be left blank. It simply means that the particular data element does not play a role when evaluating the student's attempt to register.

Field	Type & Length	Description
Acad Year	N4	Enter the Academic Year for which this rule will be valid. The LOV shows a distinct list of years from the Qualification definition in the Academic Structure.
Res Building	N4	Enter the Residence Building code. The LOV shows all building where the Aggregate Program is 9 and at least one venue in the building is linked to category 1900 to 1999 (excluding category 1919).
Rule Code	A4	Enter the Rule Code for the the Residence and year. Only active rule codes can be entered. If a record exists for a rule that has become inactive, the program will warn the user when a data element for the record is updated.
Seq	N4	With each Sequence a parameter set is defined for a rule. The sequence also determines the order in which the parameter sets will be applied for a rule.
Faculty	N4	Enter the Faculty for this rule and sequence.
Qual Type	N2	Enter the Qualification Type that will limit students for this rule. If a qualification code is already entered in the next field, the program will check that the qualification type matches the qualification type linked to the qualification.
Qualification Group	A6	Enter the Qualification Code defined in {SACAD-13} or the Qualification Group code defined in {SRESIDE-4} that will limit students for this rule. If a qualification type code is entered in the previous field, the program will check that the qualification type linked to the qualification matches the qualification type entered.
Gender	A1	Enter Gender 'F'-Female or 'M'-Male. This determines the gender of students allowed for this rule.
Camp	N2	Enter a Campus where the student's academic registration will be. If an Offering Type exists in the next field, the program will validate that the offering type is linked to the updated campus.
Off Type	A2	Enter an Offering Type that will be matched to the student's academic registration. If a campus were entered in the previous field, the program will check that the offering type is linked to the campus entered.
Grad Type	A1	Enter the Graduation Type allowed with this rule. Enter a 'U' for undergraduate and a 'P' for post graduates.
Int nat	A1	This field is used to indicate if only International students can comply with this rule or only National students. A 'Y' indicates that International Students are allowed and an 'N' indicates that National Students can register under this rule. To determine if a student is national or international, a SOD is defined in {SMNT-12}. This is SOD 'FS' for subsystem 'RR' its description is: "Enter the citizenship code that indicates National students". The user must enter a Citizenship code that will be deemed a National student.
Student Res Type	A1	Student Residence Type Values allowed: F - First Year Student (First time Academic and Residence Registration/Application) S - Senior Student (Do have previous Academic and Residence Registration/Application) O - Other Student (Do have previous Academic Registration/Application but first time Residence Registration/Application)
Stud Type	A2	Enter the Student Type that a student must have to register in the residence.
Start Age and End Age	N3	Enter the Start Age and End Age. The student's age should be between start and end ages,
Res Chang	A1	Enter 'Y' if the student can change Residence from one year to another, Enter 'N' if a change should stay in the same Residence from one year to another. Students can only move into a residence that is marked as 'Y'.
Use in iEnabler	A1	Should this rule be used in the iEnabler to limit the Residences the student can see? Y/N
Appl/Reg.	A1	Enter the process that the rule is applicable to: A - Application Rule R - Registration Rule Note: Normally an institution will use only Application Rules or Registration Rules not Both.

Example:

Block 2: Residence Rule Definition HERE

This block is used to define the rule codes that are used in the detail of block 1.

Field	Type & Length	Description
Rule Code	A4	Enter a code that will identify a Residence Registration Rule.
Description	A80	Enter a description for the Rule Code
Sequence	N4	Enter a sequence number for this rule. This number determines the sequence in which the rules will be applied to a student's Residence Registration
Active	A1	Enter a Y or N to indicate if the Rule Code is active. Only active Rule Codes can be used in block one. If, however, a record exists in block one and is made in-active in this block, the rule will not be applied when evaluating a student's registration in the residence.

Example:

Processing Rules
	This program does not preform any special processing rules. The following is a high level description of how the rules are applied in the iEnabler Residence Registration. The description is based on the data in the example above.
	The Residence Rules in block 2: The rules will be applied in the the sequence that they are linked All the rules are active and will be applied for every residence it is linked to.
	The Rule details: A single residence can be linked to multiple Rule Codes and each can have multiple data elements that should be tested Any value that is entered in the rule on block 1 will be use to see if the student comply with the rule before allowing the student to register, any field that is NULL(Blank) will be ignorred for the validation.

Processing
Rules

This program does not preform any special processing rules. The following is a high level description of how the rules are applied in the iEnabler Residence Registration. The description is based on the data in the example above.

The Residence Rules in block 2:

The rules will be applied in the the sequence that they are linked
All the rules are active and will be applied for every residence it is linked to.

The Rule details:

A single residence can be linked to multiple Rule Codes and each can have multiple data elements that should be tested

Any value that is entered in the rule on block 1 will be use to see if the student comply with the rule before allowing the student to register, any field that is NULL(Blank) will be ignorred for the validation.

Date	System Version	By Whom	Job	Description
12-Dec-2011	v01.0.0.0	Phlip Pretorius	T178744	Create manual.
14-Aug-2012	v02.0.0.0	Phlip Pretorius	T182048	Manual for INT2.0
23-Nov-2016	v03.0.0.0	Melanie Zeelie	T218273	Add additional explanation on sequence
25-Jul-2017	v03.0.0.1	Precious Diale	T221856	Remove reference to residence application and change image.
30-May-2018	v03.0.0.2	Bea Swart	T227737	Add new fields on block 1
15-Feb-2019	v04.1.0.0	Bea Swart	T232156	Copy manual from INT3