Difference between revisions of "OS4X plugin os4xplugin filecopy"

Revision as of 07:36, 3 November 2017

Puropose

Copy 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

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
%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 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 20160407 sind folgende Variablen nutzbar:

%a: ENGDAT Message Reference [UNH0062] (falls angegeben, ansonsten leer)
%b: ENGDAT Document Number [MID1004] (falls angegeben, ansonsten leer)
%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 kopiert werden

@@ Line 1: / Line 1: @@
 [[Category:Plugins]]
-== Zweck ==
+== Puropose ==
-Kopieren aller Dateien des Auftrags in ein definiertes Verzeichnis. Dabei gilt folgende Regelung:
+Copy 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.