Difference between revisions of "OS4X plugin os4xplugin engdatv2 encode"

From OS4X
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
== Zweck ==
+
[[Category:Plugins]]
 +
== Purpose ==
 +
Creation of an ENGDAT v2 abstract file based on the parameters of the job. The abstract file is added to the order. The existing files are renamed according to the ENGDAT standard (only the virtual file name). The ENGDAT abstract file receives the attribute "<code>type=ENGDAT</code>" in the XML file. The file is saved in temp. OS4X directory and receives the name prefix "<code>os4x.engdat.</code>".
  
−
Erzeugung einer ENGDAT v2 abstract file, basierend auf den Parametern des Auftrags. Die Abstract-File wird dem Auftrag hinzugefügt. Die bestehenden Dateien werden gemäß ENGDAT-Norm umbenannt (nur der virt. Filename). Die ENGDAT Abstract-File erhält in der XML-Datei das Attribut "<code>type=ENGDAT</code>". Die Datei wird im temp. OS4X-Verzeichnis abgelegt und erhält den Namenspräfix "<code>os4x.engdat.</code>".
+
The following ENGDAT fields are implemented:
−
 
 
−
Folgende ENGDAT-Felder werden umgesetzt:
 
 
*UNB
 
*UNB
 
*UNH
 
*UNH
Line 15: Line 15:
 
*UNZ
 
*UNZ
  
−
== 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 ==
 
== Konfiguration ==
Line 23: Line 22:
 
-
 
-
  
−
== Rückgabewerte ==
+
== Return codes ==
−
0: alles OK
+
*0: everything OK
−
1: Datei "<code>/etc/os4x.conf</code>" nicht lesbar; Anzahl Parameter nicht 1; XML-Dokument leer; XML-Dokument nicht parsebar; Anzahl Dateien gleich 0; mehr als 999 Dateien im Auftrag
+
*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; Number of files equals 0; more than 999 files in the order
−
2: datenbankseitige Konfiguration von OS4X nicht lesbar; XML-Dokument nicht OS4X-konform
+
*2: database side configuration of OS4X not readable; XML document not OS4X compliant

Latest revision as of 08:34, 29 July 2024

Purpose

Creation of an ENGDAT v2 abstract file based on the parameters of the job. The abstract file is added to the order. The existing files are renamed according to the ENGDAT standard (only the virtual file name). The ENGDAT abstract file receives the attribute "type=ENGDAT" in the XML file. The file is saved in temp. OS4X directory and receives the name prefix "os4x.engdat.".

The following ENGDAT fields are implemented:

  • UNB
  • UNH
  • MID
  • SDE
  • RDE
  • FTX
  • EFC
  • TOT
  • UNT
  • UNZ

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.

Konfiguration

-

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; Number of files equals 0; more than 999 files in the order
  • 2: database side configuration of OS4X not readable; XML document not OS4X compliant
Retrieved from "https://wiki.os4x.com/index.php?title=OS4X_plugin_os4xplugin_engdatv2_encode&oldid=3758"