tool_sga

tool_sga (SGA Integrator) is an admin/tool-type plugin for Moodle that exposes an HTTP API consumed by the SGA (Academic Management System) used to keep Moodle synchronized: it creates and updates categories, courses, classes, users, cohorts, enrolment methods and enrolments from a JSON payload sent by the SGA, and returns grades recorded in Moodle to the SGA on demand. The plugin also creates dozens of custom profile fields (course and user) used by other components of the IFRN AVA/SUAP suite.

Contents

• Overview
  • What the plugin does
  • API authentication
  • Requirements
  • Repository structure
  • Organization
• Installation
  • 1. Configuration in Moodle
  • 2. Testing the token
  • 3. Sending a synchronization
• Upload synchronization (SGA → Moodle)
  • Flow overview
  • Possible endpoint initialization issue
  • Two distinct entry points
  • Payload format
  • JSON validation
  • Per-item restrictions and error handling
  • Course template restore (template_path)
  • Logging for support/audit
• Grade synchronization (Moodle → SGA)
  • Endpoint
  • Query
  • Response
  • Error handling
• Custom fields
  • Course fields
  • User fields
  • Data tables
• Administrative panel
  • Access
  • Listing (index.php)
  • Detail (view.php)
  • Templates
• Development
  • Versioning
  • Commit types
  • CI/CD
  • Documentation
  • Consolidated notes for anyone working on the code