Difference between revisions of "OS4X plugin os4xplugin enqueue passive"

From OS4X
Jump to navigation Jump to search
(New page: == Zweck == == Voraussetzungen == * Datei <code>/etc/os4x.conf</code> == Konfiguration == - == Rückgabewerte == 0: alles OK)
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
[[Category:Plugins]]
 
== Zweck ==
 
== 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 "<code>os4xeq</code>" und gibt dessen Ausgabe aus sowie das Kommando, das genutzt wurde.
 +
Falls der Adressat nicht-Default-OFTP-Parameter nutzt, werden diese dem Programm "<code>os4xeq</code>" übergeben.
 +
 +
Im Gegensatz zum Plugin [[OS4X plugin os4xplugin_enqueue]] stellt dieses Plugin die Dateien allerdings so in die Sendewarteschlange, dass sie nur vom Partner aktiv abgeholt werden und nicht von OS4X aktiv versendet werden.
  
 
== Voraussetzungen ==
 
== Voraussetzungen ==
  
* Datei <code>/etc/os4x.conf</code>
+
* Datei <code>/etc/os4x.conf</code> bzw. Konfigurationsdatei in der Umgebungsvariable <code>$OS4X_CFGFILE</code> definiert. Über die Datenbank, die hier konfiguriert ist, wird das temporäre Verzeichnis sowie das Lizenzfile bezogen.
  
 
== Konfiguration ==
 
== Konfiguration ==
Line 10: Line 16:
 
-
 
-
  
== Rückgabewerte ==
+
== Parameter ==
0: alles OK
+
 
 +
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: everything OK
 +
*1: Execution of "<code>os4xeq</code>" failed (see plugin output)
 +
*2: no valid recipient found

Latest revision as of 09:23, 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.

Im Gegensatz zum Plugin OS4X plugin os4xplugin_enqueue stellt dieses Plugin die Dateien allerdings so in die Sendewarteschlange, dass sie nur vom Partner aktiv abgeholt werden und nicht von OS4X aktiv versendet werden.

Voraussetzungen

  • Datei /etc/os4x.conf bzw. Konfigurationsdatei in der Umgebungsvariable $OS4X_CFGFILE definiert. Ü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