Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Moodle eLearning Chatbot app requires the associated Moodle e-Learning Bot Manager plugin to be installed on the target Moodle server so that the necessary functions to support user and course management from the chatbot application are available.

...

plugin can be obtained from git.

Plugin Installation

The plugin is installed following the standard Moodle plugin installation steps:

...

Note

You must be logged in as administrator to complete the installation process.

...

Installing from the Moodle plugins directory

Below are the steps to download a plugin from the Moodle Plugins Directory:

  1. Visit the Moodle Plugins Directory.

  2. In the search bar, enter the name of the plugin you're looking for (e.g., 'xxxx') and press Enter.

  3. Browse through the search results to find the desired plugin. Click on its name to access its details page.

  4. The plugin's details page contains information about its features, compatibility, and version history.

  5. To download the plugin, locate the Download section on the details page. Here, you might find different versions of the plugin available for different Moodle versions.

  6. Choose the plugin's version compatible with your Moodle installation and click the Download link next to it.

  7. The plugin package will be downloaded to your computer as a ZIP file.

  8. Once the download is complete, you can proceed to install the plugin on your Moodle site using the standard installation process.

...

Note

Make sure to review any documentation or instructions provided by the plugin developer to ensure a successful installation and configuration.

Installing from a ZIP file from GitHub

Here are the steps to install a plugin from a ZIP file downloaded from GitHub:

  1. Obtain the plugin's ZIP file from its GitHub repository. Look for a Download or Code button on the repository's main page, and select Download ZIP.

  2. The plugin package will be downloaded to your computer.

  3. Once the download is complete, you can proceed to install the plugin on your Moodle site using the standard installation process.

Verify Successful Installation of the Plugin

...

Verifing Successful Installation of the Plugin

To confirm the installation and functionality, navigate to your Moodle Site Administration section. You should be able to see the available API functions in the API documentation section within the Server tab. If the plugin has been installed correctly, these functions will be visible. If there are any issues loading the plugin, this section may not display properly or show error messages.

Additionally, there will be two new custom fields for users and courses:

  • User Profile Prefix Field for Country Code: Within the user profile, there will be a new field called Prefix. This field allows you to input the country code, serving as a dialing code for phone numbers.

  • Error-Free Chatbot Startup: The chatbot should start without any error messages. This means that the plugin has been loaded correctly and is functioning properly.

To confirm the installation and functionality, you can navigate to the Site Administration section of your Moodle site. In the API documentation section within the Server tab, you should be able to see the available API functions.

...

  • Similarly, there will be a new field “botmode” field for courses.