Upgrading the Sakai Plugin: Upgrading the Echo360 plugin for Sakai involves simply replacing the existing plugin with a new one. PRIOR to following the Download and Install steps below, move the existing echo360-tool.war file in the webapps directory to another location for backup.
mv <sakai-installation-root-location>/webapps/echo360-tool.war /tmp/echo360-tool.war
The Sakai Tomcat application server will then automatically uninstall the
echo360-ool.war deployment, and log it in the
catalina.out log file:
INFO [ContainerBackgroundProcessor[StandardEngine[Catalina]]] org.apache.catalina.startup.HostConfig.undeploy Undeploying context [/echo360-tool]
INFO ContainerBackgroundProcessor[StandardEngine[Catalina]] org.sakaiproject.util.SakaiContextLoaderListener - Destroying Components in echo360.tool
At this point you can follow the instructions below to install the new version of the plugin.
Echo360 provides a plugin for Sakai that once installed, generates an Echo360 button in the content editor for easy-access to embedding Echo360 videos. This plugin allows instructors, teaching assistants, or students to embed videos (or upload and then embed) from Echo360 directly into a Sakai page or content window.
Administrators can use the Echo360 embed button to embed any video in the system to which they have access.
The plugin supports Sakai 12.6 and higher.
IMPORTANT: For any user to use the Echo360 embed toolbar button, you MUST enable Public Links for instructors in Echo360. Otherwise instructors, teaching assistants, and/or students will not be authorized to generate public links or the embed code necessary for this button to embed videos into Sakai. LMS-Embedded videos provide view data such as view counts and heatmap data, as shown in the Analytics tab of the media details page of the video. Furthermore, as long as the user is logged into the LMS, and you have at least version 1.0.5 of the Sakai plugin, the views can be attributed to unique viewers and as such are counted as Unique Views in the analytics data provided.
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 Sakai for Echo360.
These procedures must be performed by the Sakai/Echo360 Administrator. NOTE please that the steps below for the Sakai Administrator are provided as a guide; please refer to the Sakai documentation for further details if necessary.
Download and Install the Echo360 Plugin for Sakai
For convenience this plugin is packaged and distributed as
Echo360SakaiPlugin-<RELEASE_VERSION>.zip file, and contains of two separate pieces of software to install in the Sakai LMS:
echo360CKEditor plugin folder the handling the user-interface logic
echo360-tool.warJava Servlet WAR package handling the business logic regarding LTI launch requests and responses
The contents of the
Echo360SakaiPlugin-<RELEASE_VERSION>.zip is structured as below to support easy installation:
. # Sakai installation root location ├── ECHO360_README.md # README file ├── ECHO360_VERSION.info # Release Version file ├── sakai │ └── echo360.properties # Example echo360.properties file ├── webapps │ ├── echo360-tool.war # Echo360 Tool Java Servlet WAR package │ └── library │ └── editor │ └── ckextraplugins │ └── echo360 # Echo360 CKEditor plugin folder │ ├── plugin.js │ └── icons │ └── echo360.png └── ...
To download and install the Echo360 Plugin for Sakai
- Log into Echo360 as an Administrator and navigate to the Downloads page (Settings > Downloads).
- Scroll to the bottom and click the Download link for the Sakai Plugin, and save the
Echo360SakaiPlugin-<RELEASE_VERSION>.ziponto the Sakai application host server.
Echo360SakaiPlugin-<RELEASE_VERSION>.zipinto the Sakai installation root location.
e.g. unzip -o
Once unzipped, the Sakai Tomcat application server will automatically deploy the
echo360-tool.warfile, and log it in the
e.g. INFO [localhost-startStop-8] org.apache.catalina.startup.HostConfig.deployWAR Deploying web application archive /opt/tomcat/webapps/echo360-tool.war INFO localhost-startStop-8 org.sakaiproject.util.ToolListener - registering tools from resource: /tools/echo360.tool.xml INFO [localhost-startStop-8] org.apache.catalina.startup.HostConfig.deployWAR Deployment of web application archive /opt/tomcat/webapps/echo360-tool.war has finished in 3,849 ms
Check the following files have been unzipped into the equivalent paths within Sakai.
1. <sakai-installation-root-location>/ECHO360_README.md 2.
<sakai-installation-root-location>/ECHO360_VERSION.info3. <sakai-installation-root-location>/sakai/echo360.properties 4. <sakai-installation-root-location>/webapps/echo360-tool.war 5. <sakai-installation-root-location>/webapps/library/editor/ckextraplugins/echo360/plugin.js 6. <sakai-installation-root-location>/webapps/library/editor/ckextraplugins/echo360/icons/echo360.png
- Locate and edit the
<sakai-installation-root-location>/webapps/library/editor/ckeditor.launch.jsfile to register the
- Find the
toolbar_Fullvariable declaration, and the line
['Link','Unlink','Anchor'],and add the following line below it:
- Find lines declaring
CKEDITOR.plugins.addExternal(...);and add the following line:
- Find the line declaring
,echo360to the comma separated value.
- Save the changes above to
Once completed, the Sakai LMS rich-text editor will display the
echo360 CKEditor button to users (no restart is required). In order for the plugin to display the user's content library to select from, complete the below steps to configure the plugin for your Echo360 institution.
Configure the Echo360 Sakai Tool
Configuring the Sakai plugin involves simply entering the LMS Configuration values for your existing Sakai configuration. The Key, Secret, and URL tell the plugin which Echo360 institution to point to, and provides secure communication between the plugin and your Echo360 institution.
The LMS Configuration values to use are found on the Settings Icon > Configuration > LMS Configurations page of Echo360. You must be an Echo360 Administrator to access these values. You must be a Sakai administrator to enter them into the settings on the Sakai server. As with the above procedures, the below steps are provided as guidelines. Please refer to your Sakai documentation for further instructions if necessary.
To configure the Echo360 plugin for Sakai
- Log into Echo360 as an administrator and click the Settings icon in the upper right corner of the screen.
- Select Configurations. The LMS Configurations page appears by default.
- Find your Sakai configuration profile; these are the values you will copy and paste into the properties file on the Sakai server.
- Host URL
- Consumer Key
- Shared Secret
- Edit the
<sakai-installation-root-location>/sakai/sakai.propertiesfile and add the following properties (refer to example
echo360.launch.url=<Host URL> echo360.launch.key=<Consumer Key> echo360.launch.secret=<Consumer Secret> echo360.iframe.default.width=640 echo360.iframe.default.height=360
- Edit the
<sakai-installation-root-location>/sakai/sakai.propertiesfile and add the following to enable Sakai's Anti-Samy security to allow embedding Echo360 content.
- Restart Sakai Tomcat application server.
The Content window toolbar should now provide the Echo360 button for embedding Echo360 videos. Instructors, teaching assistants, and students can embed any videos they own (appear in their My Content library) or upload a video then embed it. Administrators can embed any video they have access to in the system. Remember that the Public Links feature in Echo360 must be enabled for the institution in order for users to embed links to their videos.