Purpose

To allow the maintenance of institution defined rules. In particular, to edit, add or delete rules.

Anticipated Frequency

As required

Admission Correspondence Rules

Unit Set Rules

Unit Version Rules

Progression Rules

System Rules

Enrolment sis-wide rules

Enrolment Message Rules

Course Stage Rules

Course Version Rules

Fee Disbursement Rules

Progression message Rules

This form is the generic form for editing, adding and deleting rules in Callista and can be accessed from a number of different forms in different Subsystems. The form is dynamically configured, depending on how it is accessed. The accessing forms determine;

• What rules can be added, edited or deleted
• Which field names appear in RULF2000
• Which rule options are available

  Note: when entering this form to edit a rule, and no current rule is selected, the various options are displayed automatically, once the cursor is placed in the rule text field.

Different Rules for Different Forms

Some rules are considered as general rules and accessed via RULF2001. The specialist user is able to edit or delete their rule description, as well as their rule text and/or comments in RULF2000. Other rules are required to be considered in context, for example unit version rules must be attached to a specific unit code and version. Specific rules can only be accessed via the relevant form (e.g. CRSF1700 for course version rules) and the specialist user is unable to change the rule description or comments, but can define the rule text in RULF2000.

Rules

Rules in Callista can provide a wide range of functionality including;

• Providing text for correspondence (dependent on parameters);
• Limit enrolment in units due to failure of pre-requisite units;
• Definition of unit sets (i.e. major and minor sequences)
• Definition of progress and completion (of course)
• Definition of cohorts of students

Rules Syntax

The rules syntax (or its available language), is made up of operators, parameters, functions and variables. These provide a range of tools for creation of rules. For a breakdown of the syntax for particular rules, see specialist links above.

Features of this form

Validation facility

This form includes a validation facility, which can be used to validate, and provide further options (The Options/Validate button). The available options displayed may be either the next logical operators, or instructions for entering of variables or successful/unsuccessful messages. Instructions are generally defined by the characters "***" displayed at the front and back of the instruction. If the rule is invalid, the validation facility breaks the rule i.e. text that fails to meet the logic of the rules syntax, is moved from the rule text box, and inserted in the Unprocessed field. The correct options are also displayed. Once corrections have been made to either the unprocessed text or the rule text fields, if the logic has been corrected, the text will be reinserted in the rule text area.

Saving Rules

When saving a rule, the form initially performs a validation of the rule text, to ensure that it satisfies the logical structure, as determined by the available syntax. If a rule fails the validation, the rule is not saved, and the validation facility breaks the rule i.e. text that fails to meet the logic of the rules syntax, is moved from the rule text box, and inserted in the Unprocessed field.

Finding variables

It is possible for RULF2000 to assist the rules writer by providing a list of variables that can be inserted. By typing in the first part of a variable and pressing the Options/Validate button, a list of variables that start with the entered text are displayed. If the number of found variables is excessive, a message is displayed indicating to enter more text to find. Once the desired list of variables is displayed in the Rule Option block, the find criteria (ie the text entered) is removed from the Rule Text block.

The Rule block contains (basic layout):

• Rule Group
• Rule Description
• Return Type
• Rule Text
• Unprocessed

Buttons

• Options/Validate
• Comments

The Rule Options block contains:

Button

• Add Rule

General Rules

Use this form to add, edit or delete rules.

On entering the form, using the Edit Rule button, the desired rule description appears.

On entering this form from another form via the Add Rule button, the desired rule group appears. Enter the rule description of the new rule.

Edit or create the rule directly by modifying the Rule Text, or use the Options/Validate button for available operators, parameters, functions or rules that are available. After the Options/Validate button is selected, the cursor returns to the Rule Text block.

To delete the rule, press the Delete button, and save the record.

Use the Rule Options button, to select a rule operator, parameter or rule. Alternatively, you can double click on the rule option text, or type the text in directly. When using the Rule Options button to insert a rule operator, the next options are automatically displayed.

Invalid rule text appears in the Unprocessed field.

To add a comment for the rule, press the Comments button, and enter the desired comments.

Rules:

When creating a general rule, the rule names must be unique and must not contain the character '#'.

STRINGS of text must be delimited by accent symbols (e.g. `text` ).

When using the rule options button, a space is entered after each entry. (care should be taken when selecting the ` character ie. if wishing to test against or insert a null string ie. `` )

Only valid rules can be saved.

Only rules that are not called by other rules may be deleted.

If deleting all rule text before saving, use the delete button on the menu rather than the backspace key.

When a rule option is selected the text in the rule text box is highlighted, so the immediate typing of a variable will override it. To avoid this, use the End key or the mouse to position the cursor at the end of the rule text before entering values for variables.

Specific Rules

Use this form to edit or delete rules.

On entering this form in context from another form via its Edit Rule button, the desired rule appears.

Edit the rule directly by modifying the Rule Text, or select from the Rule Options of available operators, parameters, functions or rules that display.

Use the Rule Options button, to select a rule operator, parameter or rule. Alternatively, double click on the rule option text, or type the text in directly. Where subsequent options are available, they will display automatically.

Invalid rule text, appears in the Unprocessed field.

Comments cannot be added or modified for these rules.

To delete a rule, select the rule text, select the delete record button. Save the record.