Difference between revisions of "OS4X plugin os4xplugin filecopy"

Revision as of 07:39, 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

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 location name
%h: sender department name
%i: sender first name
%J: sender family name
%k: sender address code

Since OS4X 3 Build 20140227 the following variable is available:

%e: depending on the job direction, the company shortname of the external communication partner:
- incoming jobs: sender's company shortname (= "%s")
- outgoing jobs or undefined job direction: recipient's company shortname (= "%r")

Since OS4X 3 Build 201508117 the following variables are available:

%a: ENGDAT Message Reference [UNH0062] (if available, otherwise empty)
%b: ENGDAT Document Number [MID1004] (if available, otherwise empty)

Since OS4X 3 Build 20160407 the following variables are available:

%y: recipient's username ("unknown" if empty)
%l: sender's username ("unknown" if empty)

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 12: / Line 12: @@
 == 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: Empfänger Standortname
+*%t: recipient location name
-*%u: Empfänger Abteilungsname
+*%u: recipient department name
-*%v: Empfänger Vorname
+*%v: recipient first name
-*%w: Empfänger Nachname
+*%w: recipient family name
-*%x: Empfänger Adresscode
+*%x: recipient address code
-*%g: Sender Standortname
+*%g: sender location name
-*%h: Sender Abteilungsname
+*%h: sender department 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:
+Since OS4X 3 Build 20140227 the following variable is available:
-*%e: Abhängig von der Auftrags-Richtung, ist diese Variable der Firmenkurzname des externen Kommunikationspartners:
+*%e: depending on the job direction, the company shortname of the external communication partner:
-**bei Eingangs-Aufträgen: Sender-Firmenkurzname (analog "<code>%s</code>")
+**incoming jobs: sender's company shortname (= "<code>%s</code>")
-**bei Ausgangs-Aufträgen (oder nicht definierbarer Auftrags-Richtung): Empfänger-Firmenkurzname(analog "<code>%r</code>")
+**outgoing jobs or undefined job direction: recipient's company shortname (= "<code>%r</code>")
-Seit OS4X 3 Build 20160407 sind folgende Variablen nutzbar:
+Since OS4X 3 Build 201508117 the following variables are available:
-*%a: ENGDAT Message Reference [UNH0062] (falls angegeben, ansonsten leer)
+*%a: ENGDAT Message Reference [UNH0062] (if available, otherwise empty)
-*%b: ENGDAT Document Number [MID1004] (falls angegeben, ansonsten leer)
+*%b: ENGDAT Document Number [MID1004] (if available, otherwise empty)
-*%y: Empfänger Benutzername ("unknown" falls leer)
-*%l: Sender Benutzername ("unknown" falls leer)
+Since OS4X 3 Build 20160407 the following variables are available:
+*%y: recipient's username ("unknown" if empty)
+*%l: sender's username ("unknown" if empty)
 == Beispiele ==