Skip to main content
up-arrow

Install

How to Install ChemVantage

ChemVantage is certified to comply with 1EdTech specifications for LTI Advantage Complete (version 1.3). To install ChemVantage as an LTI tool in your LMS, you should have administrator privileges in your LMS. There is no cost to register, and instructor accounts are free.

Installation instructions for Instructure Canvas

The institution's account administrator should perform the following steps:

  • Browse to https://www.chemvantage.org/lti/registration and complete a brief form to provide your contact information. We will send an email confirmation with a tokenized registration link.
  • Configure a new LTI Developer Key for your Canvas Account (see detailed instructions here.)
    1. Key Name: ChemVantage
    2. Owner Email: admin@chemvantage.org
    3. Redirect URIs:

      https://www.chemvantage.org/lti/launch

      https://www.chemvantage.org/lti/deeplinks

    4. Configure Method: Enter URL
    5. JSON URL: https://www.chemvantage.org/lti/registration?UserRequest=config
  • Click Save
  • From the list of developer keys, locate ChemVantage. Copy or write down the client_id from the Details column. It is a numeric value that looks something like 32570000000000741. Then click the toggle switch in the State column to activate the developer key.
  • Add ChemVantage as an External App to your account using the client_id created in step 2 (see detailed instructions here)
    1. Go to Admin | Settings | Apps | View App Configurations
    2. Click the blue +App button. Then click Configuration Type and and select By Client ID. Paste the client_id that you copied in step 4. Click Submit, then Install.
  • From the list of External Apps, locate ChemVantage and click the Settings gear on the right. Select Deployment ID and copy or write down the value. It consists of a number and a hex string separated by a colon and looks something like 10408:7db438070728c02373713c12c73869b3af470b68.
  • Click the tokenized link in the email confirmation from step 1 to register the client_id and deployment_id with ChemVantage. If the link expired, you can simply repeat step 1 to get another one.

The course instructor can then create any ChemVantage assignment as follows:

  • Create a new Canvas assignment with the following recommended parameters:
  • Name: (as appropriate, e.g. Quiz - Heat and Enthalpy)
  • Points: 10 for quiz or homework; 5 for video, poll or reading assignment; 100 for placement exam or practice exam
  • Submission Type: External Tool
  • External Tool URL: Click Find and select ChemVantage. Then select the assignment type and text/chapter/topics.
  • Save or Save and Publish
  • When you launch the assignment, you may use the links on the Instructor page to customize it for your class.

Installation instructions for Blackboard Learn

The institution's account administrator should perform the following steps:

  • Browse to https://www.chemvantage.org/lti/registration and complete a brief form to provide your contact information. We will send an email confirmation with a tokenized registration link.
  • In Blackboard, go to System Admin | Integrations: LTI Tool Providers | Register LTI 1.3 Tool
  • Enter the Client ID: be1004de-6f8e-45b9-aae4-2c1370c24e1e
  • Make a copy of the deployment_id and set Tool status: Approved
  • Institution Policies: Send Role, Name, Email; Allow Grade Service and Membership Service
  • Submit
  • Use the tokenized link from the email in step 1 to register your deployment_id with ChemVantage. If the link expired, you can simply repeat step 1 to get another one.
  • Go back to the LTI Tool Providers page, and from the dropdown menu on the ChemVantage app select Manage Placements
  • Click Create Placement
    1. Label: ChemVantage
    2. Description: ChemVantage is an Open Educational Resource for General Chemistry
    3. Handle: (any unique string)
    4. Availability: Yes
    5. Deep Linking Tool (do not allow student access)
    6. Target Link URI: https://www.chemvantage.org/lti/deeplinks
    7. Custom Parameters (leave blank)
    8. Submit

The course instructor can then create any ChemVantage assignment:

  • Go to the course | Content | Build Content | ChemVantage
  • Select the ChemVantage assignment type and topic

Installation instructions for D2L Brightspace

The detailed Brightspace documentation can be found here. The institution's account administrator should perform the following steps:

  • Go to Admin Tools | Manage Extensibility
  • Select the LTI Advantage tab and click Register Tool
  • Select Dynamic Registration, enter the tool registration endpoint: https://www.chemvantage.org/lti/registration
  • Check the box for Configure Deployment and click Register
  • Complete the ChemVantage registration form and submit.
  • When the registration is successful, click the link to close the window and return to Brightspace.
  • Select the checkbox for the ChemVantage tool and click Enable.
  • Go to Admin Tools | External Learning Tools
  • Under Deployment Name, click the ChemVantage link to edit the deployment
  • Click Add Org Units to add the Chemistry Department to make ChemVantage visible in General Chemistry courses.
  • Click Save and Close

