Top of RUL Index Table of Contents Feedback

Rules - RULW2000

Table of Contents

Overview

Use this page to assemble a rule. It performs the same function as the Maintain Rule (RULF2000) form in Foms.

The Rule Type, whose Rule button was selected in the Create Rule page (in PAAW1100), determines the Rule Operators that are available for the rule.

Rules added in Proposals do not have affect until they are transferred to RULF2000 in the Course Structure and Planning subsystem. Course version, unit set and unit version rules captured in this page are transferred to the Course Structure and Planning subsystem (i.e. CRSF1700, CRSF4230 and CRSF2700 respectively) via the Approved Course Transfer (CRSJ6010), Approved Unit Set Transfer (CRSJ6020) and Approved Unit Transfer (CRSJ6000) jobs.
Rules captured in RULF2000 in SMS Forms are transferred to Proposals (via the import package PAAK_GET_FULL_PROP_INST) only in the case where a new course, unit set or unit Proposal is created in Proposals based on an existing course version, unit set version or unit version.

This page will open as a pop-up with the appropriate operators available for rule creation.

Return to Top

Navigation

This page is invoked from the PAAW1100 page via the Rule button in the Rule Creation section.

Save or cancel the record to return to the previous page.

Return to Top

Field Descriptions

The following table describes each field on the RULW2000 page, including applicable Table values.

Note: Field labels are institution-configurable.

Field: Description:
Context block:  
Proposal ID
or
Unit Code
or
Unit Set Code

Displays the context Unit Version and Short Title if the Unit Code and Version Number are available. If not, displays the context Proposal ID and Name.

Table value:
[This value is derived.]

Rule Description

Displays the context Rule Description (i.e. Rule Type).

The Rule Description determines the syntax that is available.

Table value:
PROPOSAL_INSTANCE_ITEM.RULE_DESCRIPTION
Return Type

Displays the type of result that the context Rule can return, for example, BOOLEAN, i.e. true or false.


Table value:
PROPOSAL_INSTANCE_ITEM.S_RETURN_TYPE
Plain Rule Text

Displays the 'plain English' description of the context Rule, as recorded in the 'English Rule Text' field in the Rules section of PAAW1100; or in the 'Plain Tule Text' field in RULF2000 in the case where a new course, unit set or unit Proposal is created based on an existing course version, unit set version or unit version.
A Rule can then be created (in the Rule Text field) based on the Plain Rule Text. For example, administrators without the security level (or membership of the required BAP) to create new rules, can use this field to add a description in 'plain English' for a potential new rule that can be created subsequently by a specialist user.

Note: The field label is institution-configurable in PAAW0300.

Plain Rule Text without a corresponding rule defined (in the Rule Text field) cannot be transferred to the Course Structure and Planning subsystem (i.e. to RULF2000) by the relevant Approved Transfer job (i.e. CRSJ6010), (CRSJ6020) or (CRSJ6000).

Table value:
PROPOSAL_INSTANCE_ITEM.CHARACTER_FIELD

Note:
The TABLE_NAME value in the S_PROPOSAL_ITEM table, is UNIT_VERSION_RULE, COURSE_VERSION_RULE or UNIT.SET_VERSION_RULE.
The COLUMN_NAME value is PLAIN_RULE_TEXT.
These values are transferred to the Course Structure and Planning subsystem via the Approved Course Transfer (CRSJ6010), Approved Unit Set Transfer (CRSJ6020) and Approved Unit Transfer (CRSJ6000) jobs if a Rule (i.e. a Rule Sequence Number) exists for the Proposal.
   
*Rule Text

The actual Rule.

Modified or new Rules must be verified using the Operators/Verify button.
Only valid Rules can be saved.

Invalid text appears in the 'Invalid Rule Text' field, below.

Course version, unit set and unit version rules captured in this page are transferred to the Course Structure and Planning subsystem (i.e. CRSF1210, CRSF4200 and CRSF2210 respectively) via the Approved Course Transfer (CRSJ6010), Approved Unit Set Transfer (CRSJ6020) and Approved Unit Transfer (CRSJ6000) jobs.

Table value:
PROPOSAL_INSTANCE_ITEM.NUMBER_FIELD
(This value is derived from a call to the RULP_GET_RULE function. (Note: The seqeuence number is stored in the Rules table.)

Invalid Rule Text

Displays invalid rule text.

Table value:
(This value is returned from the rule parser when the Options/Validate button is clicked.)

Rule Operators

Dislays a list of 'Rule Operators' which are used to create a Rule.

 
Return to Top

Creating a Rule

  1. Click on the Insert Operator link for the Operator required to start the Rule. This operator is copied into the Rule Text area and the operators that can follow are displayed in the Rule Operators section below.

    To continue assembling your rule:
  1. If another operator is required to continue the Rule, click on the Insert Operator link.
  2. If a value is required in the Rule (e.g. a number), then manually enter that number in the Rule Text field, then click on the Verify button.
  3. If ***Parse Successful *** displays, this means that the Rule can be saved as it is.
  4. Click on the Save & Close button to save the Rule and return to the previous page, or click on the Cancel link to do this without saving the Rule.
Return to Top

Editing a Rule

  1. On the Edit Rules page (PAAW1100), click on the Rule button for the rule to be modified.
  2. In the Rule Text area, strip the rule back from the to tail to remove text that is no longer appropriate.
  3. Click on the Verify button.
  4. Assemble the rule as for Creating a Rule above, and save when completed.
Return to Top

Related Pages

Return to Top

Page last modified: 2 September, 2013 1:22 PM

History Information:

Release Version Project Change to Document
16.1 1820 - Phase 3 Added the new 'Plain Rule Text' field and related notes, and the Field Descriptions section.
15.0 1722 - 11g Upgrade New Help page for 11g.