Creating a Canvas Integration with Degree Analytics

There are two primary stages.

1. The first is setting up Degree Analytics to be able to ingest Canvas data

2. Configuring Canvas to send data to Degree Analytics

Step 1: Configuring Degree Analytics for Canvas

As a Degree Analytics School Admin, you can create an Canvas Integration

1. Select the Schools Tab and then Click on Your School

   Open

   

2. Select Integrations

   Open

   

3. Scroll down to Canvas and select Connect

   Open

   

    

4. You will then be provided with an Access Key, Secret Key, and SQS URL that will be needed for configuring Canvas

   Open

   

Step 2: Configuring Canvas to Send Data to DA

Note: the following documentation is largely coppied over from Canvas at the following link: https://community.canvaslms.com/t5/Admin-Guide/How-do-I-subscribe-to-Live-Events-using-Canvas-Data-Services/ta-p/227 Some adjustments have been made for the specific DA integration below.

As an admin, you can subscribe to Live Events and receive a real-time set of events from your Canvas Account. You can choose which events in Canvas you want to subscribe to. You will need to maintain an Amazon Web Services queue to receive Live Events data.

Note: To receive Live Events data, you will need to subscribe to Amazon Web Services in order to maintain a queue.

1. Open Account

Click the Admin link [1], then click the name of the account [2].

2. Open Data Services

In Account Navigation, click the Data Services link.

3. Add Data Stream

Open

To create a new data stream for your account, click the Add Stream button.

4. Configure Data Stream

Open

Enter a title for your stream in the Name/Title field: degreeanalytics

Select an SQS.

Enter your provided SQS URL

5. Configure Amazon SQS Data Stream

Select the AWS Credential in the Authentication field [1]. Then enter the additional AWS Key, and AWS Secret provided by Degree Analytics in the Step 1

Select Canvas as the Message Type in [6]

Open

6. Select Subscriptions to Send to DA

Here is a full list of available and not supported subscriptions:

• Account

• Asset

• Assignment

• Attachment

• Content

• Conversation

• Course

• Discussion

• Enrollment

• Grade

• Group

• Learning

• Logged

• Module (not supported)

• Outcome (not supported)

• Plagiarism (not supported)

• Quiz (not supported - these are for old quizzes)

• Sis (not supported)

• Submission

• Syllabus (not supported)

• User

• Wiki (not supported)

Open

Select the subscriptions you want to include in your data stream.

To search for specific events, type the event name in the Search Events field [1].

To include all events in your stream, click the Subscriptions checkbox [2]. Selecting this option includes all event types as well as user and system generated actions.

To subscribe to events triggered by an action directly performed by and end user, click the User Generated checkbox [3]. User generated events include information about web requests, browser and user data in event metadata, and details about objects affected by the change.

To subscribe to events triggered by asynchronous jobs, click the System Generated checkbox [4]. System generated events include data about processes that triggered an event as well as details about objects affected by the change.

You can also subscribe to event groups. To subscribe to all items in a group, click the checkbox for the group [5]. You can also select to include only User or System Generated data [6].

To subscribe to individual events, click the Arrow icon for the subscription group [7] and click the checkbox for the subscription you want to add [8].

Note: The image in this step shows subscription options for the Canvas message type. The options for the Caliper 1.1 message types are different, but the steps to subscribe are the same.

7. Save Data Stream

Open

To save your data stream, click the Save & Exit button.

Validate with DA

Contact your DA representative to validate that event data is flowing!