Uninstalling DesignPLUS
Admin Guide Uninstalling DesignPLUS
If you are visiting this page, it is likely that your time with us has drawn to an end. We are sad to see you go but hopefully this guide will help you quickly and easily remove DesignPLUS from your Canvas instance.
Frequently Asked Questions
What happens to my content if I stop using DesignPLUS?
Any elements that require JavaScript for dynamic page functionality like accordions and quick checks will no longer render as interactive elements. These elements will deprecate to plain headings and text. Learn more about which content features rely on JavaScript to work. Links to an external site.
Any styled elements such as banner headings or content blocks will revert to plain styling (unless you keep a copy of the CSS provided by Cidi Labs upon request that you can self-host to retain the styling of those existing courses).
A Note About Editing
Without the DesignPLUS Sidebar, content will appear without styling when editing. This is because the DesignPLUS Sidebar is what actually loads the styles that apply to saved content into the Canvas editor.
Those styles will still apply to the saved content, it will just be more difficult to tell if a user breaks a styled element while editing.
What permissions do I need to uninstall DesignPLUS?
You will need to have access to the Canvas Theme Editor at the root account (or the sub-account in which DesignPLUS was installed). You will also need to have access to the root account Developer Keys and the root account Apps pages.
What happens if our subscription expires?
Please connect with your sales rep if you'd like help renewing an expired subscription. Although we don't disconnect your service right away, Cidi Labs will cancel the domain's LTI and JavaScript configurations in our database in the event that a subscription has expired and the institution has become unresponsive. If this happens, your users will encounter errors when attempting to load DesignPLUS tools, which is why it's important to uninstall the product if you don't intend to renew.
Delete Developer Credentials
Let's start by deleting the developer credentials in your account.
- Navigate to your root account in Canvas
- Click Developer Keys in the account navigation
- For older installs (LTI 1.1), find Cidi Labs Tools or Cidi Labs DesignPLUS in your list of keys. For newer installs (LTI 1.3), find Cidi Labs Multi-Tool LTI and Cidi Labs Upload/Embed Image LTI.
- Click the trash icon in the Actions column
- When asked, confirm that you want to remove the key
Next, let's turn off the inherited developer keys.
- Select the Inherited tab on the Developer Keys page.
- Find the Cidi Labs DesignPLUS inherited key and turn it off.
- If the Cidi Labs Install inherited key is on, turn it off too.
Remove LTI Tools
There are two LTI tools that are part of DesignPLUS, the Multi-Tool and the Upload/Embed Image Tool. Let's remove those next.
- Navigate to your root account in Canvas (or whatever sub-account into which the tools were installed)
- Click Settings in the account navigation
- Open the Apps tab
- Click View App Configurations
- Find Multi-Tool in the list of external apps
- Click the gear icon /settings button
- Click Delete
- When asked, confirm that you want to delete the Multi-Tool App
- Repeat steps 5-8 for the Upload/Embed Image tool
Remove CSS/JS
The last step is to remove the DesignPLUS CSS and JavaScript from the Canvas Theme Editor.
A Note about CSS:
For courses that you have developed using DesignPLUS, Cidi Labs can provide you with a copy of the CSS that you can self-host to retain the styling of those existing courses. Please contact support@cidilabs.com to request this file.
- Navigate to your root account in Canvas (or whatever sub-account into which the tools were installed)
- Click Themes in the account navigation
- Find your current theme in the list
- Click the theme name or the Open in Theme Editor button to edit the theme
- In the top-left corner of the screen, click the Upload tab
- Remove the DesignPLUS CSS and JavaScript
- OPTION 1: If you do not have any additional CSS/JavaScript you can click the X icon next to each file to remove it altogether.
- OPTION 2: If you do have CSS/JavaScript in addition to the DesignPLUS code, you will need to download the current files, strip out the DesignPLUS code, save the files, and upload them again.
- To download a file, right click on the View File link and choose Save As...
- To upload the file again, click on the Select button and locate the modified file.
- Once you download the CSS files, open them with a code editor (or for basic usage, Notepad or TextEdit) and remove the DesignPLUS CSS that has been enclosed in comments that should start with something like:
/*********************************************************************/
And end with something like:
/***** BEGIN DESIGN TOOLS THEME IMPORT & CUSTOMIZATION **************/
/*********************************************************************/
/*********************************************************************/
/***** END DESIGN TOOLS HEME IMPORT & CUSTOMIZATION ****************/
/*********************************************************************/ - Next, open the JavaScript files and remove the DesignPLUS code that has also been enclosed in comments that should start with something like:
////////////////////////////////////////////////////
And end with something like:
// DESIGN TOOLS CONFIG //
////////////////////////////////////////////////////
////////////////////////////////////////////////////
The JavaScript comments in the Mobile App JavaScript file are a little different but structured the same.
// END DESIGN TOOLS CONFIG //
////////////////////////////////////////////////////
- OPTION 1: If you do not have any additional CSS/JavaScript you can click the X icon next to each file to remove it altogether.
- When you have removed or modified and uploaded all four files, click the Preview Your Changes button
- Click the Save theme button in the bottom right of the screen
- Click the Apply theme button in the bottom left of the screen
- Test the changes by loading a course. You can check to make sure the uninstall passes these tests:
- In the course settings > Navigation, there is no Multi-Tool or MultiTool option present.
- When editing a page, the RCE Apps menu does not have an Upload/Embed Image tool option present.
- When editing a page, the DesignPLUS Sidebar does not appear on the right. The launch button is gone and the Alt+Shift+D keystroke does not launch the tools either.
- Interactive page elements such as accordions, tabs, or quick checks have deprecated to headings and text.
- CSS styles no longer load (unless you requested and uploaded the CSS snapshot file to host yourself).