Who can do this?
The procedures on this page must be performed by a Canvas Administrator who is also an EchoVideo administrator, or working with an EchoVideo administrator.
The EchoVideo consolidated analytics link provides viewing and polling response data for all of the Echo360 media currently associated with the Canvas Course where the link is accessed. Clicking the analytics tool link opens a consolidated analytics page in EchoVideo, showing view data for all of the EchoVideo media currently embedded in the Canvas course as well as for media located in any EchoVideo section linked to this Canvas course.
Beyond the instructions provided on this page, EchoVideo consolidated analytics also requires Adding a REST API Integration between Echo360 and Canvas.
Instructors can use this to get at-a-glance information about Student views of course media as well as polling responses for embedded interactive media or section-published presentations.
Who Can See EchoVideo Analytics? Media viewing data is only allowed for EchoVideo instructors and administrators. Meaning the role a user has in EchoVideo determines whether the link opens the EchoVideo consolidated analytics page, or takes the user to their EchoVideo Library. EchoVideo observes IMS role mapping from the LMS as listed in LMS to EchoVideo User Role Mappings.
The instructions below add the EchoVideo Consolidated Analytics link to users' left navigation. It is added as a "course_navigation" type placement with "admin" access which means it appears in the left navigation list for instructors and administrators for all courses.
Echo360 strongly recommends creating separate Apps in Canvas for EACH of the available features, because:
- The XML you paste into Canvas can have ONE AND ONLY ONE "course_navigation" block. The course linking, the library, and the consolidated analytics tools all create "course navigation" placements for the tools. Keeping the tools separate avoids any issues surrounding this limitation.
- You cannot edit or replace the XML for an existing app via the UI. This means that to update a combined tool for future improvements, or to delete a tool you don't want anymore, you need to delete the existing combined one and re-add it. If the tools are separate, this can be done without affecting any other functionality.
The first step is to log into EchoVideo as an Admin and generate an XML cartridge for Canvas that you will use to create the EchoVideo consolidated analytics app in Canvas.
To generate an XML cartridge for Echo consolidated analytics
- Log in as an administrator.
- Click the Settings icon in the upper-right corner of the screen.
- From the Settings menu, select Institution Settings.
General settings appear and Basic Info is selected by default.
- From the left panel, select Integrations, as shown in the figure below.
- From the middle panel, select LMS / VLE, as shown in the figure below.
LTI 1.1 is selected by default.
- Find your existing Canvas LMS configuration.
If you do not have one yet, click Add Configuration then select Canvas from the drop-down list, and click Save. See also Configuring EchoVideo with your LMS. - Select the XML Config tab, as shown in the below figure.
- Choose Course Analytics as a placement.
Warning: The XML you paste into Canvas can have ONE and ONLY ONE "course_navigation" placement block. Course navigation and My EchoVideo library placements both create "course_navigation" blocks in the XML.
- Toggle any additional options desired.
- Click Copy XML.
The XML cartridge text is copied to your clipboard.
- In a new tab or window, log into Canvas as an administrator and follow the procedure below.
Leave the EchoVideo tab / window open, as you will need to return to the LMS configuration page to copy the Key and Secret values from the LTI tab in Echo into Canvas.
To create an EchoVideo consolidated analytics link in Canvas
- Log in to Canvas as an administrator.
- Click Admin from the navigation on the left, then select the main Account for your institution. In the figure below, the main account for Canvas is named EchoVideo.
- The Courses list appears by default. Select Settings from the bottom of the list of links on the left.
- From the Settings page, shown in the figure below, click the Apps tab.
- Click View App Configurations.
- From the External Apps page, click + App (the add app button), as shown in the figure below.
- In the Add App dialog box, select Paste XML from the Configuration Type drop-down list.
- Enter a Name for the App. You can name it anything you like but the name should identify this as the app for EchoVideo media analytics.
- Click into the XML Configuration section of the dialog box and press Ctrl + V or Command + V to paste the copied XML from EchoVideo.
- In the XML Configuration field, look for the "placement" properties section in the middle of the pasted XML, shown in the below figure.
- Optionally, make the following changes to the highlighted properties shown above:
- "EchoVideo Analytics" is the default name provided for the left navigation link. Edit this to anything you want users to see, but be sure it identifies the tool as for EchoVideo consolidated analytics.
-
ADD the "windowTarget" property at the bottom to open the analytics page in a new tab rather than inside the Canvas frame. This provides more area for instructors to view the data. You can copy and paste the following entry:
<lticm:property name="windowTarget">_blank</lticm:property>
- Go back to the EchoVideo window and click the LTI tab for the Canvas configuration if necessary, as shown below.
- Click the Copy to Clipboard button next to the Consumer Key value from EchoVideo, then paste it into the Consumer Key field in Canvas.
Click the Copy button to quickly copy the value. However, you can also click into the field, type <kbd">Ctrl + A / Command + A to select all, then Ctrl + C / Command + C to copy; use Ctrl + V / Command + V to paste into Canvas. </kbd">
- From the EchoVideo window, click the Copy to Clipboard button next to the Shared Secret value from EchoVideo and paste it into the Shared Secret field in Canvas. (See above Tip for copying.)
- Click Submit when finished.
In the App list, find the consolidated analytics app you just created and click the Settings button on the right side of the app entry. Select Placements and the popup should indicate Course Navigation as the placement. This is the placement type that ensures it appears in the left navigation panel in Canvas.
Within any Canvas course, you should now see the EchoVideo consolidated analytics app in your Canvas app configuration list, as identified in the figure below.
Clicking the link opens the consolidated analytics page, providing viewing information about all EchoVideo media associated with this Canvas course. As stated at the top of this page, this includes EchoVideo media currently embedded in the Canvas course as well as media located in any EchoVideo section linked to this Canvas course.
The below figure shows the EchoVideo consolidated analytics page open inside the Canvas frame, as all course-navigation apps do by default. If you add the "windowTarget" property as noted in the above procedure, the page opens in a new tab. Otherwise, users can right-click either the Views or Polls tab on the Analytics page and select to open in a new tab, if they want more space to work with the data provided.