How can we help?

My Cases

Adding an Echo360 Button to the Moodle Content Editor Toolbar
Last Updated: Mar 04, 2019 03:33PM EST

This article applies to:  Echo360 Admins

Upgrading the Plug-in: If you are upgrading an existing Moodle plug-in, you can typically just overwrite the old plugin with the new plugin extracted files. However, if you have problems upgrading, you may want to uninstall the old one and install and configure the new one as if it was new, using the instructions below. For more on how to Uninstall the plugin, see Updating the Moodle Plugin at the bottom of this page.
IF you are upgrading the plug in to allow students to embed videos from Echo360 into content windows, you must both update to the new plugin and configure the Student role in moodle to allow trusted sites

Echo360 provides an Atto plugin that can be downloaded from Echo360 and installed and configured on your Moodle instance. This plugin allows Instructors (and Students if configuredto embed videos from their Echo360 library directly into a Moodle page or content window for students to view. Administrators can also embed any video in the system to which they have access (as visible in the Captures page of Echo360).

Content area of Page added to Moodle course with Echo embed video button identified

IMPORTANT: For any user to use the Echo360 embed toolbar button, you MUST enable Public Links for instructors in Echo360. Otherwise instructors and/or students (depending on the toggle settings) will not be authorized to generate either public links or the embed code necessary for this button to embed videos into Moodle.
In addition, like all public or embedded links to videos, the videos embedded into Moodle do NOT generate student viewing analytics. Analytics are currently tied to sections, meaning students must view media within the context of a section in order to provide instructors with student view data.

The LMS Configuration information (Key, Secret, and URL) can be the same as they are for the External Tool you may already have configured in Moodle for Echo360.

These procedures must be performed by the Moodle/Echo360 administrator. NOTE please that the steps below for the Moodle Administrator are provided as a guide; please refer to the Moodle documentation for further details if necessary.

To install the Echo360 Atto Plugin for enabling Echo360 embed content button

  1. Log into Echo360 as an Administrator and navigate to  the Downloads page (Settings Downloads).
    Downloads page with Settings menu open showing navigation as described
  2. Scroll to the bottom and click the Download link for the Moodle Plugin, and save the .zip file to your local drive.
    Atto plugin for Moodle section of downloads page with download link as described
  3. Extract the plugin file and copy it to the /lib/editor/atto/plugins location on the Moodle Server.
  4. Log into Moodle as an Admin and select to Upgrade Moodle database now.
  5. When the success message appears, click continue.
    The page changes to show the LMS configuration fields necessary for the plugin.
    New setting page for the Echo360 plugin with LMS configuration value fields as described
  6. Open a new tab or browser window, and log into Echo360 as an Administrator.
  7. Select the Settings icon in the upper-right of the screen, then select Configurations
    The LMS Configurations page appears by default.
    LMS Configurations page with settings menu and left tab navigation identified
  8. Find your existing Moodle LMS configuration.
  9. Copy the Consumer KeyShared Secret, and Host URL values from Echo360 into the Echo360 Atto plugin settings in Moodle.

    TIP: In Echo360, select some of each field then use Ctrl+A/Command+A to "select all" of the field, then Ctrl+C/Command+C to be sure to copy the whole field. In Moodle, place your cursor in the field and press Ctrl+V/Command+V to paste the value.

  10. Click Save changes.
  11. In Moodle, navigate to Site Administration > Plugins.
    Moodle site administration and plugins navigation identified for steps as described
  12. Scroll down to the Text editors section and click on the Text editors link.
    Moodle plugins administration with Text Editors section and link identified
  13. In the Text editors list, make sure the Atto plugin is at the top. If it is not, use the up-arrow next to it to move it to the top.
    If you must change the order of the editors shown, you will be taken into the Manage Editors page; you will need to click Text Editors from the breadcrumbs links at the top to return to the Text Editors page and continue as described below.
  14. Below the Text Editors list, click Category: Atto HTML editor.
    Text Editors list with Atto HTML editor location identified and editor configuration link identified
  15. Scroll down the list of plugins to find the Echo360 plugin, shown in the below figure, then select and copy the plugin name (Ctrl+c or Command+c).
    Atto plugins list with Echo360 plugin name identified as described
  16. Scroll farther down the page to the Toolbar config section, then scroll to the bottom of the config list to find Other.
  17. Paste the Echo360 plugin name (Ctrl+v or Command+v) into the Other value in the Toolbar config list (adding it to whatever is already there). Alternately you can type in the name of the plugin which should be echo360attoplugin.
    Atto Plugin toolbar config values with Echo360 plugin name added to Other as described
  18. Scroll down farther on the page to the Collapse toolbar settings section, and increase the Show first (n) groups when collapsed value to ensure the Echo360 button will appear by default for all users. The below figure shows this value set to 20, which is the maximum.
    Collapse toolbar settings with show first groups setting set to 20 as described
  19. Scroll to the bottom of the page and click Save changes

The Content window toolbar should now provide the Echo360 button for embedding videos. Instructors can embed any videos they own (appear in their library). Administrators can embed any video they have access to in the system. Remember that the Public Links for instructors in Echo360 toggle must be enabled for the institution in order for Instructors to embed links to their videos.

Updating the Moodle Plugin

Sometimes a new version of the Moodle Plugin will be released, to fix some bugs or provide updated functionality. Typically you can simply download the new plugin, extract it, and overwrite the old version in the same directory. This is the EASIEST method, because it retains all of the other configurations and simply provides the new or updated functionality.

However, if updating this way is giving you trouble (and let's face it, upgrades can be a problem sometimes), you can uninstall the OLD plugin using the instructions below, then download and install and configure the new version using the instructions above. These procedures must be performed by a Moodle Site Administrator. In addition, these steps are provided as a guideline; please refer to your Moodle documentation for more details if necessary.

To uninstall and update the Echo360 Moodle plugin:

  1. Uninstall the existing Echo360 Atto plugin for Moodle by navigating to Site Administration > Plugins > Plugins Overview 
  2. Find the Echo360 Atto plugin and select Uninstall, as shown in the below figure.
    Echo360 Plugin on Moodle with Uninstall option shown for steps as described
  3. Go to the Moodle server and remove the originally written plugin file from wherever the Moodle Home directory is on your Moodle server. For example: /var/www/html/moodle/lib/editor/atto/plugins and delete the folder originally placed there when you installed the plugin previously.
  4. Replace the removed folder with the new one you extracted from the zip file downloaded from the Echo360 Downloads page.
  5. When you return to the Moodle Site Administration page, you should see a message telling you to upgrade the database to apply the new plugin.
  6. Continue from Step 4 above to complete configuration of the updated plugin.

Existing embedded videos are NOT affected by the update, and any changes that may apply to future embeds are also NOT back-applied to existing embeds. If those embeds need to be updated, users may want to re-embed those videos using the new plugin and its updated capabilities.
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
Invalid characters found