Moodle Integration Setup

  • Updated
Follow

Moodle is a Learning Management System that integrates with aXcelerate. To integrate Moodle with aXcelerate you must first install the aXcelerate plugin on your Moodle server and follow the setup steps.

 

Our Moodle integration plugin is exclusively available for aXcelerate Turbo users. If you would like to learn more about Turbo, please contact our Customer Success team.

 

Tip: Our plugin is tested to work with Moodle version 2.6 up to version 4. Later versions of Moodle should also be compatible but have not been explicitly tested. We release compatibility fixes for the plugin as soon as changes are required.

 

Note: aXcelerate does not provide technical support for configuration or troubleshooting of your Moodle server. We can only offer support for the aXcelerate Moodle plugin along with resulting functionality within aXcelerate. The interface will also differ according to the Moodle version and theme. In newer versions of Moodle the Web Services page has moved to reside under Server settings, this has been reflected in the below steps. For assistance in the use of the Moodle platform, please refer to Moodle's Help Documentation.

 

Warning: If changing Moodle host, having already been connected to aXcelerate with a previous host you will need to run either the Contact Details - Warehoused report or the Class Enrolments - Warehoused report and include the Display Field “Moodle User ID”. The new instance of Moodle needs to generate User ID numbers higher than the highest number returned within this report. Please contact the support centre for assistance with this change of Moodle Host.

Install the Moodle plugin Directly on your server

This method of installation involves taking the aXcelerate Moodle plugin zip file and installing it directly on your Moodle server. The aXcelerate Moodle plugin zip file will be provided to you when the integration is enabled in your account by our Customer Success team.

  1. Login to your Moodle server as an administrator user
  2. Unzip and copy the contents of the auth folder into the auth folder in the Moodle root of your site. The auth folder in the Moodle root should contain the axcelerate folder.
  3. Unzip and copy the contents of the local folder into the local folder in the Moodle root. The local folder will now contain the folders: axcelerate_course, axcelerate_group, and axcelerate_grade
  4. Once all files are copied, go to Site Administration then click Notifications. Moodle will recognise that there are new plugin folders to install and list them here.
  5. Click Upgrade Moodle database now to install the plugin
  6. Click Continue
 

Tip: You can also Install the Moodle plugin via the Moodle Interface.

 

Note: If you are running moodle in a linux environment, ensure the plugin folders have correct ownership and permissions.

Install the Moodle plugin via the Moodle Interface

This method of installation involves taking the aXcelerate Moodle plugin zip file and installing it through the Moodle Interface. The aXcelerate Moodle plugin zip file will be provided to you when the integration is enabled in your account by our Customer Success team. Please be aware that the Moodle Interface may differ according to the Moodle version and theme.

  1. Login as the administrator of your Moodle site and click on Site Administration
  2. Select Plugins/Server and then click Install Plugins
  3. Unzip the plugin .zip file provided to you containing 3 plugin files
  4. Install the Authentication Plugin
  5. Set the Plugin Type to Authentication method
  6. Drag the axcelerate.zip file in the auth folder of your expanded plugin into the upload area
  7. Tick the Acknowledgement box and click Install
  8. After Moodle performs a validation check, click Install add-on
  9. On the next page click Upgrade Moodle database now
  10. Click Continue
  11. Repeat the installation process for the local Web Service plugins in the .zip file with the Plugin Type set as Local Plugin
 

Tip: You can also Install the Moodle plugin Directly on your server.

 

Note: If the system indicates an error when installing the authentication plugin, you will need to correct the write permissions for this directory to continue. If assistance is required with this step, you will need to contact your Moodle server administrator.

Enable Moodle Web Services

Enabling Web Services is necessary to allow Moodle to be controlled from an external source so that the aXcelerate integration can function.

  1. Login as the administrator of your Moodle server and click on Site Administration
  2. Select Plugins/Server and click Web services and then click Overview
  3. Click on Enable web services
  4. Tick Enable Web Services
  5. Click Save Changes
 

Tip: After enabling Moodle Web Services, you will need to Enable Moodle Protocols.

Enable Moodle Protocols

  1. Login as the administrator of your Moodle server and click on Site Administration
  2. Select Plugins/Server and click Web services and then click Manage Protocols
  3. Enable the REST protocol by clicking the icon under Enable
  4. Click Save Changes
 

Tip: After enabling Moodle Protocols you will need to Create a Moodle Web Service User.

Create a Web Service User in Moodle

A web services user is required to represent aXcelerate in the Moodle environment and allow the aXcelerate integration to take actions in Moodle. After creating the user you will need to set them as an administrator user.

  1. Login as the administrator of your Moodle server and click on Site Administration
  2. Select Plugins/Server and click Web services and then click Overview
  3. Click Create a specific user
  4. Fill out all required fields and click Create User
  5. Select Users from the menu and click Permissions then click Site Administrators
  6. Search for the new Web Service User
  7. Click Add
 

Tip: After creating a Moodle Web Service User you will need to Select a Moodle Service.

 

Note: We recommend that you name the user 'aXcelerate Web Service User' or something similar. The password can be very strong as it will likely never be used.

Select a Moodle Service

