OS4X plugin os4xplugin filerename

From OS4X
Jump to navigation Jump to search


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


  • 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.).
  • Either source file or renamed target file must exist. If none of these exist, the plugin stops execution.


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.

Target name can contain an absolute path information or a file name only. The plugin will react on this situation dynamically:

  • absolute path information: the calculated target path will be created dynamically
  • file name only (without path information): the file will be renamed in the same path it resided before

If (the configurable) virtual filename renaming is active, the virtual filename will be changed to the basename value of the resulting file.

If (the configurable) absolute filename renaming is disabled, the file in the filesystem won't be changed. This influences the following attributes in the job descrpiption:

  • absolute filename
  • real filename (which is the basename of the absolute filename by default)

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")
  • %E: file extension (the text after the last dot, "."), i.e. "txt"
  • %G: file extension (the text after the last dot, ".", including the last dot "."), i.e. ".txt"
  • %f: filename (basename only, without path)
  • %F: filename without extension (basename only, without path)

Starting with OS4X release 2016-12-22, the following variable is also available:

  • %V: virtual filename

Starting with OS4X release 2021-06-15, the following variable is also available:

  • %A: job year (short, two digits)
  • %a: ENGDAT Message Reference [UNH0062] (if available, otherwise empty)

Since OS4X 3 Build 20211130 the following variable is available:

  • %%: represents the character "%"


incl. directories

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


will compute to:



will compute to:


A SWAN-like directory behaviour would be:


which will compute to:


only filename

The following configurations will rename the file in its current directory. The example is based on one job with filename "testfile.txt":


will compute to:



will compute to:



will compute to:


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