WEBSERVICE Integration - COURSE

Local plugins ::: local_webcourse
Maintained by Maxwell Souza
This Moodle plugin interacts with an external microservice to create courses and enroll users.

WEBSERVICE Integration - COURSE 1.0

Moodle 3.11, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
Released: Monday, 9 December 2024, 9:38 PM

Moodle Plugin: Local WEBCOURSE

Description

This plugin integrates Moodle with an external microservice to create courses and enroll users. It validates users, generates a CSV file for non-existent users, and automates course setup.

Installation

  1. Copy the plugin folder to moodle_root/local/.
  2. Access the Moodle admin panel to finalize installation.
  3. Configure the external API endpoint in the plugin settings.

Features

  • Fetches course data from a microservice.
  • Creates courses automatically.
  • Enrolls users based on usernames.
  • Generates a CSV for users not found in Moodle.

Requirements

  • Moodle 4.x or higher
  • PHP 7.3 or higher
  • Admin permission

Usage

  1. Set the correct endpoint for your requisition.
  2. Access the plugin page in Moodle: /local/webcourse/index.php.
  3. Input the course ID from the external microservice.
  4. Confirm course creation.
  5. Download the CSV of missing users, if applicable.

Error Handling

  • Displays errors for invalid inputs or missing API responses.
  • Warns about missing users with a downloadable CSV report.

File Structure

  • index.php: Handles user interaction and workflow.
  • lib.php: Helper functions for course creation and enrollment.
  • lang/en/local_webcourse.php: Language strings.

License

This project is licensed under the GNU General Public License.

Author

Maxwell H. S. Souza

Version information

Version build number
2024120300
Version release name
1.0
Maturity
Stable version
MD5 Sum
0c186f13c10c1a19c160d028bb0e49a5
Supported software
Moodle 3.11, Moodle 4.0, Moodle 4.1, Moodle 4.2, Moodle 4.3, Moodle 4.4, Moodle 4.5

Version control information

Version control system (VCS)
GIT
VCS repository URL

Default installation instructions for plugins of the type Local plugins

  1. Make sure you have all the required versions.
  2. Download and unpack the module.
  3. Place the folder in the "local" subdirectory.
  4. Visit http://yoursite.com/admin to finish the installation.