Difference between revisions of "OS4X plugin os4xplugin enqueue"

Latest revision as of 08:35, 29 July 2024

Purpose

Putting all files defined in the passed XML into the OS4X send queue for OFTP transmission. The comment "OS4X Enterprise send job #..." is appended to the send queue entry in order to distinguish the send queue entries from one another. This plugin uses the function from the program "os4xeq" and outputs its output as well as the command that was used. If the addressee uses non-default OFTP parameters, these are passed to the "os4xeq" program.

The environment variable "OS4X_JOB_XML" refers to the job XML for plugin execution. In addition, information can be dynamically extracted from a job in other protocols such as SCP, for example.

Requirements

File /etc/os4x.conf or configuration file referenced by environment variable $OS4X_CFGFILE. The temporary directory and the license file are obtained via the database that is configured here.

Configuration

-

Parameter

As an asynchronous plugin, this plugin must support the "-c" parameter. This deletes all send queue entries that have the corresponding comment. Because OS4X aborts all active send queue transfers for which no entry exists (and this happens at the latest after the progress bar update time of 3 seconds for active transfers has expired), processes are not actively terminated.

Return value

0: everything OK
1: Execution of "os4xeq" failed (see plugin output)
2: no valid recipient found

@@ Line 1: / Line 1: @@
 [[Category:Plugins]]
-== 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.
+== Purpose ==
-Dieses Plugin nutzt die Funktion aus dem Programm "<code>os4xeq</code>"und gibt dessen Ausgabe aus sowie das Kommando, das genutzt wurde.
+Putting all files defined in the passed XML into the OS4X send queue for OFTP transmission. The comment "OS4X Enterprise send job #..." is appended to the send queue entry in order to distinguish the send queue entries from one another.
-Falls der Adressat nicht-Default-OFTP-Parameter nutzt, werden diese dem Programm "<code>os4xeq</code>" übergeben.
+This plugin uses the function from the program "<code>os4xeq</code>" and outputs its output as well as the command that was used.
+If the addressee uses non-default OFTP parameters, these are passed to the "<code>os4xeq</code>" program.
-Die Umgebungsvariable "<code>OS4X_JOB_XML</code>" verweist auf das Job-XML zur Plugin-Ausführung. Darüber können z.B. in [[OS4X Enterprise - other protocols|anderen Protokollen]] wie z.B. SCP dynamisch Informationen aus einem Job extrahiert werden.
+The environment variable "<code>OS4X_JOB_XML</code>" refers to the job XML for plugin execution. In addition, information can be dynamically extracted from a job in [[OS4X Enterprise - other protocols|other protocols]] such as SCP, for example.
-== Voraussetzungen ==
+== Requirements ==
+* File <code>/etc/os4x.conf</code> or configuration file referenced by environment variable <code>$OS4X_CFGFILE</code>. The temporary directory and the license file are obtained via the database that is configured here.
-* 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 ==
+== Configuration ==
 -
 == Parameter ==
+As an asynchronous plugin, this plugin must support the "<code>-c</code>" parameter. This deletes all send queue entries that have the corresponding comment. Because OS4X aborts all active send queue transfers for which no entry exists (and this happens at the latest after the progress bar update time of 3 seconds for active transfers has expired), processes are not actively terminated.
-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 ==