Description	Integration with Moodle learning platform
Latest Version	2022.30.0.21
Release Date	Jul 6, 2023
Download Path	Download
Type	APM Plugin

Description

Moodle is a learning platform designed to provide educators, administrators, and learners with a robust, secure, and integrated system to create personalized learning environments.

Based on expired or missing competencies, the Interface schedules the relevant courses in Moodle.

The same Interface will insert or update Adonis's newly acquired competence code on course completion.

This document describes how to:

How to configure APM to schedule courses in Moodle
Configure the Replicator plug-in integrating the Moodle and Adonis database

Functionality

It's important to note that the interfaces for Moodle operate differently when installed onboard or in the office. When installed onboard, Moodle is primarily used for typical courses related to the vessel, such as safety courses, "know your ship" training, and other vessel-specific courses. On the other hand, when installed onshore, the Moodle plug-in schedules company-specific courses like onboarding videos and other courses specific to the company.

We use the APM Enrollment profile to facilitate this process, which serves as an identifier for the Moodle course. It contains essential configurations for activating the courses in Moodle and adding the completed courses or competencies in Adonis.
See the section Housekeeping> “Course enrollment profile” below.

Conditions that persons are enrolled in courses.
When running the plugin onboard:

The Person should have Current or Planned onboard activities;
The Person should have missing or expired Competence linked to a vessel-specific enrollment profile and linked to a Moodle Course ID
The competence should be added for a position as required in the Requirements Profile module.

When running in the office:

The Person should have a valid employment
The Person should have missing or expired Competence linked to an employee-specific enrollment profile and a Moodle Course ID.
The competence should be added as a rank-specific competence. (the person rank and next rank promotion are used to find the competencies)

See the housekeeping section below for more information.

Data Flow

Adonis → Moodle

Parameter from Moodle	Description from Adonis	When

Parameter from Moodle	Description from Adonis	When
userid/userName	Persons pin number	Course Enrollment / Creating Participant
courseid	XREF code of the competency ide see	Course Enrollment
timestart	this will based on the Enrollment Profile of the competence in APM	Course Enrollment
timeend	this will based on the Enrollment Profile of the competence in APM	Course Enrollment
suspend	If the competence was removed/suspended from the Profiles Requirements in APM	Course Enrollment
firstName		Creating Participant
lastName		Creating Participant
Email		Creating Participant

Moodle → Adonis

Parameter from Moodle	Description from Adonis

Parameter from Moodle	Description from Adonis
Status	If status=complete the enrollment profile determines how to process the competence expiry dates.

Housekeeping

This section will walk you through both the installation and configuration of the Moodle plugin.

Moodle Replicator Plugin

The section covers the download, installation, and configuration procedures of the Moodle plugin.

Download

http://download.adonis.no/files/upgrade/PersonnelManager/Plugins/Replicator/MDL/

Installing the Plugin

Once the download is complete, follow the link below to get the instructions on how to install the plugin:

Installing and distributing the Replicator plug-in

Plugin Parameters

A plug-in will request specific parameters like authentication details, server URL, names etc. These parameters are different from plug-in to plug-in, before scheduling the plug-in the administrator needs to set the correct parameters.

Expand the plug-in and select plugin parameters in the right panel of the replicator manager.

In the right-hand screen, select the site and add the parameters manually.

Example of adding plugin parameters.

Plugin-specific parameters for the Moodle Interface

Name	Value

Name	Value
SERVER_NAME	Database server name
DATABASE	Enter the database name used when installing Adonis Personnel Manager.
DAYSGAP	Enter a numeric value stating the number of days from today's date in which the system will detect planned activity.
DEBUGLOG	Enter a numeric value stating the number of log records to be displayed.
SERVICE_URL	URL pointing to the Moodle Server
SERVICE	Name of the external service used to integrate with Moodle. See Moodle Configuration below
SERVICE_USER	User name of the user authenticated to use the external service
SERVICE_PSW	Password of the user used or authenticated to use the external service. See Moodle configuration section below
XREF	Enter the Moodle plugin code defined in Adonis Personnel Manager. For more information, see Add Moodle Interface.

Moodle Configuration

External Service

In Moodle, external services are a feature that allows integration with external applications or services, enabling them to interact with Moodle and access certain functionalities. The replicator parameter SERVICE refers to the external service short name.

To use external services in Moodle, administrators need to configure the service's settings, including authentication credentials, access permissions, and specific functions that can be accessed by the external application.

To configure the service's settings:

Create External Services.
Add functions to the External Services.
Authorise User.
Create Token.
Manage Protocols.

How to:

Log in to Moodle as an administrator.
Goto: Site administration → Plugins → Webservices → External services.

Select create service
Add a new External service name and the short name “enrol_user“. The Short name is a mandatory field and is the name used to call the service.

Short name is not a mandatory field in Moode, if left blank the interface will not work.

Goto: Site administration → Plugins → Webservices → External services → Functions

The following functions need to be added to the external service.

auth_userkey_request_login_url
core_completion_get_course_completion_status
core_course_get_courses
core_enrol_get_enrolled_users
core_enrol_unenrol_user_enrolment
core_user_create_users
core_user_get_users
core_user_get_users_by_field
core_user_update_users
core_webservice_get_site_info
enrol_manual_enrol_users
enrol_manual_unenrol_users

Go to Site administration → Plugins → Webservices → External services → Authorised users

Go to: Site Administrator → Plugins → Web Services → Manage Token

While creating the token you have to select the already created External Service from the drop-down button.

Course Criteria

In Moodle, course criteria refer to the requirements or conditions that employees must meet to complete or pass a course. The following conditions are supported and result in competency in Adonis:

Completion of Activities, or self-completion, when following the course, the employee confirms reading or following the course. Typically used for introduction videos or presentations.
Minimum Grade Threshold, or Required course grade, the student must achieve a specific score before passing the course, resulting in competency in Adonis.

For more details on setting up courses, see the Moodle documentation.

APM Configuration

Enrollment Profile

The enrollment profile defines the criteria to schedule a person for a particular course. The criteria can be Employee specific, like a welcome to the company introduction course or Vessel specific courses, like “Safety Course” or “Know your ship”. In addition, the enrolment profile defines the validity of the course once the employee has passed the course.

You can define various enrollment profiles and link them to one or more competence codes.

On execution, the Moodle Plug-in knows if it runs on a vessel or office site. Based on this, the plugin finds competencies linked to the enrollment profile. The enrollment profile competency expiration condition is used to find all persons that, based on the rank or position profile, should hold this competency (either missing or expired) and schedule these persons for the dedicated course in Moodle.

Only competencies linked to an enrollment profile and with an xref code identifying the Moodle course id are subject to this interface.

Identify competence codes used by Moodle.

We use the standard XREF functionality on every general code table for this. This means creating an interface code identifying the Moodle interface, then in the competency codes XREF tab add this interface and add the Moodle Course ID in the xref Code field.

The course ID number you find in Moodle when configuring the courses.

Plug-ins User Documentation

Moodle Interface Plugin