Browse docs

SchulConnex Import

Relution supports synchronizing identities and educational context data via SchulConnex (a German school data exchange standard). The feature can be found under Settings > User Management > SchulConnex and automatically synchronizes users, group roles and classes/courses from the underlying school administration software.

Setting Up the SchulConnex Interface

General

  1. Provider Name: Unique name for the configuration.
  2. Enabled: Turns synchronization on.
  3. Host: URL of the SchulConnex server.

Authorization Parameters

  • Authorization URL: URL used for OAuth authentication.
  • Client ID: Client ID for authentication.
  • Client Secret: The corresponding secret.

Note: Use the Check SchulConnex Connection button to test the connection.

Organization Mapping

  • On a regular organization, you select the SchulConnex organizations to be incorporated directly (1:1 mapping).
  • On the global organization or a meta organization, you can manage multiple Relution organizations at once: for each Relution organization, a dedicated set of SchulConnex organizations is assigned via a mapping wizard.

Use Show sync preview to check upfront which classes/courses would be imported, along with their teacher and student counts.

Synchronization Settings

  • Synchronize Classes: Enables the import of classes/courses (enabled by default).
  • Action for Missing Users: Defines what happens when a previously synchronized user no longer exists in SchulConnex (no action, disable, or delete).
  • Action for Missing Classes: Defines what happens to classes removed in SchulConnex (no action or delete).
  • Automatic Synchronization: Schedule via cron syntax (seconds, minutes, hours, day of month, months, weekdays). By default, synchronization runs twice daily at 5 AM and 8 PM.

In addition to automatic synchronization, a sync run can be triggered manually at any time via Sync now in the configuration’s detail view.

Role Mapping

SchulConnex group roles are automatically mapped to Relution groups on import:

  • Teachers: Roles LEHR, KLLEIT, FOERD, VLEHR, GLEIT
  • Students: Roles LERN, GMIT

Checking Synchronization

After a sync run, the results can be reviewed in the configuration’s detail view.

Important: A class/course is only created if it contains at least one student and one teacher.

Note: If a person has no email address on file, the SchulConnex person ID is used as the login instead. If a user with the same email address or username already exists, the import for that person is skipped and reported as an error.

Note: If authentication fails (e.g. an expired secret), the entire sync run for the configuration is aborted, since the credentials apply to all mapped organizations at once.