Difference between revisions of "OS4X plugin os4xplugin engdatv2 decode"

From OS4X
Jump to navigation Jump to search
Line 1: Line 1:
−
== Zweck ==
+
== Purpose ==
−
 
+
Recognize the ENGDAT abstract file in a job and analyze its content. The ENGDAT abstract file is separated into different segments, the following are taken into account:
−
Erkennt eine Datei in einem Auftrags-Dateiset als ENGDAT Abstract File und analysiert ihren Inhalt.  
+
*UNB: Address code of recipient and sender
−
 
+
*MID: Output of the document ID
−
Analysierte Eigenschaften der ENGDAT:
 
−
*UNB: (Adresscode des Absenders und Empfängers)
 
−
*MID: Ausgabe der Document Number
 
 
*EFC:
 
*EFC:
 
**Filename
 
**Filename
 
**File sequence number
 
**File sequence number
−
**Kompression
+
**Compression
−
**Format (Plaintext & ODDC77-Codierung)
+
**Format (Plaintext & ODDC77 encoding)
−
*FTX (Freitext, Kommentar). Sowohl für Auftrag wie einzelne Dateien.
+
*FTX (free text, comment; both for job and single files supported)
  
−
Markiert die gefundene ENGDAT Abstract File in der übergebenen XML als "type=ENGDAT", um sie im späteren Verlauf zu löschen (z.B. bei erfolgreichem Durchlauf des Auftrags).
+
The plugin marks the found ENGDAT abstract file with the XML attribute "type=ENGDAT" in order to let it be deleted by the [[OS4X plugin os4xplugin_remove_engdat|remove ENGDAT]] plugin.
  
−
Falls eine Nutzdatei mit dem Kompressionstyp "gzip" im Feld EFC 4891 angegeben wird, wird folgende Prüfung vollzogen:
+
If a file is marked with the compression type "gzip" in the field EFC4891, the following checks will be executed:
−
*Ist die Datei ein GZIP-File?
+
*Is the file really a GZIP compressed file?
−
*Falls ja: ist der Suffix der Datei "<code>.gz</code>"? Falls nein: wird dieser angehängt, solange keine gleichnamige Datei existiert.
+
*If yes: is the suffix of the file "<code>.gz</code>"? If not, the suffix will be appended to the filename as long as no other file with the same name exists.
−
*Dekompression der Datei.
+
*Decompression of the file.
−
*Der Dateiname in der ENGDAT (ohne Suffix "<code>.gz</code>") wird so modifiziert, dass der Originaldateiname verfügbar ist.
+
*The name of the file in the ENGDAT abstract file (without the suffix "<code>.gz</code>") will be modified, so the original filename is available.
  
−
== Voraussetzungen ==
+
== Requirements ==
  
−
* 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.
+
*OS4X configuration file <code>/etc/os4x.conf</code> exists or the file pointed to via the environment variable <code>$OS4X_CFGFILE</code> exists. The referenced configuration file defines the used database, from which the temporary directory and license information will be extracted.
  
−
== Konfiguration ==
+
== Configuration ==
  
 
-
 
-
  
−
== Rückgabewerte ==
+
== Return values ==
−
*0: alles OK
+
*0: everything OK
−
*1: Anzahl der Argumente falsch (ungleich 1); Konfigurationsdatei nicht lesbar
+
*1: wrong arguments or configuration file not readable
−
*2: Konfiguration in Datenbank nicht lesbar
+
*2: database connection error
 +
 
 +
== Automatic sender learning ==

Revision as of 10:13, 30 October 2014

Purpose

Recognize the ENGDAT abstract file in a job and analyze its content. The ENGDAT abstract file is separated into different segments, the following are taken into account:

  • UNB: Address code of recipient and sender
  • MID: Output of the document ID
  • EFC:
    • Filename
    • File sequence number
    • Compression
    • Format (Plaintext & ODDC77 encoding)
  • FTX (free text, comment; both for job and single files supported)

The plugin marks the found ENGDAT abstract file with the XML attribute "type=ENGDAT" in order to let it be deleted by the remove ENGDAT plugin.

If a file is marked with the compression type "gzip" in the field EFC4891, the following checks will be executed:

  • Is the file really a GZIP compressed file?
  • If yes: is the suffix of the file ".gz"? If not, the suffix will be appended to the filename as long as no other file with the same name exists.
  • Decompression of the file.
  • The name of the file in the ENGDAT abstract file (without the suffix ".gz") will be modified, so the original filename is available.

Requirements

  • OS4X configuration file /etc/os4x.conf exists or the file pointed to via the environment variable $OS4X_CFGFILE exists. The referenced configuration file defines the used database, from which the temporary directory and license information will be extracted.

Configuration

-

Return values

  • 0: everything OK
  • 1: wrong arguments or configuration file not readable
  • 2: database connection error

Automatic sender learning

Retrieved from "https://wiki.os4x.com/index.php?title=OS4X_plugin_os4xplugin_engdatv2_decode&oldid=2206"