Difference between revisions of "OS4X plugin os4xplugin filecopy"

Latest revision as of 14:29, 30 November 2021

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)

Since OS4X 3 Build 20200323 the following variables are available:

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

Since OS4X 3 Build 20211130 the following variable is available:

%%: represents the character "%"

Examples

All examples rely on an outgoing job 76 from and to the company "c-works"

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

renders to:

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

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

renders to:

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

Return values

0: everything OK
1: Configfile (/etc/os4x.conf or value of environment variable "OS4X_CFGFILE", read in as file) cannot be found or database unavailable.
2: License error
3: XML parameter file cannot be parsed
4: Files cannot be copied

@@ Line 1: / Line 1: @@
-== Zweck ==
+[[Category:Plugins]]
+== 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.
+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
-== Beispiele ==
+Since OS4X 3 Build 20140227 the following variable is available:
-Alle Beispiele basieren auf einem OS4X-Sendeauftrag mit der Nummer 76 von und an Firma "c-works"
+*%e: depending on the job direction, the company shortname of the external communication partner:
+**incoming jobs: sender's company shortname (= "<code>%s</code>")
+**outgoing jobs or undefined job direction: recipient's company shortname (= "<code>%r</code>")
+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)
+Since OS4X 3 Build 20200323 the following variables are available:
+*%p: sender partner's event parameter
+*%P: recipient partner's event parameter
+*%Q: depending on the job direction, the event parameter of the external communication partner:
+**incoming jobs: sender's event parameter (= "<code>%p</code>")
+**outgoing jobs or undefined job direction: recipient's company shortname (= "<code>%P</code>")
+Since OS4X 3 Build 20211130 the following variable is available:
+*%%: represents the character "<code>%</code>"
+== Examples ==
+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
-----
-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 ==
-: alles OK
-: 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
-: Lizenzfehler
-: XML-Parameterfile kann nicht geparsed werden
-: Datei(en) konnten nicht kopiert werden
+== Return values ==
+*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.
+*2: License error
+*3: XML parameter file cannot be parsed
+*4: Files cannot be copied