tool:sessionarchiver

Session Archiver: End-of-session course archiving tool

Presentation

This plugin is a tool for driving the mass archiving of the courses of an academic session to an archive location. This location can be on the same platform or on another remote platform, provided both platforms can share a common storage location for the course archives to be moved.

On the scheduled archiving date, the archiving script is run on the source platform. The script creates all the course backups needed for transport to the archive in the storage space designated for the transfer, after a pre-computation of the (estimated) required size.

Once this script has finished and the backups are available, the reintegration script is launched on the archive platform. The courses are restored in the same sub-tree starting from the saved root. A post-processing script can be run after each restoration.

A control script makes it possible to check the comparison between the archive (the list of restored courses) and the original category on the source platform.

If this control script answers positively, the purge scripts can be used to destroy an outgoing category on the archive platform and the outgoing category on the source platform.

Precautions

  • Both platforms must have the same Moodle version,
  • Both platforms must have the same version of the tooling,
  • The processing time of archiving, reintegration or purges can be VERY LONG (several hours). In some critical cases, it must be possible to interrupt an archiving, reintegration or purge load during the platform's business hours.

Operation tracking indicators let you check:

  • The state of an operation (is there an operation in progress?)
  • A “remaining to do” state for the operation.

Guides

Feature summary

Archiving

  • Identification of a source category (with a sliding method – by vintage year)
  • Determination of a shared physical location for the course backups.
  • Execution by CLI script, with possible time throttling
  • Progress tracking
  • Progress tracking by email
  • Pre-processing scripts (Moodlescript) (?)

Reintegration

  • Identification of a target container / remote platform identity
  • Determination of a shared physical location for the course backups.
  • Execution by CLI script, with possible time throttling
  • Progress tracking
  • Progress tracking by email
  • Post-processing scripts (Moodlescript)

Archive purge

  • Identification of the category to purge
  • Execution by CLI script, with possible time throttling
  • Progress tracking
  • Progress tracking by email
  • Simulation mode
    • Preview of course selections
    • Dry-run test mode

Technical sheet

  • Component type: Administration tool
  • Name: Course archiving
  • Technical name: tool_sessionarchiver
  • Supported versions: :M41: to :M53:
  • Distribution: APL integration
  • Availability:
  • Dependencies: local_moodlescript (optional)

Builds

Note: a “Failing” status does not necessarily mean that the plugin does not work. This status reflects the result of automated tests checking the code against Moodle's strict standards. We are continuously working on bringing all supported plugins progressively into compliance with these development rules.

Branch Continuous integration tests
405 CI status
501 CI status

Credits

  • Valéry Frémaux (valery@activeprolearn.com) - development
  • Florence Labord (florence@activeprolearn.com) - documentation


Back to plugins index - Back to catalogue index

tool/sessionarchiver.txt · Dernière modification : de 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki