Purpose

To add, edit or delete Rules.

Anticipated Frequency

As required

Admission Correspondence Rules

Unit Set Rules

Unit Version Rules

Progression Rules

System Rules

Enrolment sis-wide rules

Cohort Rules

Enrolment Message Rules

Course Stage Rules

Course Version Rules

Finance Rules syntax

Fee Disbursement Rules

Progression Message Rules

Completion Message Rules

This form is the generic form for adding, editing and deleting Rules in Callista, and can be accessed from a number of different Forms in different subsystems. You cannot access RULF2000 directly from the Callista menu.

This form is dynamically configured, depending on how it is accessed. The process of accessing Forms determines the context of the Rule and the options available.

General and Specific Rules

• General rules are accessed via RULF2001. The specialist user is able to add, edit or delete a Rule Description, as well as Rule Text and/or Comments in RULF2000.
• Specific rules are considered in context, for example unit version rules must be attached to a specific unit code and version. Specific rules are only accessible from the relevant form (for example, CRSF1700 for course version rules, CRSF2700 for unit rules, and CRSF4230 for unit set rules) and the specialist user is unable to change the Rule Description or Comments; but can define the Rule Text in RULF2000.

For more information about General and Specific Rules, see Understanding Rules.

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 prerequisite 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 (i.e. the text entered) is removed from the Rule Text block.

Separating Course/Unit Codes from Versions

Depending upon the setting in RULF0100, a full stop or a colon will be available to define Course/Unit versions in Rules.

Rule block:

• Rule Group
• Rule Description
• Return Type
• Rule Text
• Unprocessed
• Comments (overlay field)
• Plain Rule Text (overlay field)

Buttons

• Options/Validate
• Plain Rule Text
• Comments

Rule Options block:

• Rule Options (multiple rows displayed)
• Rule Options Description

Icon

• Add Rule

Rules/Notes:

'Rule Group' appears only when entering this form from another form via the Add Rule button.

The 'Plain Rule Text' field is accessed via the Plain Rule Text button (see below). It is used to display 'Plain Rule Text' that was added in Proposals (PAAW1100) and transferred (along with its associated rule) to this form via the relevant Proposal Transfer job. (This field is equivalent to the 'English Rule Text' field displayed in the Rules section (see RULW2000) of a Proposal.) Plain Rule Text transferred to this field is editable.

The Plain Rule Text field can also be used to add a description (in 'plain English') for a rule created in this form (RULF2000); however, the rule (Rule Text) must be defined first before the Plain Rule Text field is made available.

Invalid Rule Text appears in the Unprocessed field.

The Plain Rule Text button displays the Plain Rule Text overlay field in which you can add or edit a 'plain English' description for a rule. it is only available when accessing this form from 'Maintain Course Rules' (CRSF1700), 'Maintain Unit Version Rules' (CRSF2700) or 'Define Unit Set Rules' CRSF4230, and a corresponding rule (i.e. Rule Text) exists.

The 'Rule Options Description' displays for a selected Rule Option.

General Rules can be added, edited or deleted in this form.

On entering the form via RULF2001.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.

To Edit or Create a Rule:

1. Edit or create the Rule directly by modifying the Rule Text, or by using the Options/Validate button for available operators, parameters, functions or rules that are available.

2. After the Options/Validate button is selected, the cursor returns to the Rule Text block.

To Insert a Rule Operator:

1. Use the Rule Options icon (located in the Rule Options block) to select a Rule operator, parameter or rule. Alternatively, you can double click on the Rule Option text, or type the text directly into the Rule Text field.
When using the Rule Options icon to insert a Rule operator, the next options are automatically displayed.

Invalid Rule Text appears in the Unprocessed field.

To Add a Comment for a Rule:

1. Click the Comments button, and enter the desired comments.

To Delete a Rule:

1. Click the Delete Record button, and save the record.

Rules/Notes:

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 (for example. `text` ).

When using the Rule Options icon, a space is entered after each entry. (Care should be taken when selecting the ` character, i.e. if wishing to test against or insert a null string, i.e. `` )

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 field 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 can be edited or deleted in this form.

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

To Edit a Rule:

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

2. Use the Rule Options icon (located in the Rule Options block), 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.

Note: Comments cannot be added or modified for these Rules.

To Delete a Rule:

1. Select the Rule Text, then select the Delete Record button on the menu bar. Save the record.

Rules/Notes: