Difference between revisions of "OS4X plugin os4xplugin filerename"

Revision as of 19:24, 28 April 2014

Purpose

Rename all files of an OS4X job according to a specific rule.

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
%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")

Examples

All examples are based on an OS4X send job with number 76, addressed to company "c-works":

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

will compute to:

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

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

will compute to:

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

A SWAN-like directory behaviour would be:

/opt/os4x/data/%Y/%m/%d/%j

which will compute to:

/opt/os4x/data/2008/03/18/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 renamed

@@ Line 22: / Line 22: @@
 *%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
+*%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>")
-Seit OS4X 3 sind folgende Variablen zusätzlich nutzbar:
+== Examples ==
-*%t: Empfänger Standortname
+All examples are based on an OS4X send job with number 76, addressed to company "c-works":
-*%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 ist folgende Variable nutzbar:
-*%e: Abhängig von der Auftrags-Richtung, ist diese Variable der Firmenkurzname des externen Kommunikationspartners:
-**bei Eingangs-Aufträgen: Sender-Firmenkurzname (analog "<code>%s</code>")
-**bei Ausgangs-Aufträgen (oder nicht definierbarer Auftrags-Richtung): Empfänger-Firmenkurzname(analog "<code>%r</code>")
-== 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:
+will compute to:
   /opt/os4x/tmp/c-works/os4x_job_76
 ----
   /opt/os4x/tmp/%D/%r/%j
-wird zu:
+will compute to:
   /opt/os4x/tmp/outgoing/c-works/76
 ----
-Ein SWAN-ähnliches Konstrukt wäre z.B.:
+A SWAN-like directory behaviour would be:
   /opt/os4x/data/%Y/%m/%d/%j
-welches aufgelöst wird zu:
+which will compute to:
   /opt/os4x/data/2008/03/18/76
-== Rückgabewerte ==
+== Return values ==
-: alles OK
+: everything 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
+: Configfile (/etc/os4x.conf or value of environment variable "<code>OS4X_CFGFILE</code>", read in as file) cannot be found or database unavailable.
-: Lizenzfehler
+: License error
-: XML-Parameterfile kann nicht geparsed werden
+: XML parameter file cannot be parsed
-: Datei(en) konnten nicht bewegt werden
+: Files cannot be renamed