Canvas Integration Guide

Canvas Integration Guide with LabSim v.3 1

Table of Contents
Configuring Canvas to Integrate with LabSim ......................................................................................................... 3
Setting up TestOut External App for your Course ................................................................................................... 4
Creating a Link to LabSim ........................................................................................................................................ 7
Creating Single-Sign-On....................................................................................................................................... 7
Linking to a Specific with Grade Reporting ....................................................................................................... 13
Importing a Course into Canvas ............................................................................................................................ 21
Common Errors ..................................................................................................................................................... 26

Canvas Integration Guide with LabSim v.3 2

Configuring Canvas to Integrate with LabSim
This guide was made for the LMS Administrator or individual experienced at configuring their LMS systems and
settings.

To help you better integrate LabSim with your Canvas LMS, we have produced the following guide as a
courtesy. We walk you through the steps of how to link to a course, a specific resource within a course, and
how to send a score back from a LabSim resource to Canvass gradebook.

At the end of the guide, we will explain some of the common errors you may run into when trying to connect
to LabSim through Canvas. Please be advised, we are not Canvas (or LMS) experts.

We are unable to provide support or set up your Canvas LMS. TestOut Technical Support is willing to let you
know if there are any issues on our end with the LMS integration, but do not currently have the resources to
set up a Canvas account.

As always, feel free to contact us with any issues. Have a great school year!

Canvas Integration Guide with LabSim v.3 3

Setting up TestOut External App for your Course
Inside of your course, select the Settings from the left-hand side.

Select the Apps tab.

Canvas Integration Guide with LabSim v.3 4

Select Add New App on the External Apps page.

Canvas Integration Guide with LabSim v.3 5

In the Add App box, insert a name for this External Tool that distinguishes that this tool is for LabSim. If you
are setting up an app for a specific course, you may want to include the course name in the title.

Insert your Consumer Key and Secret received from your TestOut Account Executive. This is required to
connect to LabSim.

Insert http://www.testout.com/orbispartner/basiclti.aspx into the URL box. This is required to connect to

LabSim. Note: You can also use https://www.testout.com/orbispartner/basiclti.aspx if your LMS requires it.

Insert www.testout.com in the Domain field.

In the Privacy box, you may select Public or E-Mail Only. We recommend selecting Public as it gives
LabSim access to your (and your students) email and name when creating your LabSim account.

In the Custom Fields box, you may input the global parameters for this specific app. In this instance we have
chosen to set up an app specifically for one product, we added labsim_course_id= to direct us to a specific
course and labsim_allow_outcomes=true to enable LabSim to send scores back to Canvas.

Click Submit

Canvas Integration Guide with LabSim v.3 6

Creating a Link to LabSim
You may use your created LabSim External Tool to provide your students with a Single-Sign-On option or to link
to specific resources inside of LabSim and request a grade back.

Creating Single-Sign-On
Inside of your course, navigate to the Assignments Page and click on the + Assignment button.

Canvas Integration Guide with LabSim v.3 7

Give the assignment a name and description (if desired).

In the Submission Type drop down, select External Tool.

Canvas Integration Guide with LabSim v.3 8

Click on the External Tool URL box and a dialog box will appear. Select the tool that you want to create the
link to.

Canvas Integration Guide with LabSim v.3 9

Once selecting the tool, it will populate the URL to link to LabSim for you. If you have created an app for a
specific LabSim course and have added the custom parameter to the App (as shown here), you do not need to
do anything further and you may click Select.

If you have not added the custom parameter to the App, you must add this parameter to the end of the URL
that populates in this box. You can do this by adding ? on to the end of the URL and then adding
labsim_course_id= and your course ISBN number.

As this link is just for Single-Sign-On, there is nothing else we need to add to the URL.

Once completing this process, press Select.

Canvas Integration Guide with LabSim v.3 10

Press Save & Publish.

If configured correctly, you will be taken to this landing page where it tells you which course you will connect
to. Press Launch LabSim.

Canvas Integration Guide with LabSim v.3 11

You will be taken to LabSim, where you and your students have access to your LabSim course.

Canvas Integration Guide with LabSim v.3 12

Linking to a Specific with Grade Reporting
Inside of your course, navigate to the Assignments page and click on the + Assignment button.

Give your assignment a name based on which resource you are linking to and description (if desired).

Canvas Integration Guide with LabSim v.3 13

Add points and add the assignment to a group (if desired). Select External Tool in the Submission Type
dropdown box.

Select the External Tool URL field and a pop up will appear. The apps/external tools you have set up will
populate. Select the one that you wish to use and it will populate a URL.

Canvas Integration Guide with LabSim v.3 14

At this point, you can customize the URL to do a variety of things. Simply add ? to the end of the URL and add
the following custom parameters (parameters are separated by &).

