Before you begin the setup process, review the following recommendations:

• Make sure you have a designated technical expert responsible for establishing and managing the LTI configuration
  • The technical resource should have applicable administrative access within the LTI 1.3 platform 
  • The technical resource should have Console admin role or a custom role with the following permissions to manage LTI configuration:
    • Create LTI Tools
    • Read LTI Tools 
    • Update LTI Tools 
    • Delete LTI Tools
• Additionally, for Branch specific LTI Tools, the technical resource should have Console admin role or a custom role with the following permissions:
  • Read Branches

Creation Flow

Setting up an LTI tool and Deployment involves taking steps in BenchPrep and LTI Platform (LMS) to ensure a seamless integration.

 

Typically, the process entails the following sequence of steps: 

1. Set up the LTI tool in BenchPrep.
2. Use information generated from the setup (ie Public Key ID) to set up the LTI tool within the LTI Platform (the LMS).
3. Use the information generated from the setup to configure a Deployment in BenchPrep. 
4. Optionally, you can map global LTI role at the tool level and configure group association at the deployment level. 

Please see the instructions provided below for accessing and adjusting a Tool at either the Tenant or Branch level. Please be aware that a Tenant-level setup may not necessarily grant complete access to the entire tenant; rather, it may correspond to the access level assigned to you according to your custom role and the scope of that role. 

Tenant Level Setup 

To initiate the set up process at the Tenant Level follow these steps: 

1. Access Console and select Settings on the left-hand side.
2. Choose LTI from menu options. 
   
3. The LTI page displays all LTI tools that you have access to see (tenant and branch) and includes the following details:
   1. ID
   2. Name
   3. Client ID
   4. Branch - if blank the LTI tool is a tenant level tool
   5. Date Created 
   6. Actions 
      
4. Select New LTI Tool button.
   
5. On the next page, input the LTI Name (required) and select Save.
6. After the LTI tool is saved, the Overview Section will display LTI details with keys/URLs/endpoints necessary to successfully configure the LTI tool on the LMS side. 
   
7. Upon successful configuration on the LMS side the following fields will be generated and will need to be saved on BenchPrep’s side. 
8. Click Edit on the left-hand side. 
   
9. Input applicable fields in the pop up box.
   
10. Select Save.

After saving the LTI tool, follow the “Creating a Deployment” section below to create a deployment. 

Branch Level Setup

To initiate the set up process at a Branch Level, follow these steps: 

1. Access Console and select Branches underneath Manage Users on the left-hand side.
   
2. Locate the desired branch and select it.
3. Click Settings on the right-hand side.
   
4. Choose LTI from menu options. 
5. The LTI page displays all LTI tools that you have access to see (tenant and branch) and includes the following details:
   1. ID
   2. Name
   3. Client ID
   4. Branch - if blank the LTI tool is a tenant level tool
   5. Date Created 
   6. Actions 
      
6. Select New LTI Tool button. 
   
7. On the next page, input the LTI Name (required) and select Save.
8. After the LTI tool is saved, the Overview Section will display LTI details with keys/URLs/endpoints necessary to successfully configure the LTI tool on the LMS side. 
   
9. Upon successful configuration on the LMS side the following fields will be generated and will need to be saved on BenchPrep’s side. 
10. Click Edit on the left-hand side. 
    
11. Input applicable fields in the pop up box.
12. Select Save.

After saving the LTI tool, follow the steps in the section below to create a deployment. 

Creating a Deployment

An LTI Tool’s Deployment determines where it can be used. For instance, an instructor can deploy a tool in one specific course, or an institution can deploy it across the entire institution, accessible in all current and future contexts within the institution. Enabling a single tool for multiple deployments allows us to support various scenarios and use cases. 

You can add a deployment to an existing LTI tool (both tenant or branch) by following these steps: 

1. Select the LTI tool you would like to create a deployment for.
2. Navigate to the Associated Deployments tab.
   
3. This page displays all deployments associated with this LTI tools and includes the following details:
   1. ID
   2. Deployment Name - internal only, editable field 
   3. Branch - lists branch association (including children branches, if applicable)
   4. Deployment ID - editable field
   5. Courses
   6. Date Created 
   7. Actions 
      
4. Input the following: 
   1. Deployment Name - internal only, appears on Associated Deployments page.
   2. Branch - choose a branch this deployment will be associated to. Branch Level deployments will have the corresponding branch auto-filled in. 
   3. Deployment ID - input value from your LTI platform (LMS).
      
5. Select Next. 
6. Click the + icon next to the desired courses to move them from Available to Selected Courses section. 
   
7. Click Create Deployment.

After your LTI tool and Deployment is created, test your configuration to ensure it functions correctly.

Modifying LTI Tool and Deployment

After creating and LTI tool you can edit the following:

• LTI tool name
• Details in the OVerview Section

After creating a Deployment you can edit the following:

• Deployment name 
• Deployment ID

You can Delete an LTI tool and remove an associated Deployment.  
Select the Delete link next to the LTI tool you wish to remove: