Überblick

Das ENBREA Client Interface (kurz: ENBREA CLI) ist eine plattformunabhängige Konsolenanwendung, die auf Ihrem eigenen Computer oder auf einem Computer in Ihrem lokalen Netzwerk installiert werden kann. ENBREA CLI dient administrativen Zwecken und bietet folgende Funktionen:

  • Manueller oder automatisierter Import von Daten aus unterstützten Fachanwendungen nach ENBREA.
  • Manueller oder automatisierter Export von Daten aus ENBREA in unterstützte Fachanwendungen.
  • Erstellen und wiedereinspielen von serverseitigen Datenbank-Snapshots
  • Erstellen und herunterladen von Datenbank-Backups

ENBREA CLI Infografik

ENBREA CLI kann unter Windows sowohl aus der klassischen Eingabeaufforderung als auch via PowerShell gestartet werden.

Info

Eine detailierte Dokumentation aller Befehle von ENBREA CLI, sowie ein ausdokumentiertes JSON-Schema der Konfigurationsdatei findet sich im GitHub-Wiki zu ENBREA CLI

Folgende Befehle stehen bereit:

init

Legt eine Konfigurationsdatei für den Import nach ENBREA und dem Export von ENBREA an. Diese Konfigurationsdatei muss anschließend editiert werden um URLs, Zugriffstoken, lokale Dateipfade, etc. festzulegen.

import

Startet einen gewünschten Import nach ENBREA (z.B. von DAVINCI). Grundlage ist die zuvor erstellte und angepasste Konfigurationsdatei.

export

Startet einen gewünschten Export aus ENBREA (z.B. nach DAVINCI). Grundlage ist die zuvor erstellte und angepasste Konfigurationsdatei.

list-schoolterms

enbrea list-schoolterms -c c:\enbrea\enbrea.json

Listet alle Zeiträume in der ENBREA-Datenbank auf.

create-snapshot

enbrea create-snapshot -c c:\enbrea\enbrea.json

Erstellt einen Snapshot der ENBREA-Datenbank und legt dieses ab. Ein Snapshot (zu Deutsch: Momentaufnahme) ist ein serverseitiges Backup, dass Sie bei Bedarf zu einem späteren Zeitpunkt wieder einspielen können.

restore-snapshot

enbrea restore-snapshot -c c:\enbrea\enbrea.json -id ef0ac248-5968-465a-ba33-6a649ee747da

Spielt einen Snapshot der ENBREA-Datenbank wieder ein. Der Snapshot wird anhand der ID identifiziert.

list-snapshots

enbrea list-snapshots -c c:\enbrea\enbrea.json

Listet alle erstellten Snapshots der ENBREA-Datenbank auf.

backup

enbrea backup-offline -c c:\enbrea\enbrea.json -o c:\enbrea\meine-daten.backup

Erstellt ein PostgreSQL-Backup der ENBREA-Datenbank und lädt es herunter. Mit dieser Funktion bekommen Sie Offline-Zugriff auf Ihre ENBREA-Daten.

create-import-task

Plant eine Aufgabe im Windows-Aufgabenplaner zum automatisierten Import nach ENBREA.

create-export-task

Plant eine Aufgabe im Windows-Aufgabenplaner zum automatisierten Export aus ENBREA.

delete-import-task

Löscht einen automatisierten Import aus dem Windows-Aufgabenplaner.

delete-export-task

Löscht einen automatisierten Export aus dem Windows-Aufgabenplaner.

delete-tasks

Löscht alle automatisierten Import- und Export-Aufgaben aus dem Windows-Aufgabenplaner.

list-tasks

Listet alle erstellten Import- und Export-Aufgaben im Windows-Aufgabenplaner auf.