Difference between revisions of "OS4X plugin os4xplugin filemove"

Revision as of 11:43, 11 August 2015

Zweck

Umbewegen aller Dateien des Auftrags in ein definiertes Verzeichnis. Dabei gilt folgende Regelung:

<data incoming directory>/<jobnummer> für eingehende Jobs
<data_outgoing_directory>/<jobnummer> für ausgehende oder unbekannte Jobs

Voraussetzungen

Datei /etc/os4x.conf bzw. Konfigurationsdatei in der Umgebungsvariable $OS4X_CFGFILE definiert. Über die Datenbank, die hier konfiguriert ist, wird das temporäre Verzeichnis sowie das Lizenzfile bezogen.

Konfiguration

Es kann ein Zielverzeichnis vergeben werden, wenn die Defaultwerte (s.o.) nicht genutzt werden sollen. Beachten Sie, dass für jede Hierarchie-Ebene an Adressinformation (also Firma, Standort, Abteilung oder Zielperson selbst) unterschiedlich sein kann. Das Zielverzeichnis kann Variablen enthalten, welche zur Laufzeit des Plugins aufgelöst werden.

Die nutzbaren Variablen sind:

%j: Jobnummer
%d: Tag der Joberzeugung (zweistellig)
%m: Monat der Joberzeugung (zweistellig)
%Y: Jahr der Joberzeugung (vierstellig)
%H: Stunde der Joberzeugung (zweistellig, 24h-Format)
%M: Minute der Joberzeugung (zweistellig)
%S: Sekunde der Joberzeugung (zweistellig)
%D: Richtung (derzeit entweder "incoming" oder "outgoing")
%r: Empfänger-Firmenkurzname
%s: Sender-Firmenkurzname

Seit OS4X 3 sind folgende Variablen zusätzlich nutzbar:

%t: Empfänger Standortname
%u: Empfänger Abteilungsname
%v: Empfänger Vorname
%w: Empfänger Nachname
%x: Empfänger Adresscode
%g: Sender Standortname
%h: Sender Abteilungsname
%i: Sender Vorname
%J: Sender Nachname
%k: Sender Adresscode

Seit OS4X 3 Build 20140227 ist folgende Variable nutzbar:

%e: Abhängig von der Auftrags-Richtung, ist diese Variable der Firmenkurzname des externen Kommunikationspartners:
- bei Eingangs-Aufträgen: Sender-Firmenkurzname (analog "%s")
- bei Ausgangs-Aufträgen (oder nicht definierbarer Auftrags-Richtung): Empfänger-Firmenkurzname (analog "%r")

Seit OS4X 3 Build 201508117 ist folgende Variable nutzbar:

%a: ENGDAT Message Reference [UNH0062] (falls angegeben, ansonsten leer)
%b: ENGDAT Document Number [MID1004] (falls angegeben, ansonsten leer)

Beispiele

Alle Beispiele basieren auf einem OS4X-Sendeauftrag mit der Nummer 76 von und an Firma "c-works"

/opt/os4x/tmp/%r/os4x_job_%j/

wird zu:

/opt/os4x/tmp/c-works/os4x_job_76

/opt/os4x/tmp/%D/%r/%j

wird zu:

/opt/os4x/tmp/outgoing/c-works/76

Ein SWAN-ähnliches Konstrukt wäre z.B.:

/opt/os4x/data/%Y/%m/%d/%j

welches aufgelöst wird zu:

/opt/os4x/data/2008/03/18/76

Rückgabewerte

0: alles OK

1: Configfile (/etc/os4x.conf bzw. Inhalt der Variable "OS4X_CFGFILE") kann nicht gelesen werden oder die hier konfigurierte Datenbank kann nicht verbunden werden

2: Lizenzfehler

3: XML-Parameterfile kann nicht geparsed werden

4: Datei(en) konnten nicht bewegt werden

@@ Line 41: / Line 41: @@
 **bei Eingangs-Aufträgen: Sender-Firmenkurzname (analog "<code>%s</code>")
 **bei Ausgangs-Aufträgen (oder nicht definierbarer Auftrags-Richtung): Empfänger-Firmenkurzname (analog "<code>%r</code>")
+Seit OS4X 3 Build 201508117 ist folgende Variable nutzbar:
+*%a: ENGDAT Message Reference [UNH0062] (falls angegeben, ansonsten leer)
+*%b: ENGDAT Document Number [MID1004] (falls angegeben, ansonsten leer)
 == Beispiele ==