That's all! You should now be able to go to any course in the Chemistry Department Org and add a ChemVantage assignment by selecting a content module, clicking Add Existing, and selecting ChemVantage.

If the registration fails for any reason, the account administrator still has the option of manual registration:

  • Browse to https://www.chemvantage.org/lti/registration and complete a brief form to provide your contact information. We will send an email confirmation with a tokenized registration link.
  • In Brightspace, ensure the Manage LTI Advantage Tool Registrations and Manage LTI Advantage Tool Deployments permissions are set at the organization level.
  • From the Admin Tools menu, click Manage Extensibility. In the LTI Advantage tab, click Register Tool.
  • Choose Standard registration, click Register.
  • Tool Name: ChemVantage
  • Description: ChemVantage is an Open Educational Resource for college-level General Chemistry
  • Domain: https://www.chemvantage.org Note: Domains can only be used in one enabled registration at a time. In order to register a tool with a domain that is already in use, you must first disable the existing registration.
  • Redirect URIs: https://www.chemvantage.org/lti/launch https://www.chemvantage.org/lti/deeplinks
  • OpenID Connect Login URL: https://www.chemvantage.org/auth/token
  • Target Link URI: https://www.chemvantage.org/lti/launch
  • LTI version: LTI 1.3
  • Keyset URL: https://www.chemvantage.org/jwks
  • Tool URL: https://www.chemvantage.org/lti/launch
  • Extensions: Deep Linking, Assignment and Grade Services, Names and Role Provisioning Services
  • Deep Linking Content Selection URL: https://www.chemvantage.org/lti/deeplinks
  • Under Roles, choose to Context role information. Sending Institutional role information is optional. Setting the Deployment security to Anonymous will work; however, instructors will be unable to verify or synchronize ChemVantage scores to the Brightspace grade book using this setting.
  • Substitution Parameters: resource_link_id_history=$ResourceLink.id.history
  • Custom parameters: (none)
  • Click Register
  • Review the configuration details to obtain the client_id and deployment_id, and click the tokenized link in the email confirmation from step 1 to register them with ChemVantage. If the link expired, you can simply repeat step 1 to get another one.

Installation instructions for Moodle

The detailed Moodle documentation can be found here. The institution's account administrator should perform the following steps:

  • Go to Site Administration and select the Plugins tab
  • Click External tool | Manage Tools
  • In the Add Tool box, enter the Tool URL: https://www.chemvantage.org/lti/registration and click Add LTI Advantage
  • Complete the ChemVantage registration form and submit.
  • When the registration is successful, click the link to close the window and return to Moodle.
  • Find the new ChemVantage tool and click Activate.

That's all! You should now be able to go to any course and add a ChemVantage assignment by turning Edit Mode on, clicking Add an Activity or Resource, and selecting External Tool. Under Preconfigured Tool, select ChemVantage and click Select Content.

If the registration fails for any reason, the account administrator still has the option of manual registration:

  • Browse to https://www.chemvantage.org/lti/registration and complete a brief form to provide your contact information. We will send an email confirmation with a tokenized registration link.
  • As an admin user, go to "Site administration > Plugins > External tool > Manage tools"
  • Click the link to "Configure a tool manually"
  • External Tool Configuration
    1. Tool Name: ChemVantage
    2. Tool URL: https://www.chemvantage.org/lti/launch
    3. Tool Description: ChemVantage is an Open Educational Resource for teaching and learning college-level General Chemistry
    4. LTI version: LTI 1.3
    5. Public Key Type: Keyset URL
    6. Public Keyset: https://www.chemvantage.org/jwks
    7. Initiate Login URL: https://www.chemvantage.org/auth/token
    8. Redirection URIs:

      https://www.chemvantage.org/lti/launch

      https://www.chemvantage.org/lti/deeplinks

    9. Custom parameters: (none)
    10. Check 'Supports Deep Linking'
    11. Content Selection URL: https://www.chemvantage.org/lti/deeplinks
    12. Services | LTI Assignment and Grade Services: select Use for grade sync only
    13. Services | LTI Names and Role Provisioning: select Use this service
    14. Privacy | check Force SSL
    15. Save Changes
  • When you have finished the configuration, Moodle generates a preconfigured tool. You must activate it and then click 'View configuration details'. When you have these details in hand, including the client_id and deployment_id, click the tokenized link in the email confirmation from step 1 to register the configuration details with ChemVantage. If the link expired, you can simply repeat step 1 to get another one.

