Navigation Events: Types, Subtypes, and Triggers

Document created by Oxana Jurosevic Administrator on Oct 16, 2018Last modified by Oxana Jurosevic Administrator on Oct 17, 2018
Version 2Show Document
  • View in full screen mode

Back to:  Table of Contents 

 

Caliper transformation relies on Canvas Live Events asset_accessed to produce all  NavigationEvents. Changes in access to Canvas objects asset types, subtypes trigger a NavigationEvent that is associated either with Caliper specific profile defined object, e.g. ( e.g AssignableDigitalResource or Caliper default object (Entity).

 

Example:

 

asset_accessed where asset_type: "account", asset_subtype: "outcomes"

 

{

 "sensor": "http://oxana.instructure.com/",

 "sendTime": "2018-09-28T15:19:29.479Z",

 "dataVersion": "http://purl.imsglobal.org/ctx/caliper/v1p1",

 "data": [

   {

     "@context": "http://purl.imsglobal.org/ctx/caliper/v1p1",

     "id": "urn:uuid:76b424d6-325d-47ff-a04b-26d651ffe3ed",

     "type": "NavigationEvent",

     "actor": {

       "id": "urn:instructure:canvas:user:170000004567894",

       "type": "Person",

       "extensions": {

         "com.instructure.canvas": {

           "user_login": "oxana",

           "root_account_id": "21070000000000001",

           "root_account_lti_guid": "7db438071375c02373713c12c73869ff2f470b68.oxana.instructure.com",

           "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",

           "entity_id": "1111111111111111"

         }

       }

     },

     "action": "NavigatedTo",

     "object": {

       "id": "urn:instructure:canvas:account:21070000000000001",

       "type": "Entity",

       "name": "outcomes",

       "extensions": {

         "com.instructure.canvas": {

           "asset_type": "account",

           "asset_subtype": "outcomes",

           "entity_id": "21070000000000001"

         }

       }

     },

     "eventTime": "2018-09-28T17:55:57.000Z",

     "edApp": {

       "id": "http://oxana.instructure.com/",

       "type": "SoftwareApplication"

     },

     "session": {

       "id": "urn:instructure:canvas:session:5ea97d244bac31033cc1cbec76feeda5",

       "type": "Session"

     },

     "extensions": {

       "com.instructure.canvas": {

         "hostname": "oxana.instructure.com",

         "request_id": "695bf74d-d1cc-41d3-a215-574631a98449",

         "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36",

         "version": "1.0.0"

       }

     }

   }

 ]

}

 

TABLE: Asset Types, Asset Subtypes and Triggers

 

Asset Type

Asset Subtype

Event Trigger

account

outcomes

user accesses outcomes index page at the account level

course

assignments

a user goes to the course home page when it is set to be the assignments list view

course

syllabus

a user goes to the course syllabus tab

course

collaborations

a user goes to the collaborations index page

course

conferences

a user goes to the conferences index page

course

files

a user goes to the files index page

course

grades

a student views their course grades or a teacher views a specific student's course grades

course

modules

a user goes to the course modules index page

course

outcomes

a user goes to the outcomes index page

course

pages

a user goes to the wiki index page

course

quizzes

a user goes to the course quiz index page

course

roster

a user goes to the course users index page (the people tab)

course

speed_grader

a user goes to speedgrader

course

topics

a user goes to the discussion index page

course

home

a user goes to the course home page

assignments

assignment

a user submits an assignment via the submissions api (which is used by the canvas web app submit page)

attachment

a user downloads a file

collaboration

a user goes to a specific collaboration page

conferences

conference

a user goes to a specific conference page

context_external_tool

a user clicks on an assignment or module item and is redirected to an external tool

discussion_topic

a user goes to a specific discussion topic page

enrollment

A user clicks on a student enrollment record within a course

outcomes

outcome

a user views a specific outcome (by clicking on the title in the index page)

quizzes:quiz

  1. a user goes to a specific quiz page
  2. a user goes to the quiz history page

wiki_page

user navigated to a specific course Wiki Page

user

files

user accesses all files available to user

The following three messages are issued based on the same trigger

group

calendar_feed

a user accesses their ical or atom calendar feed, downloading feed from Canvas Calendar will trigger this message as well

user

calendar_feed

a user accesses their ical or atom calendar feed, downloading feed from Canvas Calendar will trigger this message as well

course

calendar_feed

a user accesses their ical or atom calendar feed, downloading feed from Canvas Calendar will trigger this message as well

Mobile Based Events [ mobile supported events]

discussion_topic

a user goes to a specific discussion topic page

quizzes:quiz

  1. a user goes to a specific quiz page
  2. a user goes to the quiz history page

wiki_page

user navigated to a specific course Wiki Page

 

Back to:  Table of Contents 

Attachments

    Outcomes