Skip to content

Archiving Manager

The archiving manager is the central entry point for archiving tasks.

Work in Progress (WIP)

This section is still under active development. Information and specifications can still be changed in the future.

Tasks and Responsibilities

Course Archiving Overview

Providing an overview of archivable data inside each course and whether it has already been archived or not

Global Archiving Overview

Providing a global overview of archivable data across all courses. Also provides an overview of connected storage systems and their status.

Archive Job Handling

Managing archiving tasks as distinct jobs

  • Create, inspect, delete archiving jobs
  • Delegates archiving of activity data to the respective Activity Archiving Drivers
  • Displays progress and status of archiving jobs
  • Handling of multiple archiving jobs in parallel

Common Post-Processing

Handling common post-processing steps for archived data

  • Requesting of digital signatures using TSP

Automation

Automation of archiving tasks

  • Initiating archive jobs periodically or on specific signals
  • Selection of criteria for automated archiving (e.g., course categories, activity types, activity status, ...)
  • Sending of error notifications if automated archiving jobs failed

Auto-deletion / GDPR Compliance

Management of auto-deletion of archived data after a certain retention time (GDPR compliance)

  • Keeping track of retention times for archived data
  • Initiating deletion of archived data after retention time has passed

Handling of GDPR requests for retrieval of personal data

Archive File Handling

Forwarding finalized archives to storage drivers

Global Defaults and Policies

Management of global defaults and policies for archiving data

  • Filename patterns, archive formats, retention time, ...
  • Enabling / disabling of archiving for course categories

Interfaced Components

Details

Archive Job Flow

The following sequence diagram illustrated the basic information flow of a successful archiving job.

sequenceDiagram
    autonumber
    actor User

    %% User input
    User ->> Archiving Manager: Request activity archiving

    %% Job start
    activate Archiving Manager
    Archiving Manager ->> Archiving Manager: Init archiving job
    Archiving Manager -) Activity Archiving Driver: Enqueue task
    deactivate Archiving Manager

    %% Job processing
    activate Activity Archiving Driver
    Activity Archiving Driver ->> Activity Archiving Driver: Process activity data
    opt Task Offloading
        Activity Archiving Driver -) Worker Service: Enqueue tasks
        deactivate Activity Archiving Driver
        activate Worker Service
        Worker Service -->> Activity Archiving Driver: Processed data
        deactivate Worker Service
        activate Activity Archiving Driver
    end
    Activity Archiving Driver --) Archiving Manager: Activity archive
    deactivate Activity Archiving Driver

    %% Job postprocessing
    activate Archiving Manager
    Archiving Manager ->> Archiving Manager: Finalize archive job
    Archiving Manager -) Storage Driver: Request archive storing
    deactivate Archiving Manager
    activate Storage Driver
    Storage Driver ->> Storage Driver: Store archive
    Storage Driver --) Archiving Manager: Storage confirmation
    deactivate Storage Driver
    activate Archiving Manager
    deactivate Archiving Manager
Press "Shift" to enable Pan & Zoom

External Event Connector Integration

The following sequence diagram illustrates the way external event connectors integrate into the archiving system. We use the event triggered after a new archive has been stored successfully as an example.

sequenceDiagram
    autonumber
    participant Storage Driver
    participant Archiving Manager
    participant Moodle Events API
    participant External Event Connector
    participant External System

    %% Event Trigger
    activate Storage Driver
    Storage Driver ->> Storage Driver: Do something
    Storage Driver -) Moodle Events API: Trigger Event: Stored Archive
    deactivate Storage Driver

    %% Event Propagation
    activate Moodle Events API
    Moodle Events API -) Archiving Manager: Propagate Event: Archive Stored
    activate Archiving Manager
    Moodle Events API -) External Event Connector: Propagate Event: Archive Stored
    activate External Event Connector
    deactivate Moodle Events API

    %% Event Handling
    Archiving Manager ->> Archiving Manager: Do something
    deactivate Archiving Manager

    External Event Connector ->> External Event Connector: Transform Data
    External Event Connector ->> External System: Trigger Action
    activate External System
    External System ->> External System: Do something
    External System --) External Event Connector: Action Result
    deactivate External System

    opt Error Handling
        External Event Connector -) Moodle Events API: Trigger Event: Error
        deactivate External Event Connector
        activate Moodle Events API
        Moodle Events API -) Archiving Manager: Propagate Event: Error
        deactivate Moodle Events API
        activate Archiving Manager
        Archiving Manager ->> Archiving Manager: Handle Error
        deactivate Archiving Manager
    end
Press "Shift" to enable Pan & Zoom