The course instructor can then create any ChemVantage assignment as follows:

  • In any course, turn Edit Mode on and click 'Add an activity or resource'
  • Select External tool
  • Activity Name: (as appropriate, e.g. Quiz - Heat and Enthalpy)
  • Preconfigured Tool: select ChemVantage
  • Click 'Select Content' and choose the assignment type and topics from the ChemVantage popup window
  • Configure Grade and Privacy settings as desired
  • When you launch the assignment, you may use the links on the Instructor page to customize it for your class.

Installation instructions for Sakai

First of all, Sakai supports LTI Advantage Dynamic Registration! The Sakai documentation can be found here. We strongly encourage you to try that first (see above). The institution's account administrator still has the option of manual registration, but we don't have detailed instructions for this.

  • Browse to https://www.chemvantage.org/lti/registration and complete a brief form to provide your contact information. We will send an email confirmation with a tokenized registration link.
  • Use the following information to configure your LMS to connect to ChemVantage:
    1. Name: ChemVantage
    2. Description: ChemVantage is an Open Educational Resource for General Chemistry
    3. Tool Domain URL: https://www.chemvantage.org
    4. Tool Redirect URL: https://www.chemvantage.org/lti/launch
    5. Tool Deep Linking URL: https://www.chemvantage.org/lti/deeplinks
    6. OIDC Login Initiation URL: https://www.chemvantage.org/auth/token
    7. JSON Web Key Set URL: https://www.chemvantage.org/jwks
  • When you have finished the configuration, activate the ChemVantage tool in your LMS and open a window to view the configuration details. When you have these details in hand, including the client_id and deployment_id, click the tokenized link in the email confirmation from step 1 to register the configuration details with ChemVantage. If the link expired, you can simply repeat step 1 to get another one.

Installation instructions for PowerSchool Schoology

  • Click the App Center icon, then select App Center.
  • Locate ChemVantage and click the title
  • Click Install LTI 1.3 App > I Agree > Continue > Add to Organization
  • You will be directed to Organization Apps to continue the installation.
  • Click the Install/Remove button for ChemVantage
  • Select All Users, All Courses, or areas where you want to install ChemVantage. Then Submit.
  • Click Configure and copy the Deployment ID for ChemVantage. It should be two 10-digit numbers separated by a hyphen. You will need it to complete the registration.
  • Browse to https://www.chemvantage.org/lti/registration and complete a brief form to provide your contact information. We will send an email confirmation with a tokenized registration link.
  • Click the tokenized link in the email confirmation to register the Deployment ID and other configuration details with ChemVantage. If the link expires, you can simply repeat the previous step to get another one.

The course instructor can then create any ChemVantage assignment as follows:

  • In any course, click 'Add Materials' and select ChemVantage
  • Choose the assignment type and topics from the ChemVantage popup window
  • Use the Schoology assignment settings to edit the Grading Configuration and points
  • When you launch the assignment, you may use the links on the ChemVantage Instructor page to customize it for your class.

Installation instructions for other LMS platforms

  • Browse to https://www.chemvantage.org/lti/registration and complete a brief form to provide your contact information. We will send an email confirmation with a tokenized registration link.
  • Use the following information to configure your LMS to connect to ChemVantage:
    1. Name: ChemVantage
    2. Description: ChemVantage is an Open Educational Resource for General Chemistry
    3. Tool Domain URL: https://www.chemvantage.org
    4. Tool Redirect URL: https://www.chemvantage.org/lti/launch
    5. Tool Deep Linking URL: https://www.chemvantage.org/lti/deeplinks
    6. OIDC Login Initiation URL: https://www.chemvantage.org/auth/token
    7. JSON Web Key Set URL: https://www.chemvantage.org/jwks
    8. It's rare, but in case you need an X509-style public key instead of the JWKS, you can get it here.
  • When you have finished the configuration, activate the ChemVantage tool in your LMS and open a window to view the configuration details. When you have these details in hand, including the client_id and deployment_id, click the tokenized link in the email confirmation from step 1 to register the configuration details with ChemVantage. If the link expired, you can simply repeat step 1 to get another one.

If you have any difficulty with these instructions, please send email to admin@chemvantage.org so we can help you!

Chuck Wight

ChemVantage LLC