Skip to main content
Compare the rollout approaches before choosing a plugin.

​
Before you begin

  • Moodle 4.0+ (version >= 2022041900).
  • Administrator access with moodle/site:config permission.
  • A preconfigured StudyStash LTI tool.
  • Cron running in Moodle.
  • The plugin ZIP from your Customer Success Manager.
1

Install the plugin

Open https://<your-moodle-instance>/admin/tool/installaddon/index.php.Select Choose a file… and upload the ZIP from your Customer Success Manager. Select Show more… and set Plugin type to Local plugin (local).
Upload the plugin ZIP and select Local plugin.

Upload the plugin ZIP and select Local plugin.

Select Install plugin from the ZIP file. Select Continue after validation, then Continue after the server checks.At the plugins check, select Upgrade Moodle database now.
Complete the plugin installation with the Moodle database upgrade.

Complete the plugin installation with the Moodle database upgrade.

If an Upgrading to new version message appears, select Continue.
2

Configure the plugin

Use these settings:
Select the StudyStash tool and choose the activity settings.

Select the StudyStash tool and choose the activity settings.

Select Save changes, then open https://<your-moodle-instance>/local/studystash_optin/index.php.
Open the rollout plugin to manage courses and sync tasks.

Open the rollout plugin to manage courses and sync tasks.

3

Choose courses with a CSV

Open Opt-In Courses and select Download CSV template.
Use the Opt-In Courses tab to upload your course list.

Use the Opt-In Courses tab to upload your course list.

Enter one Course ID number or Short name per row. A header row is not required. For example:
Select Choose File to upload the CSV, then Preview CSV. Check that every row is valid and matches the intended course.
Review the matched course details before applying the list.

Review the matched course details before applying the list.

Select Apply opt-in list when the preview is correct.
4

Preview the sync

On Status, select Dry Run and wait for the task to finish. Larger course lists may take longer.
Run a preview before changing course activities.

Run a preview before changing course activities.

Open Logs and check the planned behaviour for each course before continuing.
5

Sync the courses

When the preview is correct, return to Status and select Sync StudyStash to Courses to apply the changes.
Run the sync after checking the dry-run logs.

Run the sync after checking the dry-run logs.

​
Update the course list

Upload a replacement CSV containing only the courses you want to keep. Each upload replaces the existing opt-in list.This changes the selection for future syncs; it is not an instruction to delete an existing course activity.
Use the Course ID number or Short name in your CSV.