Myshowcase.me Canvas Integration

Myshowcase.me now includes a powerful integration with the Canvas LMS. Sync your course and user data so you don't have to maintain it in two places; give your learners and staff access to the leading lifelong eportfolio from directly within Canvas!



Introduction

This page describes the Myshowcase Canvas Integration functionality which is now available in Myshowcase.me.

The integration is designed to be very simple from the point of view of the end user. All a student or learner has to do is to visit a course where Myshowcase.me has been ‘enabled’ or added as a tool. The first time they do this, the integration will create a new Myshowcase.me account for them or allow them to link a pre-existing Myshowcase.me account. Myshowcase.me will then open within Canvas for that user (who, if they choose to use an existing Myshowcase.me account will be prompted to sign in on that first run, to verify it is their account.

Following this initial validation, every time the user is logged into Canvas they will be able to access Myshowcase.me within any relevant course without needing further validation. The integration has been designed to feel native to Canvas, so that users aren’t given the impression of being passed between systems.

In order to make things so simple for the end user, there is a certain amount of setup that the Canvas/Myshowcase.me administrators must undertake. This guide walks through the setup process.

What’s New

  1. A Myshowcase Canvas app has been created allowing Canvas users to click a ‘Myshowcase’ button within Canvas, which then displays their Myshowcase personal account inside Canvas. On first launching the app, the user follows a simple handshake procedure in order to authenticate their Myshowcase account, or create a brand new one for them, using their Canvas login email.

  2. Myshowcase external integration with Canvas allowing a Myshowcase admin user to sync their Canvas Account, Course, Group, Teacher, T.A. and Student structure with their Myshowcase organisation/group/user structure.

Using Myshowcase.me in a Canvas environment

This section provides some background on how administrators set up the integration between Myshowcase.me and Canvas. It is a simple, standard process that will be familiar to many learning management system admins, but for those unfamiliar with the process we give a bit of background detail.

Installing the app

There are two ways to install an app in Canvas: manually and using the Canvas ‘App Center’. Both methods require the installer to generate OAuth credentials called a ‘Consumer key’ and a ‘Shared secret’ which are then inputted (typed or copied and pasted) into Canvas during installation.

The walkthrough guides later in this document take you through each process.

What is a handshake?

The ‘handshake’ refers to a mechanism whereby the Canvas system ‘proves’ to the Myshowcase system that it has been approved access to it.

This Canvas to Myshowcase integration uses the industry standards for learning technology authentication called ‘LTI’ and ‘OAuth3’.

Myshowcase holds a ‘secret key’ which when combined with a ‘shared key’ generates a ‘signature’.

When Canvas makes a request it uses the shared key and secret key provided by Myshowcase, during installation of the app, to generate a signature and then sends this as part of the request to launch Myshowcase.

Myshowcase can then generate a signature and ensure that Canvas sent signature matches. If the signature generated by Canvas matches the signature generated by Myshowcase we know the Canvas request is secure and verified.

Canvas and Myshowcase user scenarios

Here are the various scenarios that a user coming to the Myshowcase.me canvas app may face, increasing in complexity:

  1. The user has no preexisting Myshowcase.me account. In this case, the integration will automatically create a new account for the user using their canvas email address. Subsequent access to the Myshowcase.me account will be granted automatically as long as they are signed into Canvas.

  2. The user already has a Myshowcase.me account with their canvas email address and this is the first time they’ve launched Myshowcase.me within canvas. When prompted they enter their password, and they are authenticated with Myshowcase.me and can access their account from within Canvas. Subsequent access to the Myshowcase.me account will be granted automatically as long as they are signed into Canvas.

  3. The user has a Myshowcase.me account but with a different email to their canvas email. At the point where they would normally be given a new account, they are prompted to enters the credentials for their existing account; and once signed in they are able to use it from within Canvas. Subsequent access to the Myshowcase.me account will be granted automatically as long as they are signed into Canvas.

  4. The user has a Myshowcase.me account of their own. However their Myshowcase admin has also created them an account when they used the Canvas-to-Myshowcase sync tool. At the point where they would normally be given a new account, they are prompted to enters the credentials for their existing account; and once signed in they are able to use it from within Canvas. Additionally:

    • the organisation/group allocations and role allocations from the sync-created account get copied to their existing account, so the existing account ‘knows’ which courses they are registered on and which activities they should have access to within Myshowcase.me based on the synced information, and

    • the sync created account is made inactive.

    Subsequent access to the Myshowcase.me account will be granted automatically as long as they are signed into Canvas.

Canvas Myshowcase Launch Decision Tree

This decision tree illustrates the various routes a canvas user will take when they launch Myshowcase.me for the first time within Canvas and what prompts they may encounter. In reality, we’ve been able to keep the UI very simple:

Myshowcase.me Canvas sign-in
decision tree

Walkthroughs: Installing and setting up the app

This section looks at how an administrator managing Canvas and Myshowcase.me goes about setting up the integration.

Installing the Myshowcase.me app in Canvas manually

  1. First you need to generate OAuth credentials so go to https://app.myshowcase.me/#!/lti/pairings

  2. Enter your canvas url then click ‘+ Generate pairing’

  3. Keep this window open so you can copy each piece of data into the installation

    image

  4. Sign into your Canvas environment as an admin

  5. Go to Admin > Settings > Apps

    image

  6. Click ‘+ App’ to launch the app installation window

  7. In configuration type select ‘By URL’

    image

  8. In name enter ‘Myshowcase’

  9. In Consumer key, Shared secret and Config URL enter the relevant value from the Myshowcase.me LTI pairings generator

    image

  10. Click submit and the app will install

    image

Install the Myshowcase.me app in canvas using the app center

  1. Firstly, generate OAuth credentials by going to the LTI pairings generator tool at This is at https://app.myshowcase.me/#!/lti/pairings

  2. Enter your Canvas url then click ‘+ Generate pairing’

  3. Keep this window open so you can copy each piece of data into the installation

  4. Sign into your canvas environment as an admin

  5. Go to Admin > Settings > Apps

  6. Click ‘+ App’ to launch the app installation window

  7. In configuration type select ‘By URL’

  8. In Name enter ‘Myshowcase’

  9. In Consumer key, Shared secret and Config URL enter the relevant value from the Myshowcase LTI pairings generator

  10. Click submit and the app will install

Disconnect your Canvas connection from the settings menu

You can disconnect from Canvas meaning next time you try to access Myshowcase from Canvas, you will follow the appropriate connection procedure again.

  1. In Myshowcase.me go to the settings menu

  2. Select ‘Manage connections’

    image

  3. The text explains that you will be disconnecting from Canvas and will be prompted to re-connect next time you access through Canvas

    image

  4. Click disconnect and the text tells you that you have no Canvas connection

    image

  5. The ‘Manage connections’ option disappears

    image

  6. Go to Canvas and try and access Myshowcase. You are presented with the connection prompts

    image

Walkthroughs: Myshowcase Canvas Sync tool

You can synchronise course information within Canvas with Myshowcase and automatically create users and groups within Myshowcase.me based on your Canvas course and group structures.

The following assumes you have set up an admin account, if not please do so first by visiting https://admin.myshowcase.me/#!/register and completing the registration form. Once this has been done, you will have an organisation and can follow these steps to set up the integration with your Canvas environment:

Generate a developer key in your Canvas environment

  1. In your Canvas environment, as system admin, go to Admin > Developer Keys > + Developer Key

    image

  2. In the new Developer Key window enter the following:

    image

  3. Make a note of the generated ‘ID’ and ‘Key’

    image

Add a Canvas integration into your Myshowcase admin environment

  1. Signed into the Myshowcase admin site go to System Settings > Integrations > Add integration

    image

  2. In the Add integration window enter the following:

    • Connection type: Canvas LMS

    • Connection name: Canvas

    • System Url: Your Canvas url, including the ‘/’ at the end

    • Client ID: The Developer Key ‘ID’ from Canvas

    • Secret key: The Developer Key ‘Key’ from Canvas

    image

  3. Go to the Personal Settings side tray then Integrations

  4. Click ’Connect to Canvas’ then check the window states you are authorising with an admin account

    image

  5. Click ‘Authorize’

    image

  6. You will see the ‘Successfully connected Canvas’ screen

    image

  7. You will see a new menu option on the left, ‘Canvas’ with ‘Sync’ and ‘Sync history’ as sub options

    image

Sync Canvas data with Myshowcase admin

  1. In Myshowcase admin, go to Canvas > Sync and you are presented with three options:

    • Choose what to sync

    • Update what’s already synced

    • Sync your full structure

    image

  2. Click ‘Choose what to sync’ which will proceed to interrogate your Canvas environment

    image

  3. Once completed you are able to select which data you want to bring into Myshowcase. Select some data then click ‘Sync selected items’

  4. The sync will proceed and you are notified when it has completed

    image

  5. You can re-evaluate this sync at any time by going to Canvas > Sync history > View detail

    image

  6. Go to Users > Organisations/Groups to see that the structure has been updated with Canvas data

    image

  7. Go to Users > Users to see that the users from Canvas have been brought into Myshowcase

    image

Walkthroughs: Accessing Myshowcase.me as a user

This section looks at how users access their Myshowcase.me account and create a lasting link to their account within Canvas.

Launch the app and get a Myshowcase.me account created

  1. After an admin has created your account (see below) sign into Canvas as a student and go to a course where the Myshowcase app is available

  2. Click the ‘Myshowcase’ app button on the left hand menu

    image

  3. You are told that a new account will be created

  4. You also get the option to link an existing account

  5. Click ‘Create account’

    image

  6. In the background a Myshowcase.me account is created using your canvas email

  7. A ‘connection’ record is generated containing your canvas user information and Myshowcase.me information meaning each time you enter the app, you can go straight in

  8. You now see Myshowcase.me within canvas

    image

Launch the app with a Myshowcase.me account that matches your Canvas email – prompted for password

  1. Make sure you have a Myshowcase account using the same email address as your Canvas user

  2. Go to a course that has the Myshowcase app available

  3. Click the Myshowcase app button

  4. You are prompted to enter your Myshowcase.me password

  5. Enter your password then submit

    image

  6. In the background your credentials are checked in Myshowcase.me

  7. A ‘connection’ record is generated containing your canvas user information and Myshowcase.me information meaning each time you enter the app, you can go straight in

  8. You now see Myshowcase.me within Canvas

    image

Launch the app and connect a Myshowcase.me account with a different email to the Canvas email

  1. Make sure you have a Myshowcase account and make note of the login email

  2. Login to Canvas with a user that hasn’t connected with Myshowcase.me yet

  3. Go to a course that has Myshowcase available

  4. Click the Myshowcase.me app button

  5. You are told that a new account will be created but instead enter details of your Myshowcase account then Submit

    image

  6. In the background a connection record is generated linking your canvas info with your Myshowcase.me info allowing you to launch Myshowcase.me

  7. You now see Myshowcase.me within canvas

    image

Launch the app when an admin has already created you an account using the sync tool, but you want to use your own Myshowcase.me account

  1. Make sure you have a Myshowcase account

  2. To test the admin side of this workflow, you can go to Myshowcase.me admin, use the Canvas > Sync > Sync your full Canvas structure or Choose what to sync option to create orgs/groups and users from your Canvas environment in Myshowcase

    image

  3. Make a note of one the user that is created (you’ll need their username and password)

  4. To test the user side of this workflow, sign into Canvas as that user

  5. Click the Myshowcase.me app button

  6. You are prompted to enter credentials of a different Myshowcase.me account, so enter the details of the Myshowcase account that was not created in the sync

    image

  7. Next you are prompted to merge accounts or not, select ‘Yes, merge my accounts’ – doing this means that you are only ever going to use the account you are merging into (‘billblend@myshowcase.me’ in this example). Keeping both accounts means you connect canvas to the sync created account, but have this other account that you can also use outside of canvas

    image

  8. In the background a connection is made between your canvas info and your Myshowcase.me info, the organisation/group allocations for the sync created account are copied to your actual account and the sync created account is made inactive

  9. You now see Myshowcase.me within canvas

    image

Want a demo? Get in touch!

Get in touch and find out how Myshowcase.me can support your learners.