diff --git a/Configuration.md b/Configuration.md index 8c10210..f0330be 100644 --- a/Configuration.md +++ b/Configuration.md @@ -270,10 +270,11 @@ This feature informs you of all uncaught exceptions that occur in the MarkUs bac >**Note**: LTI routes are not enabled in production by default. To enable them, you must edit `routes.rb` file. -If you wish to use Learning Tools Interoperability (LTI) with Markus, you'll need to configure the LTI settings as follows +If you wish to use Learning Tools Interoperability (LTI) with MarkUs, you'll need to configure the LTI settings as follows - `lti.domains` must be a whitelist of all hosts you expect to receive LTI launches from. - `lti.token_endpoint` must be the url used to generate an LTI credentials token for the external platform. +- `lti.sync_schedule` must be a cron schedule dictating when MarkUs should attempt to automatically sync its roster via LTI. You must also create a private key for generating Javascript Web Tokens to sign LTI requests. A private key can be automatically created with the `markus:lti_key` rake task. diff --git a/Learning-Tools-Interoperability.md b/Learning-Tools-Interoperability.md index 70d1f0e..6ee80d6 100644 --- a/Learning-Tools-Interoperability.md +++ b/Learning-Tools-Interoperability.md @@ -37,6 +37,14 @@ and also choose to delete an association between the LMS and MarkUs. > If an association is reestablished, any assignment's LTI settings must be re-created, > and will create *new* LMS gradebook items. +### Roster Synchronization + +When triggering a roster synchronization, you can choose which types of users are synchronized. +Additionally, if 'Enable automatic syncing' is checked, MarkUs will attempt to synchronize the roster automatically +on a schedule determined by your system administrator. + +![LTI Synchronization Options](images/lti-roster-sync.png) + ### Canvas Once installed in your course, a 'Launch Markus' page will appear in your diff --git a/images/lti-roster-sync.png b/images/lti-roster-sync.png new file mode 100644 index 0000000..25b4f62 Binary files /dev/null and b/images/lti-roster-sync.png differ