Setting up Canvas Live Events
Canvas Live Events allows Atomic Search to index new and updated Canvas learning content every 5–10 minutes instead of every 10 hours. This ensures that course content changes are reflected in search results much more quickly.
To enable Canvas Live Events for Atomic Search, follow the steps below.
1. Install Canvas Data Services (if not already installed):
•Browse to the root account and select Developer Keys in the left-hand Canvas navigation menu.
•Open the Inherited tab. Scroll to the bottom and select Show all keys.
•Search for Canvas Data Services on the page.
•Turn on the key beneath State.
•Copy the Client ID below Details.
•Browse to the account in which Atomic Search will be installed and select Settings > Apps > View App Configurations.
•Select +App.
•Set Configuration Type to By Client ID.
•Enter the Canvas Data Services Client ID that you copied from the Developer Keys.
2. Configure Canvas Live Events for Atomic Search:
•Install the Canvas Data Services LTI using these instructions from Canvas.
•In Canvas, browse to the root account.
•Select Data Services in the left-hand Canvas navigation menu.
•Select the +Add button to create a new Data Stream.
•Use the following settings:
•Name: Atomic Search
•Delivery Method: SQS
•URL: Select the SQS URL corresponding to your region:
•US / Canada / Central & South America:
https://sqs.us-east-1.amazonaws.com/318936073860/canvas-live-events-AJ-ACT
•Europe / Africa:
https://sqs.eu-west-1.amazonaws.com/318936073860/canvas-live-events-AJ-ACT
•Australia / Asia:
https://sqs.ap-southeast-2.amazonaws.com/318936073860/canvas-live-events-AJ-ACT
•Authentication: None
•Message Type: Canvas
•Application Type: Data Streaming
3. Select the following Events:
•Assignment:
•assignment_created
•assignment_updated
•Attachment:
•attachment_created
•attachment_deleted
•attachment_updated
•Course:
•course_created
•course_updated
•Discussion Topic:
•discussion_topic_created
•discussion_topic_updated
•Module:
•Select all
•Module Item:
•Select all
•Syllabus:
•syllabus_updated
•Wiki Page:
•wiki_page_created
•wiki_page_deleted
•wiki_page_updated
Select Save & Exit when finished.
4. Verify Canvas Live Events:
Once you have enabled Live Events, you can verify that it is working by editing a page to add unique text and then searching your course for that text. If Live Events is configured correctly, the updated content should appear in search results within a few minutes.