Difference between revisions of "OS4X plugin os4xplugin engdat light"

From OS4X
Jump to navigation Jump to search
 
Line 1: Line 1:
 
[[Category:Plugins]]
 
[[Category:Plugins]]
== Zweck ==
+
== Purpose ==
 +
Changing the virtual file name in the XML file of a job for each file. The basis is the address code of the addressee. If this is longer than 5 digits, the last 5 digits are used. If the address code is shorter than 5 digits, the plugin will abort.
  
Änderung des virtuellen Filenamens in der XML-File eines Auftrags für jede Datei. Grundlage ist der Adresscode des Adressaten. Falls dieser länger als 5 Stellen ist, werden die letzten 5 Stellen genutzt. Falls der Adresscode kürzer als 5 Stellen ist, bricht das Plugin ab.
+
== Requirements ==
 +
* File <code>/etc/os4x.conf</code> or configuration file referenced by environment variable <code>$OS4X_CFGFILE</code>
  
== Voraussetzungen ==
+
== Configuration ==
 +
None.
  
* 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.
+
== Return codes ==
 
+
*0: everything OK
== Konfiguration ==
+
*1: Number of parameters != 1; Config file <code>/etc/os4x.conf</code> not found; Config in database not readable; License not valid; XML file invalid
 
 
-
 
 
 
== Rückgabewerte ==
 
*0: alles OK
 
*1: Anzahl der übergebenen Parameter ungleich 1; problematischer Adresscode (siehe Ausgabe); keine Fileeinträge vorhanden; mehr als 999 Dateien im Auftrag
 

Latest revision as of 08:32, 29 July 2024

Purpose

Changing the virtual file name in the XML file of a job for each file. The basis is the address code of the addressee. If this is longer than 5 digits, the last 5 digits are used. If the address code is shorter than 5 digits, the plugin will abort.

Requirements

  • File /etc/os4x.conf or configuration file referenced by environment variable $OS4X_CFGFILE

Configuration

None.

Return codes

  • 0: everything OK
  • 1: Number of parameters != 1; Config file /etc/os4x.conf not found; Config in database not readable; License not valid; XML file invalid