Difference between revisions of "OS4X plugin os4xplugin enqueue passive"
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Plugins]] | [[Category:Plugins]] | ||
| − | |||
| − | + | == 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 "<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. | ||
| − | + | In contrast to the plugin [[OS4X plugin os4xplugin_enqueue]], this plugin puts the files in the send queue in such a way that they are only actively picked up by the partner and are not actively sent by OS4X. | |
| − | == | + | == 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. | |
| − | * | ||
| − | |||
| − | |||
| + | == Configuration == | ||
- | - | ||
== Parameter == | == 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 the standard 3 seconds for active transfers has expired), processes are not actively terminated. | ||
| − | + | == Return value == | |
| − | + | *0: everything OK | |
| − | == | + | *1: Execution of "<code>os4xeq</code>" failed (see plugin output) |
| − | *0: | + | *2: no valid recipient found |
| − | *1: | ||
Latest revision as of 08:37, 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.
In contrast to the plugin OS4X plugin os4xplugin_enqueue, this plugin puts the files in the send queue in such a way that they are only actively picked up by the partner and are not actively sent by OS4X.
Requirements
- File
/etc/os4x.confor 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 the standard 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