OS4X plugin os4xplugin filerename

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

Seit OS4X 3 sind folgende Variablen zusätzlich nutzbar:

• %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 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 "%s")
  • bei Ausgangs-Aufträgen (oder nicht definierbarer Auftrags-Richtung): Empfänger-Firmenkurzname(analog "%r")

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 bewegt werden