The service is a set of web service functions the integration will be able to perform. The aXcelerate Web Service User will need to be allowed to access to the service.

  1. Login as the administrator of your Moodle server and click on Site Administration
  2. Select Plugins/Server and click Web services and then click External Services
  3. Click the Add button to create a new service
  4. Name the service 'aXcelerate Web Service' or something similar, then check the Enabled and Authorised users only boxes
  5. Click Add Service
  6. Click Functions next to the newly created External Service
  7. Click Add Functions
  8. Search for the required functions and click Add Functions
  • The required functions to add to the service are listed below:
  • axcelerate_course_get_completions
  • axcelerate_course_unenrol_user
  • axcelerate_course_update_courses
  • axcelerate_grade_get_grades
  • axcelerate_grade_get_items
  • axcelerate_group_create_groups
  • axcelerate_group_get_course_groups
  • axcelerate_group_update_groups
  • core_course_create_categories
  • core_course_create_courses
  • core_course_delete_categories
  • core_course_delete_courses
  • core_course_update_courses
  • core_course_get_categories
  • core_course_get_courses
  • core_enrol_get_enrolled_users
  • core_group_add_group_members
  • core_user_create_users
  • core_user_delete_users
  • core_user_get_users_by_field
  • core_webservice_get_site_info
  • enrol_manual_enrol_users
 

Tip: After you have selected the Moodle Service and added the required functions, you will need to Add a Web Service User to the Moodle Service.

 

Note: You can hold Command for Mac or Control for Windows to select multiple functions.

Add a Web Service User to the Moodle Service

  1. Login as the administrator of your Moodle server and click on Site Administration
  2. Select Plugins/Server and click Web services and then click Overview
  3. Click Select a Specific User
  4. Click Authorised Users next to your newly created External Service
  5. Search for your aXcelerate Web Service User
  6. Click Add
 

Tip: After adding your Web Service User to the Moodle Web Service you will need to Create a Moodle Token.

Create a Moodle Token

After the Moodle Token is generated it will need to be placed into your aXcelerate system settings in the corresponding field.

  1. Login as the administrator of your Moodle server and click on Site Administration
  2. Select Plugins/Server and click Web services and then click Create a token for a user
  3. Enter your newly created Username and select your Service
  4. Leave the IP restriction and Valid Until values as blank
  5. Click Save Changes
 

Tip: After you have created a random token for the aXcelerate Web Service user you will need this token to enable the integration in aXcelerate from your aXcelerate system settings. You can find your token again in Moodle by going to Site Administration > Plugins > Web services > Manage Tokens.

Configure aXcelerate Moodle Integration Settings

Settings

 

System Settings

 

Web & Other Integrations

  1. Scroll to the Moodle Integration Details section
  2. Enter your Moodle Server URL
  3. Paste the Moodle WS Token that you generated when Enabling Web Services
  4. Set your Moodle Timezone
  5. Select your Moodle Email Registration Template. This is the template that will be sent to students upon first enrolment into a Moodle course.
  6. Test your Moodle details are correct by clicking Test Connection
  7. Click Save Web Settings
 

Tip: Click Generate New Key next to the Moodle SSO Key to create a random secret encryption key used to Configure aXcelerate Moodle SSO Authentication. This token is needed to allow users to launch Moodle from the Learner Portal and will need to be added to Moodle before the single sign-on function can be utilised.

 

Note: The Moodle Timezone field should match the timezone you have set in Moodle under your Site Administration > Location > Location Settings. This will ensure that time is set correctly between Moodle and aXcelerate.

 

Warning: aXcelerate does not support the use of localities for your timezone. So, for example, you must select UTC+10.0 and not Australia/Brisbane in your Moodle Settings. If your Moodle settings are set to a location, aXcelerate will possibly be an hour out during some months of the year if that location uses Daylight Savings times.

Configure Moodle aXcelerate SSO Authentication

SSO (Single Sign-On) allows users to launch Moodle from the aXcelerate Learner Portal without needing to enter their Moodle login credentials.

Settings

 

System Settings

 

Web & Other Integrations

  1. Scroll to the Moodle Integration Details section
  2. Click Generate New Key next to the Moodle SSO Key field
  3. Copy the Moodle SSO Key and click Save Web Settings
  4. Login to your Moodle site as an administrator
  5. Go to Site Administration > Plugins > Authentication > Manage Authentication
  6. Enable the Axcelerate (SSO) plugin by clicking the Enable icon
  7. Click on Settings
  8. Paste the Moodle SSO Key into the SSO Encryption Key field
  9. Click Save Changes

Test the Moodle Integration

Once you have entered your Moodle details into your aXcelerate system settings, you are able to run a full diagnostic test on your Moodle Connection.

Settings

 

System Settings

 

Web & Other Integrations

  1. Scroll to the Moodle Integration Details section
  2. Click Run Full Test
  3. Click Run All Tests
 

Tip: This page also allows you to run tests for particular areas of the integration.

 

Note: You will need to ensure that you have entered the details of your Moodle integration into the corresponding fields before testing the integration.

 

Warning: Part of the testing process involves automatically creating test users and courses and then removing them. Once you start a test, ensure it runs to completion before leaving the page.

Moodle Integration Webinar

This webinar demonstrates:

  • Integration processes (settings in Moodle and aXcelerate)
  • Installing the plugin and enabling the feature
  • Setting up templates for Moodle Enrolment Login details
  • Importing Courses
  • Linking Courses to Units
  • Viewing Courses in a Class
  • Enrolling Student in Courses

FAQs

Q.

What platforms does aXcelerate Integrate with?

A.
aXcelerate integrates with the following:
  • MyLearningSpace (Moodle)
  • Catalyst IT (Moodle)
  • eCreators (Moodle)
  • Instructure (Canvas)
  • Self-Hosted Moodle and Canvas instances
  • Xero
  • MYOB
  • Hubspot
  • Quickbooks
  • eWAY
  • EzyPay
Q.

What version of Moodle does Axcelerate use?

A.
We currently use Version 4.

Related articles