Difference between revisions of "OS4X plugin os4xplugin filemove"

Revision as of 07:29, 3 November 2017

Puropose

Move all files of a job into a defined target directory. The default assumption is:

<data incoming directory>/<jobnummer> for incoming jobs
<data_outgoing_directory>/<jobnummer> for outgoing or jobs of unknown type

Requirements

File /etc/os4x.conf or configuration file pointed to in environment variable $OS4X_CFGFILE. Via the used configuration file, the information are retrieved used by the plugin (such as default configuration etc.).

Configuration

The target filename can be set up to contain variables. These variables are exchanged by runtime information of the OS4X job, in which context the plugin is run.

The usable variables are:

%j: job number
%d: day of job creation (two digits)
%m: month of job creation (two digits)
%Y: year of job creation (four digits)
%H: hour of job creation (two digits, 24h format)
%M: minute of job creation (two digits)
%S: second of job creation (two digits)
%D: job direction: "incoming" or "outgoing"
%r: recipient partner shortname
%s: sender partner shortname
%t: recipient location name
%u: recipient department name
%v: recipient first name
%w: recipient family name
%x: recipient address code
%g: Sender Standortname
%g: sender location name
%i: sender first name
%J: sender family name
%k: sender address code

Seit OS4X 3 Build 20140227 sind folgende Variablen 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 sind folgende Variablen nutzbar:

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

Seit OS4X 3 Build 20160407 sind folgende Variablen nutzbar:

%y: Empfänger Benutzername ("unknown" falls leer)
%l: Sender Benutzername ("unknown" falls 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 1: / Line 1: @@
 [[Category:Plugins]]
-== Zweck ==
+== Puropose ==
-Umbewegen aller Dateien des Auftrags in ein definiertes Verzeichnis. Dabei gilt folgende Regelung:
+Move all files of a job into a defined target directory. The default assumption is:
-*<[[OS4X Core configuration#data_incoming_directory|data incoming directory]]>/<jobnummer> für eingehende Jobs
+*<[[OS4X Core configuration#data_incoming_directory|data incoming directory]]>/<jobnummer> for incoming jobs
-*<[[OS4X Core configuration#data_outgoing_directory|data_outgoing_directory]]>/<jobnummer> für ausgehende oder unbekannte Jobs
+*<[[OS4X Core configuration#data_outgoing_directory|data_outgoing_directory]]>/<jobnummer> for outgoing or jobs of unknown type
-== 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.
+* File <code>/etc/os4x.conf</code> or configuration file pointed to in environment variable <code>$OS4X_CFGFILE</code>. Via the used configuration file, the information are retrieved used by the plugin (such as default configuration etc.).
-== Konfiguration ==
+== Configuration ==
-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.
+The target filename can be set up to contain variables. These variables are exchanged by runtime information of the OS4X job, in which context the plugin is run.
-Die nutzbaren Variablen sind:
+The usable variables are:
-*%j: Jobnummer
+*%j: job number
-*%d: Tag der Joberzeugung (zweistellig)
+*%d: day of job creation (two digits)
-*%m: Monat der Joberzeugung (zweistellig)
+*%m: month of job creation (two digits)
-*%Y: Jahr der Joberzeugung (vierstellig)
+*%Y: year of job creation (four digits)
-*%H: Stunde der Joberzeugung (zweistellig, 24h-Format)
+*%H: hour of job creation (two digits, 24h format)
-*%M: Minute der Joberzeugung (zweistellig)
+*%M: minute of job creation (two digits)
-*%S: Sekunde der Joberzeugung (zweistellig)
+*%S: second of job creation (two digits)
-*%D: Richtung (derzeit entweder "<code>incoming</code>" oder "<code>outgoing</code>")
+*%D: job direction: "<code>incoming</code>" or "<code>outgoing</code>"
-*%r: Empfänger-Firmenkurzname
+*%r: recipient partner shortname
-*%s: Sender-Firmenkurzname
+*%s: sender partner shortname
+*%t: recipient location name
-Seit OS4X 3 sind folgende Variablen zusätzlich nutzbar:
+*%u: recipient department name
-*%t: Empfänger Standortname
+*%v: recipient first name
-*%u: Empfänger Abteilungsname
+*%w: recipient family name
-*%v: Empfänger Vorname
+*%x: recipient address code
-*%w: Empfänger Nachname
-*%x: Empfänger Adresscode
 *%g: Sender Standortname
-*%h: Sender Abteilungsname
+*%g: sender location name
-*%i: Sender Vorname
+*%i: sender first name
-*%J: Sender Nachname
+*%J: sender family name
-*%k: Sender Adresscode
+*%k: sender address code
 Seit OS4X 3 Build 20140227 sind folgende Variablen nutzbar: