VeriCite DocumentationCanvas User Guide LTI Integration - Admin ArticlesHow do I migrate Canvas VeriCite LTI assignments to the new LTI URL?

How do I migrate Canvas VeriCite LTI assignments to the new LTI URL?

We provide scripts for you to migrate your existing Canvas VeriCite LTI assignments to the new LTI URL.

1. Get scripts:

Go to https://github.com/vericite/canvas-utils/releases to get the scripts. Information on how to run each script can be found in this project’s README.

2. Get authorization token:

To manually generate a token:

  1. Go to the Account -> Settings link in the left menu bar, or navigate to /profile
  2. Under the Approved Integrations section, click the button to generate a new access token.
  3. Once the token is generated, you cannot view it again, and you'll have to generate a new token if you forget it. Remember that access tokens are password equivalent, so keep it secret.

3. Run “list-courses” script to get all of the courses that may have a VeriCite LTI assignment.

In order to run this script, you need to know the Canvas Account IDs and Term IDs you wish to export. These IDs can be found in the URL when viewing them in Canvas. (e.g. /accounts/1). Save the script output into a file named “courses.csv”. You can only run one account and one term at a time.

./list-courses -token="9000~aXXXXXXXXXXXXXXXXXXX" -url="https://acmecollege.instructure.com/api/v1/" -accountId=1 -termId=1 > courses.csv

4. Run the “list-course-assignments” script.

Point to your “courses.csv” file for the input parameter “filename”. Make sure you set the “vericiteLtiMigration” flag to true so that the script will only list assignments that have an old VeriCite LTI URL. Save the script output into a file named “assignments.csv”

./list-course-assignments -token="9000~aXXXXXXXXXXXXXXXXXXX" -url="https://acmecollege.instructure.com/api/v1/" -filename="courses.csv" -vericiteLtiMigration=true > assignments.csv

5. Run the “rewrite-assignment-urls” script.

Point to your “assignments.csv” file for the input parameter “filename”. This will update any old VeriCite LTI URL assignment to point to the new URL. This can take a long while, so make sure your script can run for a long time.

./rewrite-assignment-urls -token="9000~aXXXXXXXXXXXXXXXXXXX" -url="https://acmecollege.instructure.com/api/v1/"

Tip: You can run all scripts at once with a single command like:

./list-courses -token="9000~aXXXXXXXXXXXXXXXXXXX" -url="https://acmecollege.instructure.com/api/v1/" -accountId=1 -termId=1 | tee courses.csv && ./list-course-assignments -token="9000~aXXXXXXXXXXXXXXXXXXX" -url="https://acmecollege.instructure.com/api/v1/" -filename="courses.csv" -vericiteLtiMigration=true | tee assignments.csv && ./rewrite-assignment-urls -token="9000~aXXXXXXXXXXXXXXXXXXX" -url="https://acmecollege.instructure.com/api/v1/"