Difference between revisions of "OS4X plugin os4xplugin promata recipient"

From OS4X
Jump to navigation Jump to search
 
Line 1: Line 1:
 
[[Category:Plugins]]
 
[[Category:Plugins]]
−
== Zweck ==
 
  
−
Bestimmen des Adresscodes des Empfängers eines Auftrags anhand der Rückgabe eines Scripts, welches den virt. Filenamen der Datei des Auftrags enthält. Der Adresscode, der aus dem Script ermittelt wird, wird als einzige Ausgabe auf stdout vom Plugin eingelesen und daraus der Empfänger des Auftrags in der Datenbank gesucht. Falls es mehrere User gibt, die dieses Adresscode nutzen, wird der letzte eingetragene genutzt.
+
== Purpose ==
 +
Determine the address code of the recipient of an order by returning a script that contains the virt. contains the file name of the job file. The address code, which is determined from the script, is read as the only output on stdout by the plugin and the recipient of the order is searched for in the database. If there are several users who use this address code, the last one entered will be used.
  
−
== 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.  
+
*The script for determining the address code must be administered by yourself and has the following absolute (hard, unchangeable) path:
−
*Das Script zur Bestimmung des Adresscodes ist selbst zu administrieren und hat folgenden absoluten (harten, nicht änderbaren) Pfad:
 
 
  $OS4X_SCRIPT_DIR/promata_addressing_recipient.sh
 
  $OS4X_SCRIPT_DIR/promata_addressing_recipient.sh
−
*Das Script erhält folgenden Parameter:
+
*The script receives the following parameters:
−
#virt. Filename
+
#virt. filename
−
 
 
−
Falls mehrere Dateien im Auftrag enthalten sind, wird das Script für jede Datei einzeln aufgerufen. Die letzte Datei des Auftrags definiert somit den Aufruf des genutzten Adresscodes.
 
−
 
 
−
== Konfiguration ==
 
−
(keine)
 
−
 
 
−
== Rückgabewerte ==
 
−
0: alles OK
 
  
−
1: Configfile (/etc/os4x.conf bzw. Inhalt der Variable "<code>OS4X_CFGFILE</code>") kann nicht gelesen werden oder die hier konfigurierte Datenbank kann nicht verbunden werden
+
If several files are included in the order, the script is called individually for each file. The last file of the order defines the call of the address code used.
  
−
2: Lizenzfehler
+
== Configuration ==
 +
-
  
−
3: XML-Parameterfile kann nicht geparsed werden
+
== Return codes ==
 +
*0: everything OK
 +
*1: Number of parameters != 1; Config file <code>/etc/os4x.conf</code> not found; Config in database not readable; License not valid
 +
*2: License not valid
 +
*3: XML file invalid

Latest revision as of 08:52, 29 July 2024


Purpose

Determine the address code of the recipient of an order by returning a script that contains the virt. contains the file name of the job file. The address code, which is determined from the script, is read as the only output on stdout by the plugin and the recipient of the order is searched for in the database. If there are several users who use this address code, the last one entered will be used.

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.
  • The script for determining the address code must be administered by yourself and has the following absolute (hard, unchangeable) path:
$OS4X_SCRIPT_DIR/promata_addressing_recipient.sh
  • The script receives the following parameters:
  1. virt. filename

If several files are included in the order, the script is called individually for each file. The last file of the order defines the call of the address code used.

Configuration

-

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
  • 2: License not valid
  • 3: XML file invalid
Retrieved from "https://wiki.os4x.com/index.php?title=OS4X_plugin_os4xplugin_promata_recipient&oldid=3773"