(NEW)Guide: How to Install the Enhanced Portfolio LTI in Canvas

[#1]

 

Overview

This document describes how Canvas admins can install the Enhanced Canvas Portfolio LTI tool into their Canvas instance. After installation, instructors/course designers and learners will be able to start using the new Portfolio tool.

Important: Portfolio inherited keys are now available in production, beta, and test environments.

 

Prerequisites

Before you begin, make sure you have:

• Admin access to your Canvas environment (or permissions to manage External Apps / Developer Keys).
  
  

• Remove Previous LTI Installations

  • Before installing the new Portfolio LTI, please remove any previous versions of the Enhanced Canvas Portfolio from your Canvas environment. (Note: Folio LTI does not need to be removed—only the Enhanced Canvas Portfolio if you used it already during our feature preview phase.)

    1. In Account or Course Navigation, click Settings.

    2. Click the Apps tab.

    3. Click View App Configurations.

    4. Locate any existing Portfolio LTIs in the list and click the settings icon and click Delete.

    This ensures that the new installation will not conflict with previous configurations.

    

Step-by-Step Installation

1. View inherited developer keys
In Account Navigation, click on the Developer Keys. To view inherited keys, click the Inherited tab.

2. Show All Keys
Scroll to the bottom of the list and click the Show All Keys button. Locate the Portfolio API (e.g. Portfolio <Region code>) and LTI keys (e.g. Portfolio <Region code> LTI Client) in the list.

3. Enable the Portfolio API Key and LTI Client
To enable both the Portfolio API key and LTI Client, click the On toggle.

 

4. Confirm Key State
A prompt displays asking you to confirm changing the key's state for both the API Key and the LTI Client. To confirm the change, click the Switch to On button. 

5. View App Configurations
You can install the Portfolio LTI at the account, subaccount, or course level. In Account or Course Navigation, click the Settings link. Click the Apps tab. To view app configurations, click the View App Configurations button.

6. Add App
Click the Add App button.

7. Installing the Portfolio LTI
In the Configuration Type dropdown, select the By Client ID option. Type the client ID (this needs to be the LTI Client that you previously toggled ON) for your regional server into the Client ID field.

• Portfolio US I.(IAD) – 170000000001967
• Portfolio US II. (US PDX) – 170000000001973
• Portfolio Canada(CA YUL) – 170000000001969
• Portfolio Singapore(SG SIN) – 170000000001972
• Portfolio Sydney (AU SYD) – 170000000001975
• Portfolio EU I. (EU FRA) – 170000000001977
• Portfolio EU II. (EU DUB) – 170000000001980

Click the Submit button.

Note: If you attempt to install the LTI before enabling the API and LTI keys, you will encounter an error stating that the client ID is disabled.

8. Confirm Installation
When the Add App prompt appears, click the Install button.

9. Select Placements
After installation, you must choose where the Portfolio LTI should appear in Canvas.

In the Placements modal, select one or more of the following:

• Account Navigation – adds Portfolio access at the admin/account level
• Course Navigation – adds Portfolio access in the course navigation menu
• Global navigation - adds Portfolio access to the global navigation
• User navigation - adds Portfolio access to the user navigation under “Accounts”
  
  

Click “X” to enable one or more placements.

[ldavenport4015]

@Dalma_Schnell Thank you so much for this! As one who has to install it in the test environment every month, I am excited to see it in the Inherited Keys list now! 

Looking forward to continued development of this feature in Canvas! 

[suzanne_pathki1]

Hi @Dalma_Schnell I am trying to delete the existing LTI and receiving an error message. See the recording I made: https://app.screencast.com/GZjTUH26bZYXg.

I was able to delete the developer key API without problem.

/Sue

[DavidSchlater]

I am confused here and could use some help - is Folio (accessed from the User Profile for us) going away? It still works today on our server.

We never promoted this widely, but we do have 22 users and I will need to let them know their work is going to be inaccessible and on what date and there is no way to migrate any projects they made, if this is true.

I am talking about folio projects kept here https://portfolium.com/davids4/portfolio

[jmagee1]

@Dalma_Schnell We still have "ePortfolios" in our user account menus and I could not find anywhere to delete this in beta. It's not in apps or developer keys that I can see. I installed Portfolio in beta and it's now showing in the user account menu as well, but this message comes up when the Portfolio link is clicked: 

Is this because the old ePortfolio LTI is still installed? We didn't install that one to my knowledge; it was already there when we transitioned to Canvas 6 years ago.

[Dalma_Schnell]

Hi @ldavenport4015,

Great to hear you’re exploring the tool! Just to clarify, with this update the dev keys won’t be copied to the Test environment so Test would still require the old LTI installation method. They will be copied to Beta this weekend. We’re also supporting subaccounts as a way to test the product with a specific cohort in the production environment. Have you considered trying that as an alternative?

[Dalma_Schnell]

Hi @suzanne_pathki1,

Thanks so much for sharing the recording! There’s actually a bug on the Canvas side that prevents deleting the key, but don’t worry this won’t affect the new LTI registration. What you’ll need to do instead (as listed in this guide under "Prerequisites") is delete the app from Settings. 

Let me know, Sue, if you’re able to successfully install the LTI that way!

[Dalma_Schnell]

Hi @DavidSchlater,

Sorry the guide wasn’t concrete enough on this point! To clarify we only meant the Enhanced Canvas Portfolio needs to be removed, not other LTI tools. Many institutions used that new tool during the feature preview or even earlier phases like our EAP, and those versions need to be uninstalled before installing this new version of the Portfolio LTI.

Hope this clears things up, and thanks for flagging the confusion! I also updated the guide to reflect this.

[Dalma_Schnell]

Hi @jmagee1 ,

Only previous Enhanced Canvas Portfolio versions need to be uninstalled; other tools, like Folio or ePortfolios (this is a native solution and not an LTI) already in user menus, are not affected.

Since you’re seeing that error, have you already deleted the previous Enhanced Canvas Portfolio from Settings > Apps and installed the new Portfolio following the updated guide or is this the first time you were trying to install the new Portfolio LTI? That delete step from Apps is required to prevent this message from appearing.

Let me know how it goes, and if the issue persists, please reach out to Canvas Support, they can guide you to our team for further assistance.

[JeffLloyd]

Thanks for the updated guide. I am getting an error while installing in Beta - this with the Sydney 'Portfolio AU SYD LTI Client'. Any clues? 

{"statusCode":500,"message":"Internal server error"}

[JarrodHiles]

Hi @Dalma_Schnell, same as @JeffLloyd and @jmagee1, we are also getting a 500 internal server error. We are in the Syd region. We're also following up with our CSM and will log a ticket. 

[JeffLloyd]

Thanks @JarrodHiles . I tried other regions as well, to the same effect. 

[jmagee1]

@Dalma_Schnell We actually met with our CSM last week and she was able to confirm that we don't have the Enhanced Canvas Portfolio installed, so that's not the issue. She put in a ticket for us so hopefully this is fixed soon.

[reynlds]

500 Error in my TEST environment. Should this go to Prod or Beta?

[AndrewDwyer]

{"statusCode":500,"message":"Internal server error"}

 Error in Test and in Beta 

[suzanne_pathki1]

@Dalma_Schnell I was able to install the new without removing the existing LTI key. I just deactivated it instead.

[hmcneill]

@Dalma_Schnell I contacted support two weeks ago for advice on installing this on our Test environment, and was told this was possible. I've spent time and raised another ticket today as I was receiving a 500 Internal Server error in Canvas, only now noticing the message added to this page which says that the developer keys will only work in Production.  Support did not seem to know that the developer keys can't be used in Test. 

Is there any way to add the tool without using developer keys, if so, has this information been shared somewhere else? 

We are reluctant to try this in production without some initial view of the functionality and testing, particularly because we have another portfolio integrated and we need to understand the impact of having both tools active. 

[herbert_serrano]

I get the same error, and when I reached out to Support I was told it was a known issue. 

Instructure support has gotten terrible in the past 2 years. It used to be "okay" but now it is just like rolling the dice as to whether you will get a helpful response or get something that is completely useless. Instructure is now in its peak Crapification form. 

[FrankMcHale]

Hi,

I'm trying to install the new ePortfolio. Which of the LTI options are suitable for UK installation? 

[ldavenport4015]

@hmcneill We have installed Portfolio only in Test and the old instructions for installation worked for us. I have linked them here, because I don't see them available anywhere on the community. 

Enhanced Portfolio LTI Configuration: Part 1 – LTI registration

Enhanced Portfolio LTI Configuration: Part 2 – App installation & Enable/Disable Placements

Joyfully,
Lynn

Lynn Davenport
Learning Management System Policy Administrator
Texas Woman's University

[susanna_bjorver]

Hi,

Is this guide still valid after the GA? I am asking cause I have been unable to get Portfolio working after GA. We had it working before, but right now I am only getting status error 500 

  "statusCode": 500,
  "message": "Internal server error"

I see previous comments about this error in beta or test, but this is on our production server...

So I tried removing everything (deactivating the inherited developer keys and removing all App configurations with Portfolio...) from before GA and reinstalling according to this guide, but no go... 

I have activated the inherited Developer Key Portfolio FRA and Portfolio EU FRA LTI Client. I have tested adding the app to thethe subaccount (where we want it) as well as the root account (where we are not really ready to activate it yet). Setting Placements work wonderfully and the Portfolio meny item shows up. But following it does not work.

Before GA I am pretty sure we activated the general Portfolio LTI Client (170000000001986) , but this guide explicitly says to activate the region Client, so that is what I did...

Also to be noted, I did not get a new request to authenticate, so I ensured I had no existing API approved integrations active

Anyone else seeing this and have any good insights as to what might be going on?