Adding an LTI 1.1 Customer with OneRoster

14 views
January 9, 2025
Abhijeet Garud

Adding an LTI 1.1 customer with OneRoster as the Rostering type is also subject to certain dependencies. Let’s see what these dependencies are before setting up for LTI 1.3 integration.

Let’s now see how to add an LTI 1.1 customer with the other Rostering type option, that is OneRoster.

1. Sign in with your Enterprise Admin credentials.

2. On the Customers tab, click on +Add Customer.

3. Enter the Profile, Administrator, and Address details of the customer you want to add.

4. If you select OneRoster as the Rostering type, new fields like Sync Type, Match with, Sync Frequency, Suffix, Authorization, Client Partner ID, Consumer Key, Secret Key, and URL will appear.

5. The Sync Type menu has three options– Sync With API, SFTP, and ZIP Upload.

You need to select one of them.

6. There are four options on the Match with menu. You need to select one of them.

7. Enter the other details in the respective fields. We have selected SFTP as the Sync type and Identifier as the Match with option in this example.

8. If you select the ZIP Upload option for Sync type, the Auto Sync Frequency

button will disappear. This is because the only option to sync the data in this

case is to do it manually. You also need to provide the Client Partner ID.

9. Let’s consider SFTP as the Sync Type and Auto as the Sync Frequency option.

When you select the Auto button, a new field by the name Period will appear. The Period field specifies how frequently you want the system to automatically sync the data. Currently there are six options available on the Period menu.

10. You also need to enter details in the Client Partner ID, Host Name, and Username fields.

11. Next, enter details in the Password and Path fields. > Check the Privacy Policy and Terms of Service box. > Click on Add.

12. Once you have completed the LTI 1.1 customer addition process, you need to login with the partner’s credentials you have just created and initiate the process for syncing with OneRoster. Switch to the Users tab. > Click on Class.Click on the Sync with OneRoster – API button on the Class tab to initiate the data syncing process

How it Works

1. A user has to upload users.csv, orgs.csv, classes.csv, and enrollments.csv files in a bundle, i.e. the user has to make a zip of all the files.

2. Once the .zip file is ready, login with the institute admin credentials, navigate to the Users menu, click on Upload Roaster File, and upload the .zip file.

3. After successfully uploading the .zip file and process completion, The user should be able to see the newly added users and classes under the Users and Class sections respectively.

4. Once a user and class is created through OneRoster, a partner can add and assign content to the user/class.

5. The newly created user should now be able to login to the reader.

6. If you sync the data again, without the old user entries, the Kitaboo system will delete the old user who is missing in the new zip file. Hence, please make sure that you are updating the last uploaded sheet at a regular interval to avoid the risk of deletion.

7. Please make sure you uploaded the zip file to the correct location of SFTP and the file name should be the same which you defined during the account creation process.

For more information, please refer to:

https://www.imsglobal.org/lis/imsOneRosterv1p0/imsOneRosterCSV-v1p0.html#_Toc421598314