Difference between revisions of "OS4X plugin os4xplugin enqueue"
| Line 20: | Line 20: | ||
Als asynchrones Plugin muss dieses Plugin den Parameter "<code>-c</code>" unterstützen. Hierbei werden alle Send-Queue-Einträge gelöscht, die den entsprechenden Kommentar besitzen. Dadurch, dass OS4X alle aktiven Send-Queue-Transfer abbricht, für die kein Eintrag existiert (und dies geschieht spätestens nach Ablauf der Progressbar-Update-Zeit von standardmäßigen 3 Sekunden bei aktiven Transfers), werden Prozesse nicht aktiv beendet. | Als asynchrones Plugin muss dieses Plugin den Parameter "<code>-c</code>" unterstützen. Hierbei werden alle Send-Queue-Einträge gelöscht, die den entsprechenden Kommentar besitzen. Dadurch, dass OS4X alle aktiven Send-Queue-Transfer abbricht, für die kein Eintrag existiert (und dies geschieht spätestens nach Ablauf der Progressbar-Update-Zeit von standardmäßigen 3 Sekunden bei aktiven Transfers), werden Prozesse nicht aktiv beendet. | ||
| − | == | + | == Return value == |
| − | 0: | + | *0: everything OK |
| − | 1: | + | *1: Execution of "<code>os4xeq</code>" failed (see plugin output) |
| + | *2: no valid recipient found | ||
Revision as of 09:22, 2 May 2017
Zweck
Einstellen aller Dateien, die in der übergebenen XML definiert sind, in die OS4X Sendewarteschlange zur OFTP-Übertragung. Hierbei wird dem Send-Queue-Eintrag der Kommentar "OS4X Enterprise send job #..." angehängt, um die Send-Queue-Einträge voneinander zu unterscheiden.
Dieses Plugin nutzt die Funktion aus dem Programm "os4xeq"und gibt dessen Ausgabe aus sowie das Kommando, das genutzt wurde.
Falls der Adressat nicht-Default-OFTP-Parameter nutzt, werden diese dem Programm "os4xeq" übergeben.
Die Umgebungsvariable "OS4X_JOB_XML" verweist auf das Job-XML zur Plugin-Ausführung. Darüber können z.B. in anderen Protokollen wie z.B. SCP dynamisch Informationen aus einem Job extrahiert werden.
Voraussetzungen
- Datei
/etc/os4x.confbzw. Konfigurationsdatei in der Umgebungsvariable$OS4X_CFGFILEdefiniert. Über die Datenbank, die hier konfiguriert ist, wird das temporäre Verzeichnis sowie das Lizenzfile bezogen.
Konfiguration
-
Parameter
Als asynchrones Plugin muss dieses Plugin den Parameter "-c" unterstützen. Hierbei werden alle Send-Queue-Einträge gelöscht, die den entsprechenden Kommentar besitzen. Dadurch, dass OS4X alle aktiven Send-Queue-Transfer abbricht, für die kein Eintrag existiert (und dies geschieht spätestens nach Ablauf der Progressbar-Update-Zeit von standardmäßigen 3 Sekunden bei aktiven Transfers), werden Prozesse nicht aktiv beendet.
Return value
- 0: everything OK
- 1: Execution of "
os4xeq" failed (see plugin output) - 2: no valid recipient found