OS4X plugin os4xplugin filemove

Puropose

Move 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 directory 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 20180129 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 20210615 the following variable is available:

• %A: job year (short, two digits)

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 moved