Completion Rules

Overview

The Completion Rules system automates the process of determining when students have completed programme components based on customisable conditions and triggers appropriate actions when those conditions are met. This system operates at both the programme and component levels, providing flexibility to accommodate various educational requirements.

Key Concepts

Rule Types

• Programme Rules: Apply to the entire programme and can evaluate the completion status of all components
• Component Rules: Apply to specific components within a programme

Rule Components

• Conditions: Criteria that must be met for a rule to execute
• Actions: Operations performed when all conditions are satisfied
• Execution Order: Rules are processed in a specific order, with the option to stop processing after certain rules

Rule Processing

1. The system evaluates each rule’s conditions
2. If all conditions are met, the rule’s actions are executed
3. A log is created to track rule execution
4. If the “Stop processing more rules” option is enabled, no further rules are processed

Creating Completion Rules

Creating a Programme Rule

1. Navigate to a programme’s details page
2. Select the “Completion Rules” tab
3. Click the “New Rule” dropdown and select “Programme Rule”
4. Configure the rule:
   • Name: Enter a descriptive name for the rule
   • Conditions: Add one or more conditions that must be met
   • Actions: Add one or more actions to execute when conditions are met
   • Stop processing more rules: Enable if this rule should prevent further rules from executing
5. Click “Save Rule”

Creating a Component Rule

1. Navigate to a programme’s details page
2. Select the “Completion Rules” tab
3. Click the “New Rule” dropdown and select “Component Rule”
4. Select the components to which this rule should apply
5. Configure the rule as above
6. Click “Save Rule”

Running Completion Rules

Manual Execution

1. Navigate to a student’s enrolment record
2. Click the “Run Completion Rules” button
3. Review the results:
   • Green badges indicate successful rule execution
   • Yellow badges indicate rules that didn’t execute due to failed conditions
   • Blue badges indicate rules that have already been executed

Automated Execution

The system can automatically process completion rules through scheduled tasks:

1. Rules are processed for components that have been updated since the last run
2. Rules are processed for enrolments that have been updated since the last run
3. Results are logged for review

Managing Completion Rules

Ordering Rules

1. Navigate to the “Completion Rules” tab
2. Drag and drop rules to change their execution order
3. The system automatically saves the new order

Editing Rules

1. Navigate to the “Completion Rules” tab
2. Click the pencil icon next to a rule
3. Make your changes
4. Click “Save Rule”

Deleting Rules

1. Navigate to the “Completion Rules” tab
2. Click the trash icon next to a rule
3. Confirm the deletion

Common Rule Configurations

Automatic Component Completion

Condition: Children Completion (all child components are complete) Action: Change Completion Code (set to a completion code that counts as complete)

Grade Calculation

Condition: Weight (e.g., 70% of weighted components are complete) Action: Grade from Children (calculates a weighted average grade)

Notification on Completion

Condition: Completion Status (component is complete) Action: Event (creates a notification for staff)

Troubleshooting

Rule Not Executing

• Check if all conditions are met
• Verify that the rule hasn’t already been executed (check logs)
• Ensure earlier rules aren’t stopping processing

Clearing Rule Logs

If you need to re-run a rule that has already been executed:

1. Run the completion rules
2. Locate the rule with the “Already executed” status
3. Click the “Clear” button
4. Run the rules again

Rule Execution Errors

If an action fails during execution:

1. Check for error messages in the rule execution results
2. Verify that all required data for the action is available
3. Review the system logs for more detailed information