OS4X Directory Scanner

(incomplete / come back later for a final version)

What is the OS4X Directory Scanner?

The goal of the directory scanner is to scan configured directories (without recursion) for new files (older than 60 seconds) and apply a matching pattern on them. If the pattern matches, the file will be moved to the configured outgoing directory and an executable will be started with parameters defined for this directory scanner entry, based on either fix values or dynamic ones.

The OS4X Directory Scanner is available since OS4X 3 in OS4X 3 Core.

Configuration of scanning tasks

Using the directory scanner needs some configuration via web interface and optionally in addition on the filesystem (if you really want to modify the behaviour more deeply).

Menu entry

The menu entry "Dir.scanner" in the administrative web interface exists if the binary

os4x_ds_dryrun

exists in the installation directory for binaries of OS4X.

Clicking on that links shows you the actually configured directory scanner entries, with an empty view in the default installation.

You can click on "New" or the empty paper icon to create a new entry. In order to edit an entry, click on the edit icon.

The following screenshot shows the edit page of an existing directory scanner entry:

Name

The name of the directory scanner entry can be a human-interpretable textual string which will only occur in the logs.

Directory

The directory on which the directory scanner works on. Remember that only that directory without subdirectories will be scanned. The configured outgoing directory cannot be configured since the files will be moved into that directory before executing the command for a found file.

Regular expression

The file name found in the configured directory must match this regular expression. Regular expressions are quite complex but very powerful. The name of the found file must result into a true value (which means that any output of the regular expression is valid but not the empty). The engine compiling these regular expression values is always PCRE, which implements Perl-style regular expressions, which are widely used across different systems.

If the regular expression is not correct, the directory scanner will identify this situation, add a log entry to the system log and disable this configured directory scanner configuration.

Configuration values types

A found file matching the configured regular expression leads to a number of paraeters which are then passed to the executable for later using them. There are two types of configuration values you can use for every single configuration parameter:

fix values

The easiest way to use a configuration value is to pre-set it with a fix value. This is mostly a good decision if i.e. the directory is partner-based and the configuration of the communication partner is fix (due to its nature of residence in that configured directory).

variable values

Another way to extract a configuration value is based on the found file. The found filename (without path) will be passed to the configured regular expression, where the first variable definition, which are normally enclosed by round brackets: '(' and ')'. Subsequent variable extractions will be ignored. If no variable value is extractable by the configured regular expression on the given file, an empty string is used as parameter value.

Configuration values

These fixed parameters are available which are then passed to the configured executable below:

Partner selection

This parameter defines normally a partner shortname. Used by the enqueueing script.

Virtual filename selection

Since the file has a separate name on the filesystem and during transport (and lateron at partner's receive side), you have to define a virtual filename.

Comment selection

This comment will be put into the comment field of the enqueued file when using the standard enqueueing process.

Originator SFID / Destination SFID

For a separate sender's and receiver's SFID extraction, this value defines with which SFID the file will be sent. Leave empty if you want to use the partner's default configuration.

Passive switch selection

If the found file should be enqueued passively, the value of this configuration parameter should be not-empty. (see "os4xeq", parameter "-P").

Logging

Logging will be done in general for the following items:

• a regular expression is not valid
• a directory is not accessable
• a file which should be moved by the directory scanner is not movable (which includes a inner-filesystem and outer-filesystem file movement)

In addition, logging is globally configurable for every found file and execution of the command via a configuration parameter ("Configuration" -> "Logging" -> "Enable directory scanner logging?"). If this configuration parameter is enabled, every single file which has been found by the directory scanner and which succeeds the configured regular expression will be logged, including the time and date, the script, all parameters, returncode of the script and the its output. Log vault functionality is given here, too.