OS4X plugin os4xplugin filecopy - Revision history

Admin: /* Configuration */

2021-11-30T14:29:49Z

Configuration

Admin: /* Configuration */

2020-03-23T07:54:20Z

Configuration

Admin: /* Rückgabewerte */

2017-11-03T07:40:24Z

Rückgabewerte

Admin: /* Beispiele */

2017-11-03T07:39:51Z

Beispiele

Admin: /* Configuration */

2017-11-03T07:39:16Z

Configuration

Admin at 07:36, 3 November 2017

2017-11-03T07:36:58Z

Admin: /* Konfiguration */

2016-04-07T12:26:41Z

Konfiguration

Admin: /* Konfiguration */

2016-04-07T12:23:45Z

Konfiguration

Admin: /* Konfiguration */

2016-04-07T09:44:09Z

Konfiguration

Admin: /* Konfiguration */

2016-04-07T09:30:50Z

Konfiguration

@@ Line 55: / Line 55: @@
 **incoming jobs: sender's event parameter (= "<code>%p</code>")
 **outgoing jobs or undefined job direction: recipient's company shortname (= "<code>%P</code>")
 == Examples ==

@@ Line 48: / Line 48: @@
 *%y: recipient's username ("unknown" if empty)
 *%l: sender's username ("unknown" if empty)
 == Examples ==

@@ Line 60: / Line 60: @@
   /opt/os4x/tmp/outgoing/c-works/76
-== Rückgabewerte ==
+== Return values ==
-: alles OK
+*0: everything OK
+*1: Configfile (/etc/os4x.conf or value of environment variable "<code>OS4X_CFGFILE</code>", read in as file) cannot be found or database unavailable.
-: Configfile (/etc/os4x.conf bzw. Inhalt der Variable "<code>OS4X_CFGFILE</code>") kann nicht gelesen werden oder die hier konfigurierte Datenbank kann nicht verbunden werden
+*2: License error
+*3: XML parameter file cannot be parsed
-: Lizenzfehler
+*4: Files cannot be copied

@@ Line 49: / Line 49: @@
 *%l: sender's username ("unknown" if empty)
-== Beispiele ==
+== Examples ==
-Alle Beispiele basieren auf einem OS4X-Sendeauftrag mit der Nummer 76 von und an Firma "c-works"
+All examples rely on an outgoing job 76 from and to the company "c-works"
   /opt/os4x/tmp/%r/os4x_job_%j/
-wird zu:
+renders to:
   /opt/os4x/tmp/c-works/os4x_job_76
 ----
   /opt/os4x/tmp/%D/%r/%j
-wird zu:
+renders to:
   /opt/os4x/tmp/outgoing/c-works/76
 == Rückgabewerte ==

@@ 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:
 == Beispiele ==

@@ 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.