Home

Was ist Enbrea CLI?

Das Enbrea Client Interface (kurz: Enbrea CLI) ist eine plattformunabhängige Konsolenanwendung. Sie erlaubt es, mit einer Enbrea-Instanz von einer lokalen Kommandozeile aus zu kommunizieren.

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 unter Windows

Installation

Enbrea CLI kann auf einem beliebigen Windows-Computer installiert werden:

1. Bitte die GitHub-Releases-Webseite für Enbrea CLI im Web-Browser öffnen.

2. Das passende Installationspaket für die aktuellste Version herunterladen. In der Regel wird dies das MSI-Paket für Windows 64bit sein.

3. Das MSI-Paket auf dem Computer starten und den Anweisungen folgen.

Important

Die Installation von Enbrea CLI benötigt Administrationsrechte.

Ein kurzer Test

Enbrea CLI wird über die Kommandozeile bedient. Dabei ist es Ihnen überlassen, ob Sie die klassische Windows-Eingabeaufforderung oder PowerShell nutzen möchten.

Ein Test mit Hilfe der Windows-Eingabeaufforderung soll sicherstellen, dass die Installation erfolgreich war:

1. Im Suchfeld der Windows-Taskleiste Eingabeaufforderung eintippen und die Windows-Eingabeaufforderung öffnen.

   

2. Folgendes eintippen und mit der Eingabetaste bestätigen.

   enbrea -?
   

Es sollte eine Ausgabe erscheinen, welche die unterstützten Befehle von Enbrea CLI kurz und knapp beschreibt.

Enbrea CLI-Befehle

Enbrea CLI stellt die folgenden Befehle bereit:

• init

  Legt eine neue JSON-Konfigurationsdatei für den Import nach Enbrea und dem Export von Enbrea an. Diese Konfigurationsdatei muss anschließend editiert werden, um individuelle Dateipfade, URLs, Authentifizierung etc. festzulegen.

• import

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

• export

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

• list-schoolterms

  Listet alle verfügbaren Enbrea-Zeiträume auf.

• create-snapshot

  Erstellt einen Snapshot der Enbrea-Datenbank und legt diesen 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

  Spielt einen Snapshot der Enbrea-Datenbank wieder ein.

• delete-snapshot

  Löscht einen Snapshot der Enbrea-Datenbank und gibt den Speicherplatz wieder frei.

• list-snapshots

  Listet alle erstellten Snapshots der Enbrea-Datenbank auf.

• create-import-task

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

• enable-import-task

  Aktiviert die Aufgabe im Windows-Aufgabenplaner zum automatisierten Import nach Enbrea.

• disable-import-task

  Deaktiviert die Aufgabe im Windows-Aufgabenplaner zum automatisierten Import nach Enbrea.

• create-export-task

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

• enable-export-task

  Aktiviert die Aufgabe im Windows-Aufgabenplaner zum automatisierten Export aus Enbrea.

• disable-export-task

  Deaktiviert die 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.

• backup-offline

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