Delphinium is an LTI plugin for Canvas that is installed at the account level. You can learn more in the following links:
Note: While it is possible to start the Delphinium installation in a course or sub account, it will not install properly. You will need to install Delphinium in the root account of the Canvas Admin area using the instructions below. After you install Delphinium through the Canvas admin, it will be installed (but disabled) in EVERY course and you will not need to install it again on your account or in your courses.
Enabling Delphinium in your Canvas requires two parts:
Installing Delphinium
Giving Delphinium permissions
Note: Click here for instructions from Canvas
In your root Canvas account, click Developer Keys in the left hand menu
The "Developer Keys" page will appear
At the top of the page, click the Inherited tab
The list of "Inherited Developer Keys" will appear
Scroll to the bottom the page and click Show All Keys
A full list of inherited keys will appear
Use the search box at the top of the page to find the "Delphinium API" and "Delphinium" developer keys
Click the toggle in the "State" column for each developer key to enable it
Note: Click here for instructions from Canvas
In your root Canvas account (or sub account if your Delphinium license does not include the root and all sub accounts), click Settings in the left hand menu
The "Settings" page will appear
Click Apps in the tabs across the top of the page
The "External Apps" page will appear
In the top right, click View App Configuration
A "list of apps" will appear
4. Click + App
The "Add App" popup will appear
5. Configure the following settings
Configuration Type: By Client ID
Client ID: 170000000000719
6. Click Submit
You will be asked to confirm, click Install
"Δ Delphinium" will appear in the "External Apps" list
7. Refresh the page
"Δ Delphinium" will appear in the left hand menu
In this final step, you will submit information required to complete the installation process.
In your root Canvas account, click the Δ Delphinium link that you created in step 2 above in the left-hand menu
The "Welcome to Delphinium!" page will appear
2. Fill out the "Register to Begin Your Demo" form
Include "First Name", "Last Name: ", "Phone Number", "Email Address", and "Job Title", preferably of an administrator or someone who can represent your organization
Include "Organization Name", "Canvas Admin Name", "Canvas Admin Email", "Canvas Admin Phone Number", "Organization Size", "Organization Website" (including 'http://')
Optionally, include a short "Note" about your goals for Delphinium or any questions you would like to ask us.
Click Submit
After a few moments, the "Thank you for your demo request!" page will appear
Note: At this point, Delphi M.E. will be notified that you registered for a Delphinium demo. If you are not already working with Delphi M.E. employees to set up the demo, one will contact you and discuss any other steps required to activate your demo.
3. Wait for a Delphi M.E. employee to notify you that your demo has been approved.
Note: Delphinium is now installed, but disabled, in every course in your Canvas account. Use this tutorial to learn how to enable Delphinium in a course.
Delphinium uses a combination of a scoped token and a restricted administrator role to limit access and protect your Canvas data. In this tutorial, we will configure the Delphinium Service administrator role. The Delphinium Service role has very limited permissions and only gives Delphinium access to Canvas data that it needs to function properly. The Delphinium Service role is further restricted by the scope of the token it uses. This tutorial assumes you have already installed Delphinium.
Open the Canvas Admin area as a user in the ROOT account
Open the People page
Click +People
Add "Delphinium Service" to the Full Name field
Add "support@delphi-me.com" to the Email field
If necessary, add "support@delphi-me.com" to the SIS ID field
Uncheck the Email the user about this account creation box
Click Add User
Open the Permissions page
Open the Account Roles tab
Click Add Role
Add "Delphinium Service" to the Role Name field
Click Save
Click X to close the new account pane
In this step we create a Canvas role with NO assigned permissions and add a small number of permissions that allow Delphinium to see account level data like grading schemes and groups.
For each of the following terms...
Groups - view all student groups
Users - view list
Statistics - view
Grades - edit
...follow these steps:
Use the Search permissions box to search each term above
Click the red circled X icon
Click Enable, the icon will change to a green check mark
Next,...
Search for the term "Manage groups"
Click the down arrow icon
Check the box to the right of the Groups - manage row
Delete the text from the Search permissions box
7. Click the column header for Delphinium Service to confirm that the Delphinium Service has no more or less permissions than is described above
Open the Settings page
Open the Admins tab
Click + Account Admins
Add "support@delphi-me.com" to the Copy and paste a list of email addresses to add users box
Select Delphinium Service from the Add More drop down box
Click Continue...
Click OK Looks Good, Add This 1 User
Return to the People page
Search for "support@delphi-me.com" in the Search people... box
Click the Act as icon for the Delphinium Service user
Click Proceed
Open the Delphinium page
Open the Credentials tab
Click Authorize Delphinium in this Account
Click Authorize
Confirm that it says "Delphinium Service" below Delphinium Service Admin User
Click Stop Acting as User
You are done! If you have any challenges, reach out to us at support@delphi-me.com.
Delphinium uses a read-only Canvas Data 2 key to securely access the analytics data it needs while protecting the rest of your Canvas environment. In this tutorial, we will generate a Canvas Data 2 key in Instructure's Identity Service and share its credentials with Delphinium. The key provides read-only access to your Canvas Data 2 dataset only — it cannot modify any data in your Canvas instance — and you can revoke it at any time from the same Identity Service console where you created it.
Note: This step must be completed by a Canvas user with root admin permissions.
Click the Institution dropdown box
Type to search for your institution name
Your institution should appear on the list
Note: If your institution does not appear on the list, contact your Delphinium sales rep and we will request that Identity Services is enabled for your account
Select your institution name
Click Log into Canvas
If necessary, complete the Canvas login page for your Canvas account
The Identity Services Keys page will appear
Click + Add New Key
The Add New Key panel will open on the right side of the screen
Set Key Name to "Delphinium
Set the Scope to "Canvas Data 2"
Set Expiry to "3 years"
Set Key Type to Instructure Partner
Click +Add New Partner
The Add New Partner popup will appear
Click the Select Partner dropdown box and select Delphi M.E.
Set Email to "ds2@delphi-me.com"
Click Submit
The Add New Partner popup will close
Select Delphi M.E. from the Partner Name list in the Add New Key panel
Click Save
The Confirm sending key popup will appear
Click Send
The Confirm sending key popup will close, and after a moment, the Verify 'Delphinium' pupup will appear
Check your admin email, you will receive an email from Instructure, copy the verification code
Paste the verification code into the 6-digit code field in the Verify 'Delphinium' popup
Click Verify
The Verify 'Delphinium' popup will close
Delphinium key will appear in the list of keys with the status of Pending
Delphi M.E. will receive the the new key notification and accept the key and the status will be updated to Active
Canvas Live Events lets Delphinium receive student activity in near real time — events like page views, submissions, and course changes are streamed to Delphinium as they happen, which is what powers features like Control Tower's live engagement view. In this tutorial, we will configure Canvas Data Services to securely forwards these events to Delphinium. You choose which event categories to subscribe to, the stream only sends activity data — it never lets Delphinium change anything in your Canvas instance — and you can pause or delete the stream at any time from the same Data Services page where you created it.
Note: This step must be completed by a Canvas user with root admin permissions.
Open the Canvas Admin area as a user in the ROOT account
Open the Data Services page
Click +Add
The Configure New Data Stream page will appear
Set Name/Title to "Delphinium"
Set Delivery Method to "SQS"
Set URL to "https://sqs.us-east-1.amazonaws.com/315082872936/dataStreamQueue-prod "
Set Authentication to "AWS Credentials"
Set AWS Key to "AKIAUSXDHDBUJBU4PBCJ "
Set AWS Secret to "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"
Set AWS Region to "us-east-1"
Set Message Type to "Canvas"
Set Application Type to "Data Streaming"
Select the Event Subscriptions as shown in the image to the left
Click ⤓ Save & Exit
You will return to the Data Streaming Options list and Delphinium will be added to the list
Enable the Analytics API
Delphinium uses the Canvas Analytics API to get student page views and participations data.
Open this link: [YOUR CANVAS URL]/accounts/self/settings#tab-features
Find and enable the New Course and User Analytics feature (see image to right).
Note: This feature is sometimes hidden by default. If you don't see it, you will need to open a case with your CSM who can enable it in your Canvas account.
Internet Filter
If your organization uses an approved URL list to filter internet traffic, you'll need to add this URL for Delphinium to function properly:
delphinium3.com