Summary Using this guide, an administrator of the Canvas environment together with an integration specialist of Drieam can do the technical installation of StudyCoach. Roles
|
This page will guide you as an admin-user of StudyCoach or as a functional manager through the technical installation process of StudyCoach. Please take your time to follow this guide.
After you have completed this technical installation, you can proceed with the functional configuration of StudyCoach. A manual for the functional configuration can be found on this page.
Table of contents
- Terminology
- Prerequisites for the installation
- Preparing the Canvas environment
- Installation
- Configuration
Terminology
| Term | Description |
|---|---|
| Global navigation menu | The global navigation is the leftmost menu bar in Canvas. If StudyCoach is installed on the root account, StudyCoach will appear in this menu bar. |
| Root account | In Canvas, all your sub-accounts are linked to a root account. In most cases, you can access this sub-account by going to https://yourinstance.instructure.com/accounts/1, replacing "yourinstance" with your Canvas instance URL. |
| Consumer key | This is a key that we (Drieam) provide you. This is your license for StudyCoach together with your Consumer Secret. |
| Consumer secret | This is a secret key that we use to verify your license. |
| Config URL | This is a URL that contains the configuration needed by Canvas to install StudyCoach. |
Prerequisites for the installation
Before you can start installing StudyCoach we (Drieam) need to create a pair of keys for you. In order to generate those keys, we need to have your Canvas-instance URL (for example drieam.instructure.com). Please contact us if you don't have those keys.
Please keep in mind that this guide is focused on installing a pilot version of StudyCoach. Therefore it is required to create a separate user account with admin rights for StudyCoach. StudyCoach uses a token of this admin user to request provision reports to import the data that is needed to scores per behavioral indicator The installation token that is used to connect StudyCoach to the Canvas-environment needs the permissions for users to add/remove observers. The admin user needs to have the following permissions:
- Analytics - view pages
- Course content - view
- Courses - view usage reports
- Grades - view all grades
- SIS Data - read
- Statistics - view
- Users - Observers
- Users - act as
- Users - view list
Attendance
In order to use the attendance data in StudyCoach, it is necessary to install the attendance tool within Canvas. You can find more information regarding this attendance tool on this page. You can contact your Canvas Customer Success Manager to enable the attendance tool (if it is not enabled yet).
Preparing the Canvas environment
1. Add the app to Canvas
Go to Admin > Settings > Apps and add a new app.
Add the XML you will get from our implementation specialist, see example below.
2. Create a new user
Go to Admin > Settings > People and create a new user. Make sure you use an email address you have access to. You need to create an account and log in with this account in the fifth step.
3. Make sure this user has the right permissions.
Go to Permissions > Account roles and add a StudyCoach admin user with the following permissions:
- Analytics - view pages
- Course content - view
- Courses - view usage reports
- Grades - view all grades
- SIS Data - read
- Statistics - view
- Users - Observers
- Users - act as
- Users - view list
4. Add the user as an admin to the sub-accounts you want to enable for this pilot
Go to the different sub-accounts and add the user to those accounts as an admin with the freshly created StudyCoach admin role.
It is also possible to and add the user with the StudyCoach admin role here.
5. Login and create access token
Go to Account > Settings > Approved integrations. Generate an access token for the freshly created account. Keep this token. Next step is for Drieam to add it to the StudyCoach admin at our side. We need it to make sure that StudyCoach can access the data.
Installation
You can choose whether you want to make StudyCoach accessible via the global navigation menu, via the course menu or via both. More information about this choice can be found on this page. We at Drieam would like to advise you to at least make StudyCoach accessible via the global navigation menu so that a course-transcending overview will be visible to the managers, (department)coaches, teachers and students. When StudyCoach is also accessible via the course menu, it is possible to easily consult the Learning Analytics in StudyCoach through the Canvas environment at course level without first navigating to that specific course in StudyCoach via the global navigation menu.
Course menu
As a functional manager or admin-user, go to Admin > Settings > Apps > View App Configurations > Add and fill in the following fields:
| Configuration Type | By URL |
| Name | StudyCoach (this name can be modified appropriately and is the name that users see when they access StudyCoach via the course menu) |
| Consumer key | The consumer key that we provided. |
| Consumer secret | The consumer secret that we provided. |
| Config URL | https://app.studycoachapp.com/lti/configs?no_global_navigation |
(⚠ Do this for all the sub-accounts on which you want to enable SC)
Global navigation menu
Go to Admin > Settings > Apps > View App Configurations > Add and fill in the following fields:
| Configuration Type | By URL |
| Name | StudyCoach (this name can be modified appropriately and is the name that users see when they access StudyCoach via the global navigation menu) |
| Consumer key | The consumer key that we provided. |
| Consumer secret | The consumer secret that we provided. |
| Config URL | https://app.studycoachapp.com/lti/configs?no_course_navigation |
Congratulations, StudyCoach has now been successfully installed in your Canvas environment. But beware, to prepare StudyCoach for use, there are still a few steps in StudyCoach needed. In the next section, we will help you realize the technical configuration of StudyCoach.
Configuration
Once StudyCoach is installed, you have to do a one-time launch. After launching the app, please send us the email address that you use in Canvas (contact us). After receiving your e-mail address, we give you the manager role of your institute). From that moment on, you can add managers yourself through the StudyCoach-interface.
1. Add the generated user access token to StudyCoach
Go to Settings > General > Canvas access token.
2. Enable the right sub-accounts
Please enable StudyCoach for the sub-accounts that are going to use the app. Make sure that all the selected sub-accounts are added to the StudyCoach User as an admin (see Preparing Canvas environment).
Go to Settings > Data sync > Accounts to do so.
3. Wait
Now the only thing that rests to do is waiting. Unfortunately, we are only able to sync your Canvas instance once a day. The sync takes place every night. However, if you want to have a result right away, you can always contact us to initiate a manual sync.
Questions? Feedback? Need help?
Feel free to contact us.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article