FLOWWER-Agent einrichten
Begriffe:
Über das Kommandozeilenprogramm ‘FLOWWER-Agent’ (früher: FLOWWER.exe bzw. F2CLI) können verschiedene FLOWWER-Aktionen ausgeführt werden. Das kann zum Beispiel der Download oder Upload von Belegen von und nach FLOWWER sein. Für den automatisierten Start verwenden Sie z.B. die Windows Aufgabenplanung. (siehe https://de.wikipedia.org/wiki/Aufgabenplanung)
Sie können das Programm auf der folgenden Seite herunterladen: FLOWWER-Agent
Was ist ein Kommandoteilenprogramm?
Ein Kommandozeilenprogramm nimmt Anweisungen nicht über Schaltflächen oder Menüs entgegen, sondern in Textform. Sie schreiben einen Befehl, und das Programm führt ihn zuverlässig und immer nach dem gleichen Muster aus.
Man kann sich das wie einen Roboter vorstellen: Er wartet auf klare Befehle, führt sie Schritt für Schritt aus und wiederholt sie jederzeit exakt gleich – zum Beispiel beim Übertragen von Daten.
Warum ist das für FLOWWER Agent wichtig?
FLOWWER Agent ist genau so ein Roboter, der direkt auf dem Server des Kunden läuft.
Damit lassen sich Automatisierungen in eigener Hand umsetzen: Prozesse laufen unbeaufsichtigt, zuverlässig und nach den Vorgaben, die das Unternehmen selbst festlegt.
So bleibt die Kontrolle vollständig beim Kunden, während wiederkehrende Aufgaben automatisch erledigt werden.
Erste Schritte
Alle Kommandos (Verben) für FLOWWER-Agent beziehen sich auf ein FLOWWER-Konto.
Aus diesem Grund müssen die Anfragen durch FLOWWER-Agent sowohl
- sicher von Ihnen kommen (authentisiert sein)
Über den nur Ihnen bekannten API-Key eines API-Benutzer
- berechtigt sein (authorisiert sein)
Der verwendete API-Benutzer benötigt die entsprechenden Berechtigungen
Die Nutzung des API-Key ersetzt die Angabe von Benutzername und Passwort und ist die empfohlene Art der Authentisierung.
Daher empfehlen wir, für FLOWWER-Agent einen eigenen API-Benutzer anzulegen.
Aufbau einer Kommandozeile
Ein typischer Befehl für die Kommandozeile besteht aus mehreren Bestandteilen, die zusammen die Ausführung eines bestimmten Prozesses oder einer Aktion steuern. Die grundlegende Struktur eines Befehls sieht folgendermaßen aus:
programm befehl [optionen] [parameter]
1. programm
Der erste Teil einer Kommandozeile besteht immer aus dem aufzurufenden Programm.
In unserem Fall ist es immer flowwer.exe
2. befehl (Verb)
Dies ist der Hauptteil des Befehls und beschreibt die Aktion, die das Programm ausgeführt werden soll.
Es handelt sich in der Regel um ein Verb, das angibt, welche Operation vorgenommen wird.
3. [optionen] (Optional)
Optionen modifizieren das Verhalten des Befehls.
Sie sind normalerweise kurz (z. B. -l) oder lang (z. B. --long).
Optionen sind optional und ermöglichen einem Befehl genauere Anweisungen mitzuteilen.
4. [parameter] (Optional)
Parameter geben dem Befehl zusätzliche Informationen, auf welche Objekte oder Dateien die Aktion angewendet werden soll. Ein Parameter könnte beispielsweise der Name einer Datei oder eines Verzeichnisses sein.
Beispiele
FLOWWER-Agent zeigt Details zu einem Befehl (Verb) an, indem die Option “–help” verwendet wird, z.B.:
flowwer.exe download --help
^----- Option
^-------------- Befehl (Verb)
^------------------------- Programm
Für einige Verben kann über “–verbose” eine detaillierte Ausgabe aktiviert werden, z.B.:
flowwer.exe status -a *API-Key* -t beispielfirma --verbose
^----- Option
^------------------- Parameter 2
^-------------------------------------- Parameter 1
^--------------------------------------------------- Befehl (Verb)
^-------------------------------------------------------------- Programm
Anwendungsbeispiele
Anwendungsbeispiele finden Sie hier: FLOWWER-Agent - Beispiele