Benutzer-Werkzeuge

Webseiten-Werkzeuge


access_cli

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen gezeigt.

Link zu der Vergleichsansicht

Nächste Überarbeitung
Vorherige Überarbeitung
access_cli [2013/08/04 04:24]
nick angelegt
access_cli [2023/09/28 17:19] (aktuell)
smg [Synchronisation mit Kanu-eFB]
Zeile 16: Zeile 16:
  
 Ein beispielhafter Aufruf von efaCLI unter Windows könnte folgendermaßen aussehen: Ein beispielhafter Aufruf von efaCLI unter Windows könnte folgendermaßen aussehen:
 +
 ''efaCLI.bat admin@localhost/meinprojekt'' ''efaCLI.bat admin@localhost/meinprojekt''
 +
 Unter Linux hat der entsprechende Aufruf die Form: Unter Linux hat der entsprechende Aufruf die Form:
 +
 ''./efaCLI.sh admin@localhost/meinprojekt'' ''./efaCLI.sh admin@localhost/meinprojekt''
  
 Ohne Angabe eines Kommandos startet efaCLI eine interaktive Shell, in der Kommandos eingegeben werden können. efaCLI hat mehrere Menüebenen, die durch den Eingabeprompt angezeigt werden. Das Kommando ''help'' zeigt eine Hilfe für das aktuelle Menü. Mit ''exit'' wird das Menü verlassen, und ''quit'' beendet efaCLI: Ohne Angabe eines Kommandos startet efaCLI eine interaktive Shell, in der Kommandos eingegeben werden können. efaCLI hat mehrere Menüebenen, die durch den Eingabeprompt angezeigt werden. Das Kommando ''help'' zeigt eine Hilfe für das aktuelle Menü. Mit ''exit'' wird das Menü verlassen, und ''quit'' beendet efaCLI:
 +
 <code>./efaCLI.sh admin@localhost/meinprojekt <code>./efaCLI.sh admin@localhost/meinprojekt
 INPUT - CLI003 - efaCLI:main> help INPUT - CLI003 - efaCLI:main> help
Zeile 42: Zeile 46:
  
 Um beispielsweise ein Backup aller Daten zu erstellen, kann efaCLI wie folgt aufgerufen werden: Um beispielsweise ein Backup aller Daten zu erstellen, kann efaCLI wie folgt aufgerufen werden:
 +
 ''./efaCLI.sh admin@localhost/meinprojekt -cmd "backup create all"'' ''./efaCLI.sh admin@localhost/meinprojekt -cmd "backup create all"''
 +
 Eine Statistik zu einer abgespeicherten Statistikeinstellung //Kilometerliste (HTML)// kann folgendermaßen in efaCLI aufgerufen werden: Eine Statistik zu einer abgespeicherten Statistikeinstellung //Kilometerliste (HTML)// kann folgendermaßen in efaCLI aufgerufen werden:
 +
 ''./efaCLI.sh admin@localhost/meinprojekt -cmd "statistics create Kilometerliste (HTML)"'' ''./efaCLI.sh admin@localhost/meinprojekt -cmd "statistics create Kilometerliste (HTML)"''
  
Zeile 76: Zeile 83:
  
 Beispiele: Beispiele:
 +
 Um eine Personenliste im CSV-Format in die Datei ''/tmp/personen.csv'' zu exportieren: Um eine Personenliste im CSV-Format in die Datei ''/tmp/personen.csv'' zu exportieren:
 +
 ''persons export -format=csv /tmp/personen.csv'' ''persons export -format=csv /tmp/personen.csv''
 +
 Um eine Bootsliste aus der Datei ''/tmp/boote.xml'' zu importieren und nur Einträge zu aktualisieren: Um eine Bootsliste aus der Datei ''/tmp/boote.xml'' zu importieren und nur Einträge zu aktualisieren:
 +
 ''boats import -impmode=update /tmp/boote.xml'' ''boats import -impmode=update /tmp/boote.xml''
  
Zeile 89: Zeile 100:
  
 **Hinweis:** Die Kommandos erlauben nur das Erstellen von Statistiken, die in Dateien ausgegeben, per email versand oder per FTP hochgeladen werden. Interaktive Statistiken (zur graphischen Anzeige) lassen sich über diese Kommandos nicht erstellen. **Hinweis:** Die Kommandos erlauben nur das Erstellen von Statistiken, die in Dateien ausgegeben, per email versand oder per FTP hochgeladen werden. Interaktive Statistiken (zur graphischen Anzeige) lassen sich über diese Kommandos nicht erstellen.
 +
  
 Beispiele: Beispiele:
 Um eine Kilometerliste zu erstellen, die unter dem Namen //Kilometerliste// als Statistikeinstellung abgespeichert wurde: Um eine Kilometerliste zu erstellen, die unter dem Namen //Kilometerliste// als Statistikeinstellung abgespeichert wurde:
 +
 ''statistics create Kilometerliste'' ''statistics create Kilometerliste''
 +
 Um ein individuelles Fahrtenbuch für Manfred Mustermann zu erstellen, unter Verwendung der zuvor erzeugten Statistikeinstellung //Individuelles Fahrtenbuch//: Um ein individuelles Fahrtenbuch für Manfred Mustermann zu erstellen, unter Verwendung der zuvor erzeugten Statistikeinstellung //Individuelles Fahrtenbuch//:
 +
 ''statistics create -name=Mustermann,_Manfred Individuelles Fahrtenbuch'' (beachte den Unterstrich!) ''statistics create -name=Mustermann,_Manfred Individuelles Fahrtenbuch'' (beachte den Unterstrich!)
 +
 Um ein individuelles Fahrtenbuch für alle Personen zu erstellen, unter Verwendung der zuvor erzeugten Statistikeinstellung //Individuelles Fahrtenbuch//: Um ein individuelles Fahrtenbuch für alle Personen zu erstellen, unter Verwendung der zuvor erzeugten Statistikeinstellung //Individuelles Fahrtenbuch//:
-''statistics create -all Individuelles Fahrtenbuch'' (hierbei wird für jede Person eine separate Datei erstellt bzw. separate email verschickt)+ 
 +''statistics create all Individuelles Fahrtenbuch'' (hierbei wird für jede Person eine separate Datei erstellt bzw. separate email verschickt)
  
 ==== Datensicherungen erstellen und wiederherstellen ==== ==== Datensicherungen erstellen und wiederherstellen ====
Zeile 108: Zeile 125:
  
 Beispiele: Beispiele:
 +
 Um ein Backup des aktuellen Projekts und der Konfiguration zu erstellen: Um ein Backup des aktuellen Projekts und der Konfiguration zu erstellen:
 +
 ''backup create all'' ''backup create all''
 +
 Um ein Backup des aktuellen Projekts an die email-Adresse //name@domain.com// zu verschicken: Um ein Backup des aktuellen Projekts an die email-Adresse //name@domain.com// zu verschicken:
 +
 ''backup create project mailto:name@domain.com'' ''backup create project mailto:name@domain.com''
 +
 Um eine komplette Sicherung aus der Datei //efaBackup_20130513_223131.zip// wiederherzustellen: Um eine komplette Sicherung aus der Datei //efaBackup_20130513_223131.zip// wiederherzustellen:
 +
 ''backup restore efaBackup_20130513_223131.zip'' ''backup restore efaBackup_20130513_223131.zip''
 +
 Um nur das 2013er Fahrtenbuch (mit dem Namen //2013//) einer Sicherung aus der Datei //efaBackup_20130513_223131.zip// wiederherzustellen: Um nur das 2013er Fahrtenbuch (mit dem Namen //2013//) einer Sicherung aus der Datei //efaBackup_20130513_223131.zip// wiederherzustellen:
 +
 ''backup restore efaBackup_20130513_223131.zip 2013.efa2logbook'' ''backup restore efaBackup_20130513_223131.zip 2013.efa2logbook''
 +
 +==== Synchronisation mit Kanu-eFB ====
 +
 +Die Synchronisation mit dem Kanu-eFB des DKV kann über das Kommando ''syncefb'' gestartet werden:
 +
 +^ Kommando ^ Unterkommando ^ Optionen               ^ Beschreibung ^
 +| ''syncefb''   | ''run''        | ''%%[logbook]%%'' \\ ''%%[-verbose]%%'' | Synchronisiert die Fahrten des aktuell geöffneten Fahrtenbuchs mit dem Kanu-eFB. Durch Angabe eines speziellen Fahrtenbuchs kann dieses anstelle des derzeit geöffneten Fahrtenbuchs synchronisiert werden. \\ \\ Der optionale Parameter ''%%-verbose%%'' ist ab Version 2.4 vorhanden und sorgt für eine detaillierte Protokollierung der //nicht// synchronisierten Fahrten in das efa.log. \\ \\ Damit ist es möglich, einzelne nicht synchronisierte Fahrten und die Ursachen dafür zu erkennen. |
 +
 +Beispiele:
 +
 +Um die Fahrten des aktuell geöffneten Fahrtenbuchs zu synchronisieren:
 +
 +''syncefb run''
 +
 +Um die Fahrten des Fahrtenbuchs //2013// zu synchronisieren:
 +
 +''syncefb run 2013''
 +
 +===== Return Codes =====
 +
 +Nach der Ausführung von efaCLI gibt efaCLI die folgenden Return Codes zurück, wobei 0 eine erfolgreiche Ausführung anzeigt, und Werte ungleich null einen Fehler signalisieren:
 +
 +^ Return Code                      ^ Wert ^
 +| RC_OK                            |    0 |
 +| RC_ERROR_LOGIN                      1 |
 +| RC_ERROR_OPEN_PROJECT            |    2 |
 +| RC_UNKNOWN_COMMAND                  3 |
 +| RC_INVALID_COMMAND                  4 |
 +| RC_NO_PERMISSION                    5 |
 +| RC_COMMAND_COMPLETED_WITH_ERRORS |   10 |
 +| RC_COMMAND_FAILED                |   11 |
 +
access_cli.1375583053.txt.gz · Zuletzt geändert: 2013/08/04 04:24 von nick