Go to a Course: Add labsim_course_id= followed by the ISBN of your course (example: 978-1-935080-
43-5). This is required to connect to LabSim. You may or may not need to add this to your URL if you
have added this to your global app.
Go to a Specific Resource: To go to a specific resource inside of the course you have specified, add
labsim_section_id= followed by the section (example: 9.5.3).
o If you wish to link to a resource without a numbered title, you may put the name of the
resource, using %20 in place of spaces (for example: Course%20Overview)
Request that Students Submit a Score Back: If you wish to have students report back a grade from a
resource, add labsim_allow_outcomes=true to the URL. Again, you may or may not need to add this to
your URL if you have added it to your app/external app.

In the end, your URL should look similar to the URL below.

http://www.testout.com/orbispartner/basiclti.aspx?labsim_course_id=978-1-935080-43-
5&labsim_section_id=9.5.3&labsim_allow_outcomes=true

When finished, click Select.

Canvas Integration Guide with LabSim v.3 15

Click Save & Publish

Canvas Integration Guide with LabSim v.3 16

Pooled or Group Licensing
If you are using Pooled or Group Licensing, after clicking the link, the following screen will come up, showing
the course you will launch in LabSim. If you are using Activation Codes, please jump to the next section.

Click Launch LabSim.

Note: If you have an existing LabSim account, make sure your emails in Blackboard and LabSim match to
connect your Blackboard account to your LabSim account

Canvas Integration Guide with LabSim v.3 17

You will notice that you are directed to the correct resource inside of LabSim.

There is not a Submit Score button when logging in as an Administrator or Instructor.

Students will see a score button as shown below.

Canvas Integration Guide with LabSim v.3 18

Activation Codes
If you are using activations codes and do not have an existing account OR if you have an existing account but
do not have the product you are trying to access activated, select the link to your course and you will see the
following screen.
Input your activation code and click Activate.
Note: If you have an existing LabSim account, make sure your emails in Blackboard and LabSim match to
connect your Blackboard account to your LabSim account

If you have an existing LabSim account and the product you are trying to access is activated, select the link to
your course and you will see the following screen. Click Launch LabSim.

Canvas Integration Guide with LabSim v.3 19

You will notice that you are directed to the correct resource inside of LabSim.

There is not a Submit Score button when logging in as an Administrator or Instructor.

Students will see a score button as shown below.

Canvas Integration Guide with LabSim v.3 20

Importing a Course Shell into a Canvas Course
After creating your course, navigate to the Settings page.

Canvas Integration Guide with LabSim v.3 21

Select Import Content into this Course.

Select Canvas Course Export Package. Choose the Canvas file you wish to import. Choose the Select
specific content radial button.

Canvas Integration Guide with LabSim v.3 22

The course will take some time to import

Once this has finished running, press Select Content.

Canvas Integration Guide with LabSim v.3 23

Select the Assignments.

Do not select the LTI External Tool.

Your import will be queued and then will show the status Running.

Canvas Integration Guide with LabSim v.3 24

Once it has finished running, navigate to the Assignments page.

You will see the Assignments (links to LabSim resources) have been imported into your Assignments page.

Canvas Integration Guide with LabSim v.3 25

Common Errors
There are some common errors that we have seen when trying to integrate LabSim with LMS Systems.
Below you see an error when trying to connect to LabSim. The text in the box will often give you a clue as to
what the information LabSim is not receiving so that you can correct the problem in you LMS. Below are some
of the common errors. If you see an error other than one of these, please contact us.

Invalid Consumer Key: This means that you have inputted your Consumer Key incorrectly. Please verify
you have keyed the Consumer Key correctly. If you have, please take a screenshot and contact us.

OAuth Authorization Failed: Your Shared/Consumer Secret is incorrect. Please verify you have keyed the
Consumer Key correctly. If you have, please take a screenshot and contact us.

Invalid LabSim Course Id: You have inputted the parameters that direct you to the course you are looking
to access. The parameter should look like thisthe value after the equal sign is the ISBN of your LabSim
product:
labsim_course_id=978-1-935080-43-5

Invalid User Id: LabSim requires that the User ID is passed from the LMS. If you are receiving this error, you
(or your admin) needs to change the permissions in your LMS to pass over the User ID to LabSim.

Invalid User Role: LabSim requires a user role to be passed over from the LMS. This is how LabSim knows to
create an instructor account or a student account. If you are receiving this error, you (or your admin) needs to
change the permissions in your LMS to pass over the role to LabSim.

No licenses are available for the requested product: This error means that your Consumer Key and
Secret have been setup with a group licensing model and there are no more licenses available. Please contact
your Account Executive to get more licenses added to the pool

Canvas Integration Guide with LabSim v.3 26

Server Error in /OrbisPartner Application
The Launch URL you inputted into the LMS is incorrect. It should be:

http://www.testout.com/orbispartner/basiclti.aspx

Please verify that it is correct. If it is and you are still getting this error, please take a screenshot of both the
screen and the URL you have input and contact us.

Canvas Integration Guide with LabSim v.3 27