Top of RUL

Index

Table of Contents

Feedback

Understanding Rules

This section of Online Help provides an overview of the Rules subsystem. Topics covered include:

• What the Rules Subsystem Does
• Rules Configuration
• Terms Used in the Rules Subsystem
• How the Rules Subsystem is Used, Including;
• User Responsibilities
• All About Rule Syntax
• Rule Operators
• Rule Parameters or Functions
• Rule Variables
• Rules for Unit Versions
• Rules for Unit Sets
• Rules for Course Versions
• Rules for Course Stages
• Completion Rules
• Completion Message Rules
• Rules for the Progression Subsystem
• Rules for Admission Correspondence
• Rules for Fee Disbursement
• Rules for Finance
  • Tax/Loan Rules
• Enrolment Message Rules
• Enrolment SYS-WIDE Rules
• Progression Message Rule
• System Rules
• Cohort Rules
• Scholarship Rules

Detailed explanations and instructions for the use of rules can be accessed from the Subsystem's Table of Contents or via the numerous links provided here.

What the Rules Subsystem Does

The Rules Subsystem is used to manage the available rules for Callista, including

• The viewing of rules
• The creation of new rules
• The editing of rules
• The deletion of rules
• The editing of rule messages

Rules Configuration

RULF3000 is used to control the types of Rules that a particular User Role can be edit.

RULF0100 is used to set whether a colon or a full stop (period) is used to separate Course/Unit Codes from version numbers when creating rules.

Terms Used in the Rules Subsystem

To understand the Rules Subsystem it is necessary to understand the following key terms.

How the Rules Subsystem is Used:

User Responsibilities

Each institution will determine how the rules Subsystem is applied to its own business practices. As a guide, 'non-specialist functions' are limited to modification of rules that return type of STRING.

The remaining functionality is normally used by Subsystem specialists or System Administrators. This functionality includes:

• Creation and modification of rules
• Deletion of rules

All About Rule Syntax

Rules syntax is the available components of language, and their structure that are available for any particular rule. The components and structure are determined dynamically within Callista and are dependent upon either the rule subgroup or the rule description.

Rule Operators

Using -AND- and -OR- Rule Operators
If complex rules are created using AND/OR logic, it is recommended that the -AND- and -OR- (High Level Logical) options are used rather than the standard AND and OR operators.
e.g. Must be enrolled in at least 4 units in course teaching period(s) { SEM-1 } -AND- (Must be enrolled in at least 4 units in course teaching period(s) { SEM-2 } -OR- Must be enrolled in at least 4 units in course teaching period(s) { SEM-2 })
The use of the -AND- and -OR- options eliminates 'out of context messages' that may appear when using AND and OR.

 Rule Parameters or Functions

In general, parameters and functions can be considered as one and the same. This is because often, functions (other rules) will return values to the calling rule.

Rule Variables

Rules for Unit Versions

Rules for Unit Versions are unique to the Unit Code and Version number. The rule description determines the available syntax that is available, and returns BOOLEAN to Callista i.e. returns true or false. The unit version rules are used to determine conditions that must be met prior to enrolment in a unit. Unit Version rules are viewed via CRSF2700. For the available syntax, see Unit Version Rules.

Rules for Unit Sets

Rules for Unit Sets are unique to the Unit Set Code and Version number. The rule description determines the available syntax that is available, and returns BOOLEAN to Callista (i.e. returns true or false). The unit set rules are used to determine conditions that must be satisfied prior to enrolment in a unit set, or whether the completion requirements of the unit set have been satisfied. Unit Set rules are viewed via CRSF4230. For the available syntax, see Unit Set Rules.

Rules for Course Versions

Rules for Course Versions are unique to the Course Code and Version number. The rule description determines the available syntax that is available, and returns BOOLEAN to Callista i.e. returns true or false. The Course Version rules are used to determine whether or not the requirements of the course have been satisfied; whether the course requirements for an honours level have been met; to derive the commencing student indicator for the statistics Subsystem. Course Version rules are viewed via CRSF1700. For the available syntax, see Course Version Rules.

Rules for Course Stages

Rules for Course Stages are unique to the course code, version number, and course stage type. The rule description determines the available syntax that is available, and returns BOOLEAN to Callista i.e. returns true or false. The course stage rules are used to determine whether or not the requirements for a stage of a course have been met. Course Stage rules are viewed via CRSF12D0. For the available syntax, see Course Stage Rules.

Completion Rules

Completion rules can be created at any of three levels in the course structure — Unit Set; Course Stage; Course Version. Refer to the sections above for a broad outline of rules that apply to each level of the course structure and a link to the relevant syntax documentation. For an overview of the concepts behind constructing and applying completion rules, see Completion Rules Overview.

Completion Message Rules

These rules are used to create the messages displayed in PRGF9030 when a student's potential completion of a course, course stage, alternative exit or unit set is tested. Completion message rules can be viewed in RULF2001. A standard set of message rules is supplied with Callista but these can be added to or modified. For available syntax and further information see Completion Message Rules. 

Rules for the Progression Subsystem

Concepts relating to the construction and use of progression rules are described in the Progression Rules Overview. For available syntax, see Progression Rules.

Rules for the Admission Correspondence Subsystem

Rules for the Admission Correspondence Subsystem are grouped into four distinct sub groups. These sub groups determine the syntax that is available, and return STRING (e.g. `This is a string!`) to Callista. The rules are used to create text that can be inserted into a word template for an acknowledgment or outcome letter. Admission Correspondence rules are viewed via RULF2001. For the available syntax and the list of released rules, see Admission Rules.

Rules for Fee Disbursement

Rules for fee disbursements are unique to the Fee Type, Calendar Type and Fee Disbursement Formula number. The rule description determines the syntax that is available, and returns BOOLEAN to Callista i.e. returns true or false. The fee disbursement rules are used to determine whether or not a fee disbursement formula applies to a student and/or a course. Fee Disbursement rules are viewed via FINF7240. For the available syntax, see Fee Disbursement Rules.

Rules for Finance

Rules for the Student Finance Subsystem are grouped into one distinct sub group. This sub group determines the syntax that is available, and returns NUMBER (e.g. 99 ) to Callista. The rules are used to calculate the fee liability for a student. Finance rules are viewed via RULF2001. For the available syntax, see Finance Rules.

Tax/Loan Rules