OS4X Core configuration
- 1 Accessing configuration
- 2 Configurable values
- 2.1 TCP/IP
- 2.2 SSL/TLS parameters
- 2.2.1 TLS server certificate file & TLS server certificate password
- 2.2.2 TLS client certificate file file & TLS client certificate password
- 2.2.3 root certificate file & root certificate path
- 2.2.4 Diffie-Hellman parameter files
- 2.2.5 TLS server: check client certificate validity
- 2.2.6 Ignore TLS CRL unavailability?
- 2.2.7 Archive CRLs?
- 2.2.8 Disable automatic CRL handling
- 2.2.9 Disable automatic reactivation of CRLs
- 2.2.10 Ignore CRL download errors of Mendelson
- 2.2.11 Check CRL URLs every x timeslices
- 2.2.12 Maximum age of CRLs
- 2.2.13 Entropy file for random data
- 2.2.14 TSL URL
- 2.2.15 Disable security warnings?
- 2.2.16 TLS ciphers?
- 2.2.17 Enable only PFS ciphers?
- 2.2.18 Allow insecure downgrade of TLS cipher?
- 2.2.19 Allow partial check of certificate chain?
- 2.3 Proxy
- 2.4 ISDN parameters
- 2.5 Odette parameters
- 2.6 Directories
- 2.6.1 data incoming directory
- 2.6.2 data outgoing directory
- 2.6.3 temporary directory
- 2.6.4 temporary directory (for software updates)
- 2.6.5 database backup directory
- 2.6.6 binary installation directory
- 2.6.7 script installation directory
- 2.6.8 absolute path to 'openssl'
- 2.6.9 absolute path to 'rrdtool'
- 2.6.10 RRDB data path
- 2.6.11 absolute path to RRDtool TTF file
- 2.6.12 SQL lost messages file
- 2.6.13 Append datestamp to SQL lost messages file?
- 2.6.14 MySQL dump tool
- 2.7 Events
- 2.7.1 event script usage
- 2.7.2 event script sleep time
- 2.7.3 start send script
- 2.7.4 end send script
- 2.7.5 xERP script
- 2.7.6 start receive script
- 2.7.7 end receive script
- 2.7.8 start session script
- 2.7.9 end session script
- 2.7.10 send queue entry blocked script
- 2.7.11 debug daemon log script
- 2.7.12 license script & trigger level
- 2.7.13 Enable automatic update mechanism & OS4X automatic software update event
- 2.7.14 OS4X automatic update post event
- 2.7.15 enqueue post-event
- 2.7.16 OS4X API proxy system log event script
- 2.7.17 Event failure event
- 2.7.18 System log event & only non-OK entries fire
- 2.7.19 Job abort event
- 2.7.20 Enable 3DEXPERIENCE integration
- 2.7.21 Event to be executed for sent non-Enterprise files
- 2.7.22 OS4X Enterprise user created event
- 2.8 Daemon parameters
- 2.8.1 run OS4X programs as user
- 2.8.2 run OS4X update program as user
- 2.8.3 time slice for send queue daemon
- 2.8.4 time slice for receive daemon
- 2.8.5 delete send queue entries
- 2.8.6 Cleanup of sent send queue entries
- 2.8.7 let all files of send queue be fetchable
- 2.8.8 overwrite existing incoming files
- 2.8.9 default maximum send tries for send queue daemon
- 2.8.10 additional sleeping time for send queue daemon & additional sleeping time factor for send queue daemon
- 2.8.11 progress bar refresh time
- 2.8.12 allow unsecure OFTP 2 authentification
- 2.8.13 delete temporary created files of OFTP 2 session
- 2.8.14 local character set
- 2.8.15 Unblock blocked send queue entries after successful connect?
- 2.8.16 Disable file restart functionality?
- 2.8.17 Disable automatic database cleanups / optimizations?
- 2.8.18 enable OFTP message checker
- 2.8.19 send queue entry status after abort
- 2.8.20 enable statistics & RRDtools refresh time
- 2.8.21 Append timestamp to received file
- 2.8.22 Append destination SFID to received file
- 2.8.23 Append PID of receive process to received file
- 2.8.24 OFTPv1: Don't wait for EERP message
- 2.8.25 Enable automatic update mechanism?
- 2.8.26 Send queue daemon partner organizing mechanism
- 2.8.27 Should OS4X send queue daemon unblock all blocked entries on startup?
- 2.8.28 Identify remote partner via incoming medium, too?
- 2.8.29 Don't send EERP messages immediately in OFTP 1.x sessions?
- 2.8.30 Receive all files if partner is authentificated?
- 2.8.31 Cleanup queues on daemon startup?
- 2.8.32 Should invalid restart positions deactivate restart of file?
- 2.8.33 Activate OFTP2 secure authentification directly after certificate delivery?
- 2.8.34 Enable per-partner virtual file naming recognition?
- 2.8.35 Fetch EERPs?
- 2.8.36 Fetch EERPs every x timeslice
- 2.8.37 Fetch EERPs for ISDN partners, too?
- 2.8.38 Don't deactivate dir.scanner entries on error?
- 2.8.39 Allow underscore character ("_") in virtual filenames?
- 2.8.40 Enable OFTP buffer compression?
- 2.9 OS4X Enterprise
- 2.9.1 OS4X Enterprise - Basic
- 18.104.22.168 is OS4X Enterprise installed?
- 22.214.171.124 default country
- 126.96.36.199 default receive plugin group
- 188.8.131.52 default send plugin group
- 184.108.40.206 enable multi-protocol support?
- 220.127.116.11 define own company
- 18.104.22.168 Default recipient for incoming jobs
- 22.214.171.124 Path for jobs of directory scanner
- 126.96.36.199 Enable auto-addresscode functionality
- 188.8.131.52 Enable addresscode uniqueness checks
- 184.108.40.206 Disable automatic addresscode conversion
- 220.127.116.11 Shall errornous sendings abort jobs
- 18.104.22.168 Absolute AJAX URL for job restore processes
- 22.214.171.124 Name of parameter for restore AJAX call
- 126.96.36.199 Event to be executed for sent non-Enterprise files
- 188.8.131.52 Name of JSONP callback parameter
- 2.9.2 OS4X Enterprise - Webaccess
- 184.108.40.206 Webaccess login logo URL
- 220.127.116.11 Webaccess logged in logo URL
- 18.104.22.168 Encrypt Webaccess session information
- 22.214.171.124 Compress Webaccess session information
- 126.96.36.199 Don't show receive queue view
- 188.8.131.52 Don't show send queue view
- 184.108.40.206 Show incoming jobs without recipient
- 220.127.116.11 Session timeout (min)
- 18.104.22.168 Highlight address code in ENGDAT filenames
- 22.214.171.124 Show all incoming jobs of department
- 126.96.36.199 Show all outgoing jobs of department
- 188.8.131.52 Include given name in search
- 184.108.40.206 Don't show popup when adding recipient
- 2.9.3 OS4X Enterprise - Plugins
- 2.9.1 OS4X Enterprise - Basic
- 2.10 OFTP2
- 2.10.1 delete temporary created files of OFTP 2 session
- 2.10.2 Enable offline handling of OFTP2 transfered files?
- 2.10.3 Activate OFTP2 secure authentification directly after certificate delivery?
- 2.10.4 Don't send EERP messages immediately in OFTP2 sessions?
- 2.10.5 Send EERP in synchronous session?
- 2.10.6 Maximum size of sync. EERP files (in kB)
- 2.10.7 Add log entry for synchronous EERP handling
- 2.10.8 Delete original OFTP2 handled files which have been enqueued by send queue daemon?
- 2.10.9 OFTP2 security policy
- 2.10.10 External IP address or hostname of this OFTP2 system
- 2.10.11 Activate auto-cleanup of old certificates?
- 2.10.12 Automatically enable disabled certificates?
- 2.11 Logging
- 2.11.1 use syslog
- 2.11.2 enable log vault
- 2.11.3 maximum age for fast logs
- 2.11.4 move send logs every x timeslices
- 2.11.5 move receive logs every x timeslices
- 2.11.6 archive received xERP messages & archive sent xERP messages
- 2.11.7 enable script logging
- 2.11.8 Enable directory scanner logging?
- 2.11.9 Enable continuous write of OS4X debug daemon output?
- 2.11.10 Absolute path to logfile of OS4X API
- 2.11.11 OS4X API loglevel
- 2.11.12 Suppress unsuccessful connect log entries?
- 2.12 GUI
- 2.12.1 Send signals to running processes
- 2.12.2 Disable PID check of daemons
- 2.12.3 Show partners with unknown medium
- 2.12.4 Enable simple configuration
- 2.12.5 Min. age for expiration warning of certificates
- 2.12.6 Theme for administrative GUI
- 2.12.7 Disable health check of database
- 2.12.8 Filtered filesystems from "Welcome" tab
- 2.12.9 User own defined URLs
- 2.12.10 Name of entry
- 2.12.11 Own defined URLs
- 2.13 AS2
- 2.13.1 TCP/IP port for HTTP communication listener
- 2.13.2 TCP/IP port for HTTPS communication listener
- 2.13.3 Use OFTP2 certificate for HTTPS?
- 2.13.4 HTTPS certificate
- 2.13.5 External URL
- 2.13.6 Overwrite existing incoming files
- 2.13.7 Append Unix timestamp (incl. microsends) to received file?
- 2.13.8 Ignore certificate purpose for signature checks?
- 2.13.9 Write temporary logs & Keep logs ... days
- 2.13.10 Relative filename for undefined receive files
- 2.14 Send queue displayed columns
- 2.15 other interesting configurable values
OS4X stores its core configuration in one simple database table. The configuration can therefor be changed in two ways:
- using the comfortable web interface
- using a database client program to change the values manually.
Because of the quite non-understandable names of the configuration values, all configuration value names are listed in each block of configuration for manual editing.
web interface method
The OS4X web interface includes an entry in the left menu for the core configuration. Its name is "
Configuration". The configuration web interface is segmentated into the following blocks:
- Partner table
Each block is accessible with a link in the head of the configuration panel.
The table "[tableprefix]
configuration" (default: "
os4x_configuration") contains two columns:
The column "
name" is the name of the configuration which is affected.
The column "
value" reflects the configuration value, limited to 255 characters.
All boolean values react that the a value of zero ("
0") if false and all other values are true.
OS4X is highly configurable. The following configuration parameters show the position in the web GUI, beginning in the top. Each configuration name as used in all binaries, web interface, scripts etc. are listed in each block and explained as needed.
This block contains all basic TCP/IP parameters, such as port numbers, timeout values etc.
TCP/IP port of OFTP server
|DB configuration name:||tcp_port|
This numeric value between 1 and 65535 describes the TCP/IP port the OFTP server is watching for incoming connections. The maximum of parallel incoming connections is limited by the operating system kernel and can be influenced by the kernel parameter "
TCP/IP port of OFTP server (TLS)
|DB configuration name:||tcp_port_tls|
This numeric value between 1 and 65535 describes the TCP/IP port the OFTP server is watching for incoming OFTP2 connections which are secured by TLS. The maximum of parallel incoming connections is limited by the operating system kernel and can be influenced by the kernel parameter "
SOMAXCONN". This port must not be the same as the OFTP server port from above.
TCP/IP port of OS4X debug daemon
|DB configuration name:||debugd_port|
This numeric value between 1 and 65535 describes the TCP/IP port the OFTP server is watching for debug output. Every OS4X program generates this output. The daemon collects this data and is able to dump this data in an encrypted file. This must not be the same as OFTP or OFTP 2 server ports.
|DB configuration name:||tcp_timeout|
This numeric value defines the maxmimum number of seconds between two TCP/IP packages to arrive. If this value is too low you might get network disconnects, setting this value very high means that a network disconnect will be discovered very late.
TCP/IP OFTP maximum buffersize
|DB configuration name:||oftp_default_buffersize_tcpip|
During the OFTP handshake, the maximum size of a data buffer will be commited. This value reflects the maximum size of such data buffers. The minimum value is 128, the maximum can be should not be over 65535 (because of TCP/IP packaging). The higher the value, the faster the data transfer rate will be (but it depends on the partner side). On unreliable connections, use the default value of 2048 bytes. For configurations with problemous partners like old Seeburger products, please use 800 bytes as buffersize.
TCP/IP OFTP maximum credit count
|DB configuration name:||oftp_default_creditcount_tcpip|
As the OFTP maximum buffersize, this value will be commited with the partner during a OFTP handshake. The number defines the amount of uncommited data buffers send to the receiver during file transfers. Increasing this value also increases the throughput. On unreliable connections you should use the default of 20. This is a different value than used for ISDN connections. For configurations with problemous partners like old Seeburger products, please use 20 as credit count.
For securing TLS sessions over TCP/IP networks (such as internet), you need to give some information about your local certificates. These information don't have to be the same as for file based security.
TLS server certificate file & TLS server certificate password
|DB configuration name:||tls_local_certificate & tls_server_cert_password|
Absolute path to the OFTP server certificate (in PEM format) for OFTP over TCP/IP (TLS secured). If the certificate is password-protected, you may enter it in the password field.
TLS client certificate file file & TLS client certificate password
|DB configuration name:||tls_default_client_certificate & tls_client_cert_password|
Absolute path to the OFTP server certificate (in PEM format) for OFTP over TCP/IP (TLS secured). If the certificate is password-protected, you may enter it in the password field.
root certificate file & root certificate path
|DB configuration name:||tls_root_certificate & tls_root_certpath|
The root certificates are used to authentificate partners which have certificates of unknown signers. At least one of these fields must be filled (even if the root certificate path doesn't contain any root certificates). The certificates must be in PEM format.
These variables are (if set) available to processes started by OS4X via the environment variables "
CA_FILE" and "
CA_PATH" (see also OS4X Core environment variables).
Diffie-Hellman parameter files
|DB configuration name:||dh1024_file & dh2048_file|
These files (1024bit and 2048bit) contain prime numbers, which are the basis for TLS encrypted connections. If the file is writable, or the file doesn't exist and the directory is writable, you can generate a new file from the web interface by using the link "Recalculate" or "Generate" in the web interface, which opens a new window which executes the command. Don't close this window until you can read the message "You can close this window now"!
TLS server: check client certificate validity
|DB configuration name:||tls_server_check_client_cert|
When this option is activated, all incoming TLS connections will be checked for a client certificate and a validity path for them. In case of self-signed certificates from the client, you have to add them manually (by requesting them from the partners) to your trusted certificate pool.
In case of client sessions, OS4X will override a wrong purpose of the server certificate (such as "SSL Client: no").
If you have this checkbox enabled (default):
- OS4X's TLS server asks the remote side, if not already presented, during TLS handshake for a client certificate.
- This TLS client certificate is checked against the list of trusted certificates in order to verify a valid certificate chain for the certificate.
- If the certificate chain is trusted, all chain elements are checked against the actually installed certificate revocation lists ("CRLs").
If you have this checkbox disabled (not the default, not recommended):
- None of the above checks is being executed.
- Every TLS client can connect to your server without any further client certificate check.
- Recommended only if:
- You have a firewall which applies partner defined rules, so you are sure who is connecting to your TLS server
- Have OFTP2 secure authentification enabled, in addition with the enabled "OFTP message checker" (in "Configuration" -> "Daemon") for protocol syntax validity verification (which lowers throughput and consumes higher server CPU).
|DB configuration name:||tls_ignore_crl_unavailable|
If the above option "check client certificate validity" is activated, it is possible to deactivate the check of an existance of a CRL for all CA certificates which OS4X doesn't have a CRL downloaded yet. This solves the problems with the following log entries the system log:
TLS error: no X509 certificate given in TLS handshake by remote partner
openSSL error: TLS network session failed, certificate problem: application verification failure
You must download a CRL for the CA of the certificate with the subject '...'
certificate verify error 3: unable to get certificate CRL: depth=0, subject: ...
|DB configuration name:||archive_crl|
When activated, all overwritten CRLs will be archived before every update. When deleting CRLs, they will be archived, too.
Disable automatic CRL handling
|DB configuration name:||disable_auto_crl|
Normally, the OS4X send queue daemon scans all partner certificates for a new CRL URL and add them to the CRL list when not included. By activating this checkbox, you can disable this default behaviour.
Disable automatic reactivation of CRLs
|DB configuration name:||crl_dont_automatic_reactivate|
If automatic CRL handling is not deactivated, OS4X will enable all found disabled CRL entries found in certificates. If you don't want this behaviour, you can disable the reactivation by enabling this configuration option.
Ignore CRL download errors of Mendelson
|DB configuration name:||crl_ignore_downloaderrors_mendelson|
Since the CRLs of Mendelson CA are unavailable many times, your system log will be spammed with error message about this situation. Enabling this flag will not post any error logs into OS4X's system log if the download of a Mendelson CA CRL fails.
Check CRL URLs every x timeslices
|DB configuration name:||autocrl_sendq_timeslices|
The send queue daemon can process every configured amount of timeslices (configured in the daemon section here) all trusted certificates and their CRL distribution points. If any is not included in the revocation list yet, it will be added and handled. Cofiguration values above 512 and below 1 will be resetted to 10.
Maximum age of CRLs
|DB configuration name:||maximum_crl_age|
CRLs carry a date within them which defined when they become invalid. OS4X takes care of such CRLs by downloading and updating the database values according to the new content. With this configuration parameter you make any CRL entry invalid (and therefore marked for automatic update) which has an older update date than these amount of days before. So, the locally downloaded version of the CRL becomes invalid and gets updated eventually even before the next CRL will be issued.
This feature is recommended by the OFTP2 working group.
Entropy file for random data
|DB configuration name:||tls_entropy_file|
In order to use TLS, you have to specify a random data source. This is a kernel based character file (like "
/dev/urandom" or "
/dev/random"). If your operating system doesn't support such a random file (like AIX 5.1), you can generate such a file on your own (i.e. with the tool "ssh-rand-helper" from any openSSL installation). At least 256 bytes of random data must exist in this file.
|DB configuration name:||TSL_URL|
This URL defines the position of a list administrated by Odette which contains a list of authorized certificate authorities. If the signed XML could be verified successfully, all contained certificate authorities are added automatically to OS4X.
The default value is:
Disable security warnings?
|DB configuration name:||configTlsDisableSecurityWarnings|
When enabled, OS4X will never complain about insecure TLS cipher usage in connection logs (despite OS4X SmartProxy logs, since the OS4X SmartProxy doesn't support this insecurity "feature").
|DB configuration name:||oftp2_tls_ciphers|
The list of supported TLS ciphers can be configured. See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html for more details.
Enable only PFS ciphers?
|DB configuration name:||configTlsEnablePfs|
When enabled, all incoming and outgoing TLS traffic will occure with a secure TLS cipher supporting a secure key exchange mechanism. A fallback to a less secure cipher is supported, but logged.
Allow insecure downgrade of TLS cipher?
|DB configuration name:||configTlsAlllowInsecure|
In TLS, the most secure sessions are being tried to be initiated. This is done by providing a list of supported ciphers from server to client and vica versa in a prioritized list. If the list leads to a cipher which uses Diffie-Hellman for secure key exchange during session handshake, the used Diffie-Hellman key must be at least 1024bit wide. If this minimum size is not supported by the remote party, the outgoing session will be retried without offering Diffie-Hellman ciphers. A warning will be locked.
Due to the Logjam attack in 2015, this behaviour is not recommeded and is strictly out of our support. Use this feature at your own risk!
Allow partial check of certificate chain?
|DB configuration name:||configTlsAllowPartialChain|
In case of ca CA certificate in the chain without the required flag "CA:true", OS4X by default closes the TLS session. When enabling this option, the "CA" flag is not required to be present for the end of the certificate chain.
OS4X offers for all HTTP and HTTPS transfer tasks proxy support. In order to use a defined proxy, several options are available. More details can be found here
Use HTTP proxy?
|DB configuration name:||proxy_enabled|
If you want to use a proxy, enable this checkbox. If the checkbox is disabled, all proxy relevant environment variables (see OS4X HTTP Proxy support) are cleared in all proxy using tools and binaries (and thus the forked processes by these binaries also don't have proxy environment variables defined).
Use user settings/environment variables?
|DB configuration name:||proxy_use_env|
If your used running OS4X already has environmental variables defined for proper proxy support, you should enable this checkbox. Otherwise (if disabled), you have to configure the proxy in the parameter fields below.
Proxy hostname or IP
|DB configuration name:||proxy_host|
The resolvable hostname or IP address of the proxy server.
Proxy port number
|DB configuration name:||proxy_port|
The port number the proxy server is listening on. Only numbers are allowed here, from range 1-65535. Any other values will lead to misfunctions. Often used values are "8080" or "3128".
|DB configuration name:||proxy_username|
If your proxy requires user authentification, enter a username here.
|DB configuration name:||proxy_password|
If your proxy requires user authentification, enter the valid password for the above defined user.
|DB configuration name:||proxy_type|
Different proxy types are supported, you should know which one fits your environment. Possible values are:
Use OS4X proxy?
|DB configuration name:||os4x_proxy_enabled|
Basic ISDN parameters for OFTP connections have to be defined here.
ISDN OFTP maximum buffersize
|DB configuration name:||oftp_default_buffersize_isdn|
As the TCP/IP maximum buffersize (as mentioned above), this numeric value reflects the maximum size of a OFTP data buffer. It may result to problems if this is set to values higher than your ISDN controllers can use for maximum transfer size, which is limited by CAPI2.0 to 4096 bytes. The minimum is 128 bytes. For configurations with problemous partners like old Seeburger products, please use 800 bytes as buffersize.
ISDN OFTP maximum credit count
|DB configuration name:||oftp_default_creditcount_isdn|
Same as the TCP/IP maximum credit count, this numeric value reflects the number of OFTP data exchange buffers before a little handshake will be done by the OFTP protocol. For configurations with problemous partners like old Seeburger products, please use 20 as credit count.
ISDN force confirmation of each DATA_B3 package
|DB configuration name:||isdn_force_confirm_each_data_b3|
In ISDN, all data is transfered in 128 byte blocks, so-called "DATA B3 packages". Each package has to be confirmed by the remote partner, so the ISDN subsystem can remove unneeded memory and do some cleanup. If the remote partner doesn't confirm all DATA B3 packages, you may force him do so by enabling this checkbox. The ISDN subsystem sets a special flag in the DATA B3 package so nearly every ISDN counter system should confirm the receipt of that package, even if it's not explicitely implemented.
maximum amount of unconfirmed CAPI DATA B3 packages
|DB configuration name:||max_capi_sliding_window_size|
Different ISDN systems support a different amount of unconfirmed DATA B3 packages (see above). The normal CAPI standard of seven (7) unconfirmed DATA packages should never be reached, so you should be one or two packages lower than that limit in order to achieve the maximum of transport speed. Special CAPI ISDN implementations support more that the standard of seven packages, i.e. Bintec Bricks (they support up to 15). It doesn't make any sense to use that amount of unconfirmed data buffers, it doesn't speed up the transfer any more. If you receive CAPI timeouts, you should lower this amount of packages.
Don't wait for DATA B3 confirmation packages
|DB configuration name:||isdn_dont_wait_for_data_b3_conf|
If your ISDN system supports an extreme data throughput and nearly unlimited amount of unconfirmed DATA B3 packages lying around, you may ignore and don't wait for DATA B3 confirmation packages by enabling this highly unsupported feature. If you encounter line disconnects, disable this feature!
Background: In "normal" ISDN wildlife, each DATA B3 indication package indicates that other DATA B3 confirmation packages (up to this point of protocol transfer time) have been received. TIf you transfer very little files, it may be annoying waiting for each single data confirm package, you could send the file "as is" and wait for the OFTP protocol confirmation instead of waiting for the ISDN subsystem to acknowledge each single small piece of data sent. In some cases it's helpful, in most it's not! Just keep the setting disabled as long as you know exactly what you are doing!
enable CAPI keep-alive monitor
|DB configuration name:||capi_check_alive_monitor|
In order to use a Brick R4x00 or above, you have to enable this feature. Also, if you don't want to watch for OS4X after a reboot of the Brick device, enable this feature. Activating this feature, OS4X checks every defined controller every 60 seconds for availability. If a controller is inaccessible, it tries the connectivity again after 60 seconds. ---
Default OFTP parameters for authentifications are configurable here. If no special columns are defined in the partner table below, these values will be used.
my default SSID, my default SFID, my default OFTP password, change every partner entry
|DB configuration name:||default_ssid, default_sfid & default_password|
These elements are only used for the web interface for creating new partners or for changing all partner values. If the checkbox is enabled, all partners in the partner table will get the new values for SSID, SFID and password on your side. If you don't configure columns in the partner table configuration below, these values are used for OFTP authentification.
In order to let OS4X know where to find directories and files, these values have to be defined.
data incoming directory
|DB configuration name:||incoming_directory|
After successful file transfers (receiving), this directory defines where the incoming files will be stored. This directory must be on the same filesystem as the temporary directory (see below), otherwise you will get an error message in syslog (if enabled) that moving incoming files cannot be done. The filesystem must be dimensioned big enough to store a file with at most the maximum transfer size. I.e., if you receive a file of 200MB, you will need to have 200MB free on this filesystem, otherwise an error message will be sent to the partner (that the local filesystem is not big enough) and an entry to the receive log will be added.
data outgoing directory
|DB configuration name:||outgoing_directory|
This directory will be used by OS4X Webaccess (which is part of OS4X Enterprise) for outgoing jobs when initiating a send job. The plugins os4xplugin_filemove and os4xplugin_filecopy can refer to this directory by a configuration value.
|DB configuration name:||tmp_directory|
During incoming file transfers, the file fragments will be stored in this directory. Keep in mind (as mentioned above) to set this directory to the same filesystem as the incoming directory. The filesystem must be dimensioned big enough to store a file with at most the maximum transfer size. I.e., if you receive a file of 200MB, you will need to have 200MB free on this filesystem, otherwise an error message will be sent to the partner (that the local filesystem is not big enough) and an entry to the receive log will be added.
temporary directory (for software updates)
|DB configuration name:||configDirTmpUpdates|
Since OS4X Release 2016-01-22, this optionally configurable directory defines where the software updater extracts its content to. This solves issues when writing temporary files during software update to a network attached share as configured in "temporary directory" above.
database backup directory
|DB configuration name:||backup_directory|
If you want to use the OS4X backup mechanism, you need to define a directory where the SQL dump files will be stored. This directory is needed for the scripts "os4xbackup" and "os4xrestore".
binary installation directory
|DB configuration name:||bin_directory|
This directory points to your binary installation of OS4X. It also contains the license key, so if you receive a license error, first check the existence of this directory and the file "license.key" in it. This entry is also used for the web interface to start the daemons.
script installation directory
|DB configuration name:||script_directory|
This directory points to your script installation of OS4X. It contains helpful scripts, such as database backup and restore scripts and maybe other useful tools. The OS4X web interface uses this definition.
absolute path to 'openssl'
|DB configuration name:||tcp_timeout|
DB configuration name: openssl_binary_path
OS4X uses openSSL as basis for all OFTP 2 file security functions. The configured binary must exist and be executable for the user running OS4X processes. The used openSSL binary must be of version 0.9.9dev, 1.0.0 or higher to fulfill the functionality for OFTP2.
absolute path to 'rrdtool'
|DB configuration name:||rrdtool_binary_path|
In order to use statistics, you have to define the path to „rrdtool“, the Round Robin database tool by Tobias Oetiker. The standard OS4X distribution contains a pre-compiled version which works within OS4X. If the file configured isn't executable, statistics are disabled. The program is used to create databases within OS4X binaries, push data in it and to display the results as graphical output in the web interface. The latest version of "rrdtool" can be found under http://oss.oetiker.ch/rrdtool/. On his website he has also Amazon wishlists, so if you want to support his great work, please donate some gifts.
RRDB data path
|DB configuration name:||rrdb_datapath|
In this path, OS4X creates, stores, modifies and searches the files for statistics. The directory must be writable by the user running OS4X. If the path isn't writable or doesn't exists, statistics are disabled. For each partner, a file is generated for incoming transfer and for outgoing. The total consumption on the filessystem is about 315kB per partner.
absolute path to RRDtool TTF file
|DB configuration name:||rrdtool_font_path|
The statistical overview needs a font file (as Truetype font). Without this font file, you won't get any textual information in the statistic graphs.
SQL lost messages file
|DB configuration name:||sql_lost_messages_file|
If the configured MySQL server isn't reachable at any time, the SQL statements which are being sent to the MySQL server are logged into this file. If the file doesn't exists it will be created, so the directory must be writable for the user running OS4X. The file itself (if it exists) must also be writable by the user running OS4X.
Append datestamp to SQL lost messages file?
|DB configuration name:||sql_lost_messages_file_append_timestamp|
If enabled, in case of database inaccessibility, all SQL statements which could not be executed will be logged in the above configured "SQL lost message file", which gets a datestamp appendix to the filename. This datestamp consists of the following:
- a single dot ("
- year with 4 digits (like "
- month with 2 digits (like "
- day with 2 digits (like "
Example with a lost message fole configured to "
MySQL dump tool
|DB configuration name:||mysqldump|
As a useful tool from each MySQL distribution, the tool "
mysqldump" is used in the OS4X backup script for doing its job.
First some words about the global behaviour of scripts:
event script usage
Every time the configuration of OS4X is checked by a binary (which is at start time or when processing the signal 1 - SIGHUP), the event script configuration is checked. If a script is non-existant and/or the execute permissions don't allow the execution of a configured script, it won't get executed. No warning will be printed out or logged somewhere.
Presets exist (which are dynamically calculated with the last saved values for the scripts and binary directory configured here). These presets could be used for easy resetting the script configuration to either OS4X Enterprise (Lite) and/or OS4X 2 Core.
event script sleep time
Sometimes it is very handy if the event scripts are started with a little lag. This can be especially interesting if the „end receive“ or „end send“ scripts are called very fast because of small transfer files (i.e. ENGDAT abstract file). If you experience problems with your EDI system (i.e. it doesn't catch all files), try to increase the appropriate value. Keep in mind that the OFTP session waits that time you configured the sleep time. Setting the values very high increases the risk of a disconnect if the remote site has very little timeouts configured! More than 5 seconds should not be normal!
start send script
|DB configuration name:||start_send_script & sleep_start_send_script|
If a file is getting sent, this script or program will be started with the documented parameters.
end send script
|DB configuration name:||end_send_script & sleep_end_send_script|
If a file has finished (successfully or not) sending, this script or program will be started with the documented parameters.
|DB configuration name:||xerp_script & sleep_xerp_script|
If an EERP or NERP (OFTP 2 only) message is received, this script will be started. OS4X tries to find a send queue entry which conforms to the given parameters in order to set the values for comment, absolute path etc. If no send queue entry can be found that matches the given parameters in the EERP or NERP message, the script won't be executed. This script receives the same parameters as the end send script script.
start receive script
|DB configuration name:||start_receive_script & sleep_start_receive_script|
If a file is getting received, this script or program will be started with the documented parameters.
end receive script
|DB configuration name:||end_receive_script & sleep_end_receive_script|
If a file has finished (successfully or not) receiving, this script or program will be started with the documented parameters.
start session script
|DB configuration name:||start_session_script & sleep_start_session_script|
After a positive OFTP handshake, this script or program will be started with the documented parameters.
end session script
|DB configuration name:||end_session_script & sleep_end_session_script|
After a positive OFTP session, this script or program will be started with the documented parameters.
send queue entry blocked script
|DB configuration name:||blocked_script & sleep_blocked_script|
If a send queue entry gets blocked (i.e. wrong authentification, unsupported virtual filename at the remote site, connection problems), this scripts will be started. If more than one entry for a partner gets blocked, each send queue entry will start its own blocked script.
debug daemon log script
|DB configuration name:||os4xdebugd_log_script|
After a debug log has been written, this script will be started. This can be the case when asking for a debug log interactively (or with starting the appropriate program manually) or, if configured, when automatically created debug logs are written.
license script & trigger level
|DB configuration name:||license_script & license_script_hwm|
This script will be started after a configurable trigger level (in percent) is exceeded. Its main porpuse is to inform a responsible person that a new license should be obtained or other actions should be taken.
Enable automatic update mechanism & OS4X automatic software update event
|DB configuration name:||run_updates_automatically & os4xupdate_script|
If the value of run_updates_automatically is non-zero (if the checkbox is enabled), the automatic update script is started with the received file with the reserved virtual filename "
OS4X_UPDATE". This is normally a program of the OS4X distribution in order to update the installation via signed files. This program changes its user context to the configured user (see: run OS4X update program as user).
OS4X automatic update post event
|DB configuration name:||configEventUpdatePost|
After a software update has been executed via the program "os4xupdate", the configurable post event can be started, i.e. for cleanup reasons or informing system management hierachies.
|DB configuration name:||enqueue_post_script|
This script which will be executed after a successful enqueueing process.
OS4X API proxy system log event script
|DB configuration name:||os4xapi_proxy_systemlog_script|
This script which will be executed after a critical situation of the OS4X Proxy will be logged in the OS4X system log.
Event failure event
|DB configuration name:||event_failure_script|
In case of an error during event execution, this event can be executed.
System log event & only non-OK entries fire
|DB configuration name:||configEventSystemLogEvent|
|DB configuration name:||configEventSystemLogEventOnlyNonOk|
When an entry to the system log is added, this event can be executed (selective for only non-OK entries).
Job abort event
|DB configuration name:||enterprise_job_abort_script|
If an OS4X Enterprise job aborts, this event will be executed.
Enable 3DEXPERIENCE integration
|DB configuration name:||enable3Dexperience|
Requirement: OS4X Enterprise. If this option is enabled, sent files via 3DEXPERIENCE will be handled natively by the 3DEXPERIENCE integration. If enabled, this option disables the next configurable event "Event to be executed for sent non-Enterprise files".
Event to be executed for sent non-Enterprise files
|DB configuration name:||non_enterprise_send_event|
For all files which are sent via non-OS4X Enterprise mechanisms, this event will execute a special end-send event handler.
OS4X Enterprise user created event
|DB configuration name:||enterprise_user_created_event|
When an OS4X Enterprise user is created this event can handle its parameters.
The behaviour of all binaries and OS4X programs can be influenced here.
run OS4X programs as user
|DB configuration name:||running_as_user|
When starting as user "
root", all OS4X binaries will try to switch to this configured user, if available on the running system. Subsequent calls of scripts and other programs are also done in the context of this user. This is extremely useful for runlevel scripts.
Double-check that this user exists in the system running OS4X, that is has a home directory which is accessible and writable and that this user has a shell configured which is runnable!
run OS4X update program as user
|DB configuration name:||running_update_as_user|
If enabled below, automatic software update are being run using this specific username. If changing to the context of this given user fails, the whole update procedure fails. If no username is configured, superuser "
root" is used.
time slice for send queue daemon
|DB configuration name:||os4xsqd_sleep_time|
The send queue daemon „os4xsqd“ waits this amount of seconds before looking at the send queue table and react as needed (send one more entry, wait more time etc.).
time slice for receive daemon
|DB configuration name:||os4xrd_sleep_time|
The receiving daemon „os4xrd2“ waits this amount of seconds before looking at the configuration table and react as needed (wait more time or stop itself).
delete send queue entries
|DB configuration name:||delete_after_transfer|
This checkbox defines if the send queue table entries should be deleted (not the files itself, only the entry!) after a successful send. (If you need to delete the file itself, you should use the end send script, which gets the absolute filename as a parameter).
If this option is enabled, it automatically disabled the following option "Cleanup of sent send queue entries".
Cleanup of sent send queue entries
|DB configuration name:||configSendqueueCleanup|
If enabled, the send queue daemon cleans up the send queue for all entries with a given age automatically (based on the timestamp of "last change"). Optionally, an event "Send queue cleanup event" will be executed.
Age of send queue entries for cleanup (days)
|DB configuration name:||configSendqueueCleanupDays|
Send queue entries in status "successfully sent" with the last change date older than this amount of days will be taken into account for automatic cleanup.
Delete file, if available
|DB configuration name:||configSendqueueCleanupDeleteFile|
If this option is enabled, the automatic cleanup mechanism will delete the referenced file on the filesystem. If file deletion will take place, a log message will look like:
Deleted send queue entry '<virt. filename>' and file '<abs. filename>'
If this option is disabled or the referenced file doesn't exist, the log message says:
Deleted send queue entry '<virt. filename>'
let all files of send queue be fetchable
|DB configuration name:||fetch_all_from_remote|
Since polling is supported from remote systems, you can define files to be pollable. If you enable this checkbox, all files in your send queue which are in state of "new in queue" and "ready for remote fetch" will be sent in an OFTP session to the partner (otherwise, only entries "ready for remote fetch" are fetchable).
overwrite existing incoming files
|DB configuration name:||os4xrd_overwrite|
If the incoming file exists in the "incoming directory", you can define to overwrite it. Otherwise, the partner will receive an error message saying that the local file already exists. (this might be useful for partners who don't like to reiceive an EEPR [end-to-end- response] message right after a successful filetransfer).
default maximum send tries for send queue daemon
|DB configuration name:||os4xsqd_max_tries|
The send queue daemon "os4xsqd2" will try to send one or all entries this amount of times. After this amount of unsuccessful tries, one or all send queue entries for that partner will be blocked (which will also get logged into the send log). All entries for a partner get blocked, if a connection problem occurs (i.e. invalid SSID/SFID or password, no physical connection to partner, wrong ISDN number or TCP/IP address etc.). One entry will be blocked if the partner doesn't accept this file. The other files are not affected by that error (i.e. wrong virtual filename, wrong alternative SFID of originator or destination).
additional sleeping time for send queue daemon & additional sleeping time factor for send queue daemon
|DB configuration name:||os4xsqd_add_time & os4xsqd_add_time_factor|
You can influence the time the send queue daemon „os4xsqd2“ will sleep before it tries to send an send queue entry. The formula for calculating the additional sleep is as follows:
(add. waiting time) = (connect try)*(add. sleeping time)*(add. sleeping time factor)
progress bar refresh time
|DB configuration name:||progressbar_refresh|
OS4X will update all file transfer progress information after this value (in seconds). Because it is database driven, some MySQL server will crash if you have too many connects to a database in a very short time (which could occur if you transfer very little files with a combination of a small exchange buffer size). If you experience problems with your database server, try increasing this value.
allow unsecure OFTP 2 authentification
|DB configuration name:||oftpv2_allow_unsecure_auth|
If an OFTP 2 partner is requested to use OFTP 2 authentification but he doesn't support this feature, you may allow to authentificate this partner with the OFTP 1 methods by enabling this checkbox. If you insist to use OFTP 2 authentification, disable the checkbox, so the partner will receive an error message that OFTP 2 secure authentification is needed.
delete temporary created files of OFTP 2 session
|DB configuration name:||oftpv2_delete_temp_created_files|
OS4X creates temporary files by enqueueing files to the send queue or by directly sending a file to an OFTP 2 partner (if the partner is configured to use signing, compression and/or encryption). These temporary files can be deleted by OS4X automatically, but you may also want to keep them for later archiving.
local character set
|DB configuration name:||oftpv2_original_charset|
OFTP 2 supports UTF-8 formatted information and error messages within the protocol and also extended virtual filenames (up to 999 bytes of UTF-8 formatted text). To translate the UTF-8 text into your local character set and to translate command line interaction from your local character set to UTF-8, you have to define your local character set here. If your local character set isn't listed here, you can define it in the database (table: "os4x_configuration") manually by entering the character set descriptor in the line where „name“ is "oftpv2_original_charset". All character sets which are supported by "iconv" are supported by OS4X. You get a list of supported character sets on the command line with the program:
Unblock blocked send queue entries after successful connect?
|DB configuration name:||unblock_blocked_sendqueue_entries_after_poll|
If enabled, this options lets the OS4X poll binary and receive daemon unblock blocked send queue entries after a incoming or outgoing connection to this partner has been successfully established.
Disable file restart functionality?
|DB configuration name:||configDaemonDisableFilerestart|
If enabled, OS4X doesn't offer file restart functionality (which is offered by default if the communication partner supports it). In this case, the partner is told not to support file resuming, so aborted file transfers will restart in future sessions from the beginning of the file.
Disable automatic database cleanups / optimizations?
|DB configuration name:||configDaemonDisableMysqlOptimizeTables|
OS4X cleans up database tables after a successful delete operation (in MySQL via "
OPTIMIZE TABLE", in SQLite via "
VACUUM" command). Enabling this configuration option disables the automatic cleanup of tables. Warning: could make your database grow in size if you don't clean up on your own!
enable OFTP message checker
|DB configuration name:||oftp_message_checker|
To secure your server, an OFTP message checker examines each transfered package for validity. This suppresses protocol attacks from remote and helps to avoid NULL pointer exceptions and other well-known attacks.
send queue entry status after abort
|DB configuration name:||sendq_entry_status_after_abort|
You can define the status of a send queue entry after manual abort here. It may be useful to avoid a race between an administrator and the send queue daemon if he aborts the file transfer but the send queue daemon grabs it afterwards because the time slice has taken account. Valid options are "new in queue", "successfully sent", "blocked" and "ready for remote fetch".
enable statistics & RRDtools refresh time
|DB configuration name:||enable_statistics & rrd_refresh|
As configured above with the RRDtool paths and directories, you have the possibility to activate or deactivate the scripting functionality here. The statistics contain the average transfer speed of a partner (incoming and outgoing as separate databases). If any of the above configured RRDtool path or binary is unavailable, scripting is disabled, even if you enable it here. The refresh time is the time is seconds when statistical data is transfered into the Round Robin database. This time period depends also on the database configuration of the RRDB and is closely dependant from the creation process which is intergrated into OS4X (if an RRDB file doesn't exist). The default of 10 seconds should not be changed!
NEW: If statistics are enabled, a seperate logging table will be filled with information how many files have been transfered (in the ways "sent" and "received" with or without success. This amount of transfered filed is being displayed in the partner list and the partner "edit" details.
Append timestamp to received file
|DB configuration name:||rec_append_timestamp_to_filename|
Some partners may send you files with the same virtual filename, but different timestamps. In order to receive these files properly, an appendix is added to the filename containing the announced timestamp of the file. This also helps to receive the same file from different partners at the same time. Beware: the timestamp syntax has changed from OFTP 1 to OFTP 2!
The appendix of the filename is as follows:
- OFTP 1.0 - OFTP 1.3: "
<datestamp><timestamp>0000", i.e. "
- OFTP 1.4 and OFTP2: "
<datestamp><timestamp><counter>", i.e. "
The main difference between both names is that the "counter" field in older OFTP sessions will be emulated via "
Append destination SFID to received file
|DB configuration name:||configDaemonAppendSFIDRec|
If enabled, the received file will contain the destination SFID attached with a dot ("
.") in front of the SFID to the filename. This influences both the temporary and absolute filename after transfer.
Append PID of receive process to received file
|DB configuration name:||configDaemonAppendPIDRec|
If enabled, the received file will contain the process ID (so-called "PID") attached with a dot ("
.") in front of the PID to the filename. This influences both the temporary and absolute filename after transfer.
OFTPv1: Don't wait for EERP message
|DB configuration name:||oftpv1_dont_wait_for_eerp|
The normal behaviour of a send queue item is as follows:
- new in queue: waiting for transfer
- taken by send queue: session active, waiting for transfer
- send in progress: active transfer
- waiting for remote acknowledge: waiting for EERP or NERP from partner
- successfully sent: partner acknowleged file (entry may be deleted if configured)
If an partner doesn't send an EERP message, the send queue entry will exist forever. In order to avoid this, the send queue entry may get the status „successfully sent“ after successful send by enabling this checkbox (and may be deleted if the above checkbox „delete send queue entries“ is enabled). Beware: the xERP scripts won't be executed any more because no send queue entry will be found matching the parameters given in any EERP or NERP message. This feature just affects OFTP v1 partners, not OFTP 2!
Enable automatic update mechanism?
|DB configuration name:||run_updates_automatically|
Activating this feature enables the usage of automatic software and lowers the administrative tasks to keep the software up-to-date.
Send queue daemon partner organizing mechanism
|DB configuration name:||sqd_partner_organizing|
If you want to configure a massive parallel installation to be handled by the send queue daemon without shared memory segments for information handling which partner has how many lines online, you may want to switch this configuration value to "database values". The default of "shared memory segments" works perfectly for single instances of OS4X and should be set only this way. CAVEAT: when using database values only for parallel channel information on send queue partners, there exists a timeframe when the information is invalid (this is when the send queue daemon forks a new process up to the database update command execution). During this little amount of time, more parallel processes may exist than configured for this partner.
take ALL server IDs into account
|DB configuration name:||sqd_db_partner_organizing_all|
If the above configuration of "Send queue daemon partner organizing mechanism" is set to "database values", then only this server ID could be inspected or ALL used servers can be inspected for parallel channels. Enabling this checkbox is the recommended value for this configuration!
also take receive queue into account
|DB configuration name:||sqd_partner_organizing_use_recq|
If the above configuration of "Send queue daemon partner organizing mechanism" is set to "database values", it's possible to active the check of the send queue for active partner connections. This amount of active connections will be added to the calculation of active connections for opening new connections during send queue daemon handling.
Should OS4X send queue daemon unblock all blocked entries on startup?
|DB configuration name:||os4xsqd_unblock_on_start|
The default behaviour of OS4X send queue daemon on startup: if enabled, the daemon unblocks all blocked send queue entry for the configured server ID. The behaviour up to 2007-11-24 was like enabling this feature.
Identify remote partner via incoming medium, too?
|DB configuration name:||partner_search_medium|
When enabled, the OS4X receive daemon checks for the given medium the partner connects to the server and identifies the partner with this information in addition to the given SSID and password. This feature is very handy when several partner entries with the same SSID and password exist for different reasons.
Don't send EERP messages immediately in OFTP 1.x sessions?
|DB configuration name:||no_instant_eerp|
When enabled, OS4X doesn't send instantly EERP (end-to-end-response) messages to the remote partner containing the default parameters. If enabled, you have to create the EERP message manually (or programatically) in order to be sent correctly to the partner.
Receive all files if partner is authentificated?
|DB configuration name:||receive_catch_all|
In order to receive ALL files of a authenticated partner (via SSID and password), without any check of locally defined originator and/or destination SFID, please active this checkbox. All files are being received without any error, even if no partner has been configured for this configuration of SFIDs. You should design your post-processing of the received file via the "end receive script" on your own.
Cleanup queues on daemon startup?
|DB configuration name:||cleanup_queues|
If enabled, a successful start of a send or receive queue daemons cleans up the respective queue with the following rules:
- server ID matches the started daemon
- send queue daemon "
os4xsqd": Reset all files in status "taken by send queue" and "send in progress" to "new in queue"
- receive queue daemon "
os4xrd": Remove all files with the same server ID
Because it's a quite destructive option, the default is off.
Should invalid restart positions deactivate restart of file?
|DB configuration name:||dont_restart_invalid_offset|
If enabled, all files given with a restart position bigger than proposed file size won't restart file transfer and begin at the start of the file (i.e. if file size is 44123kB, but restart position is available at 49876kB, because the physical file is 51832kB big; received file size is bigger that the proposed 44123kB because the file is bigger).
Note: Volvo needs this flag to be turned on in special conditions.
Activate OFTP2 secure authentification directly after certificate delivery?
|DB configuration name:||activate_ssidauth_after_delivery|
If enabled, the partner switch "use OFTP2 secure authentification" will be enabled right after an automatic import of a certificate delivery. Please note that this may influence the behaviour of new connections: they may be aborted if the configuration flag allow unsecure OFTP 2 authentification is disabled and this partner wants to connect the next time and doesn't have the same settings activated.
Enable per-partner virtual file naming recognition?
|DB configuration name:||per_partner_sfiddsn|
If enabled, an incoming file will be checked against a list of configured partner entries with the configured SFID (originator and destination) and in addition to this normal behaviour, against a list of configured virtual filenames (so-called "DSN", "Virtual File Dataset Name" or "SFIDDSN"). These allowed virtual filenames are configurable at a per-partner basis, so they are an additional switch which partner entry is handling this special filename.
If multiple partner entries match, first one will be used.
|DB configuration name:||configDaemonFetchEerp|
If enabled, OS4X's send queue daemon will contact the remote partner for every file which is in the send queue status "waiting for remote acknowledge". In the newly created session, the partner has the chance to send the EERP or NERP message for any file. The maximum amount of configured sessions for a partner is being used (if available and configured properly in the "partner table" configuration). No more than the maximum of this amount of sessions will be opened, summarized for poll queue, send queue files and EERP fetching entries.
Fetch EERPs every x timeslice
|DB configuration name:||configDaemonFetchEerpTimeslice|
If EERP fetching is enabled, this factor is being used to increase the time between two connect tries of the OS4X send queue daemon when trying to fetch one or more EERP messages of a partner.
Fetch EERPs for ISDN partners, too?
|DB configuration name:||configDaemonFetchEerpIsdnToo|
Since 2016-11-28, by default OS4X only fetches EERPs for TCP/IP and TLS partners (before this release, also ISDN partners are being contacted for missing EERPs). If you activate this checkbox, also ISDN partners are being contacted for missing EERPs (files in the send queue with status "waiting for remote acknowledge). Be aware that in combination with the send queue daemon time slice parameter and the EERP timeslice factor, the send queue daemons initiates outgoing sessions which can generate connection costs!
Don't deactivate dir.scanner entries on error?
|DB configuration name:||configDaemonDirscannerDontDeactivate|
If enabled, the send queue daemon will not deactivate diresctory scanner entries if an error occurs with the according enttry (i.e directory not available, permission errors etc.). By default, this configuration option is disabled and the daemon will deactivate such entries, logging this in the system logs.
Allow underscore character ("
_") in virtual filenames?
|DB configuration name:||configDaemonAllowUnderscoresInVirtFilenames|
Some OFTP and OFTP2 systems out in the wild support the underscore character in virtual filenames, which is unsupported by the RFC. In order to support this common mistake of standard interpretation, OS4X supports this non-standard character in addition to the well-defined characters, which are:
The numerals: 0 to 9 The upper case letters: A to Z The following special set: / - . & ( ) space
Enable OFTP buffer compression?
|DB configuration name:||oftp_compression_cap|
In OFTP, file transmissions are divided in small buffers. These buffers may be compressed. Other than the OFTP2 compression, this compression mechanism is not that much optimized in its input data. In order to propagate the functionality in session initialization phase, enable this feature. If the remote party doesn't support this feature, it will be dynamically turned off within the OFTP handshake process.
The behaviour of OS4X Enterprise can be influenced in the following three topics:
OS4X Enterprise - Basic
is OS4X Enterprise installed?
|DB configuration name:||os4x_enterprise|
If you enable this checkbox, the web interface expands its funtionality needed to administrate OS4X Enterprise, an enhanced version of OS4X. Disabling this checkbox turns OS4X into its default configuration of OS4X Core. If you are interested in features of OS4X Enterprise, contact your software dealer or write an email to firstname.lastname@example.org .
|DB configuration name:||default_country_idx|
When creating a new location entry in the OS4X partner database and using OS4X Enterprise, a country has to be selected for this location. For easy administration, a default country is configurable with with configuration. This configuration is only visible if OS4X Enterprise is installed (and the above checkbox is enabled).
default receive plugin group
|DB configuration name:||default_rec_plugin_pkg|
This pulldownmenu contains all defined plugin packages. You should select a plugin package which will be run after a job is completely received (i.e. after the receive file sorter has collected all needed files). This configuration is only visible if OS4X Enterprise is installed (and the above checkbox is enabled).
default send plugin group
|DB configuration name:||default_send_plugin_pkg|
The configured default send plugin group is used to pre-configure a plugin group which is used for newly added partners. This plugin group will be configured at company level (the highest hierarchy level) for the new partner.
enable multi-protocol support?
|DB configuration name:||os4x_enterprise_other_protocols|
In order to enable other protocols in addition to OFTP and OFTP2 (which is handled via the OS4X send queue for outgoing files), you may define and use other protocols for data transfer to partners. Enable this checkbox to get more options on then. See OS4X Enterprise - other protocols for more details about administration.
define own company
|DB configuration name:||os4x_enterprise_own_company|
For a finer grained target address code search, you can define your own company here. If "no selection - enable multi-client-support" is selected, all address codes of all companies will be used for recipient search.
Default recipient for incoming jobs
|DB configuration name:||enterprise_default_rec|
By default, no recipient is configured for inomcings jobs in initial state. By defining a default recipient here, this person will be defined as the initial recipient, leading to an execution of the configured plugin group of this recipient if no other plugin changes this recipient successfully.
Path for jobs of directory scanner
|DB configuration name:||enterprise_dirscanner_jobdir|
This name defines the path (relative to the outgoing directory) wherein the directory scanner will create jobs. The job number will be appended to this given directory name. Relative path information can be used, too (using "../" definitions).
Examples (with a default outgoing directory path of "
- resulting path (for job 123):
Enable auto-addresscode functionality
|DB configuration name:||enterprise_auto_adrcode|
When enabled, editing a recipient adds the ability to create a new unique address code, based on values of other persons in that company. The algorithm tries to identify a numeric element of the existing address code and increments it until an unused value is available. This functionality may fail for address codes without a numeric element.
Enable addresscode uniqueness checks
|DB configuration name:||enterprise_unique_adrcode|
When enabled, the administrative web interface warns an administrator if the configured address code is used by another person in the same company. This is done by marking the input field as invalid, adding a hover mask for a textual information that this address code is used already.
Disable automatic addresscode conversion
|DB configuration name:||configGuiAddresscodeDontConvert|
When enabled, the administrative web interface doesn't convert the addresscode into upper case, so it's usable for other purposes than ENGDAT routing.
Shall errornous sendings abort jobs
|DB configuration name:||configEnterpriseAbortJobRejectedFiles|
When enabled, the "end send" event of OS4X Core will abort jobs if sending is errornous.
Absolute AJAX URL for job restore processes
|DB configuration name:||enterprise_archive_restore_url|
For archived jobs, this URL will be called via JSONP in order to restore the job.
Name of parameter for restore AJAX call
|DB configuration name:||enterprise_archive_restore_parametername|
When restoring OS4X Enterprise jobs via the above configured URL, this is the name of the parameter containing the archive ID.
Event to be executed for sent non-Enterprise files
|DB configuration name:||non_enterprise_send_event|
If you use OS4X Core and OS4X Enterprise events in parallel, this event will be fired if a "end_send" will be executed for non-Enterprise enqueued files.
Name of JSONP callback parameter
|DB configuration name:||enterprise_archive_restore_callbackname|
Due to JSONP, this is the name of the required callback function parameter. The default value (if empty) is "
OS4X Enterprise - Webaccess
Webaccess login logo URL
|DB configuration name:||webaccess_login_logo|
An alternative logo URL (absolute or relative is supported) for displaying in the login prompt of OS4X Webaccess.
Webaccess logged in logo URL
|DB configuration name:||webaccess_loggedin_logo|
When defined, a customized logo can be added to the logged-in view of OS4X Webaccess in the top right corner. Absolute or relative URLs are supported.
Encrypt Webaccess session information
|DB configuration name:||webaccess_session_encrypt|
If required, OS4X Webaccess can encrypt the session information in the database via AES256 algorithm and hashed via SHA1 hashing algorithm.
Compress Webaccess session information
|DB configuration name:||webaccess_session_compress|
If required, OS4X Webaccess can compress the session information in the database via bzip2 algorithm.
Don't show receive queue view
|DB configuration name:||webaccess_disable_recq|
If you don't want the receive queue to be displayed to end-users in OS4X Webaccess, enable this checkbox. The receive queue view doesn't contain any administrative operations.
Don't show send queue view
|DB configuration name:||webaccess_disable_sendq|
If you don't want the send queue to be displayed to end-users in OS4X Webaccess, enable this checkbox. The send queue view doesn't contain any administrative operations.
Show incoming jobs without recipient
|DB configuration name:||webaccess_show_invalid_rec_jobs|
When enabled, this feature adds jobs without a valid recipient to the list of incoming jobs for all users.
Session timeout (min)
|DB configuration name:||webaccess_session_timeout|
You can set a session for timeout for OS4X Webaccess sessions here. Without any interaction, an old session expires automatically after that amount of minutes.
Highlight address code in ENGDAT filenames
|DB configuration name:||webaccess_highlight_addresscode|
If ENGDAT filenames are not interpreted into real filenames (as given i.e. in ENGDAT abstract files, these files are quite technical to read. In order to highlight the address code contained in the filename, enabling this configuration options offers to highlight this address code with the following methods:
- bold (configuration variable "
- underlined (configuration variable "
- italic (configuration variable "
Show all incoming jobs of department
|DB configuration name:||webaccess_show_dep_jobs_incoming|
OS4X Webaccess normally shows only jobs of the corresponding user who is logged in. In order to show all incoming jobs of the department the user is contained, enable this checkbox.
Show all outgoing jobs of department
|DB configuration name:||webaccess_show_dep_jobs_outgoing|
OS4X Webaccess normally shows only jobs of the corresponding user who is logged in. In order to show all outgoing jobs of the department the user is contained, enable this checkbox.
Include given name in search
|DB configuration name:||webaccess_search_given_name|
When searching for persons in OS4X Webaccess (in any situation), the given name (aka. the "first name") is not searched for by default. By enabling this configuration option, searching for the given name is being activated, too.
Don't show popup when adding recipient
|DB configuration name:||webaccess_ignore_recipient_add|
When adding a new recipient to a send job, a popup occurs when not enabled. If enabled, no popup will occur.
OS4X Enterprise - Plugins
The default behaviour of all plugins can be changed here. The behaviour can be overridden by a configured, set up at each level of partner hierarchy.
OFTP2 relevant options are configurable here:
delete temporary created files of OFTP 2 session
|DB configuration name:||oftpv2_delete_temp_created_files|
If enabled (all other values than zero, '
0') all files created for temporary usage in OFTP2 sessions and session preparations will not be deleted. This is useful for debugging the created files and meta-information.
Enable offline handling of OFTP2 transfered files?
THIS FEATURE HAS BEEN REMOVED 2018-08-30!
|DB configuration name:||offline_oftp2_filehandling|
If enabled (all other values than zero, '
0') incoming OFTP2 files (which need to be handled by any security mechanism, such as signature checking, decompression and/or decryption, will be held in an offline queue, which will then be evaluated by the OS4X offline daemon.
pre-script for offline tool
THIS FEATURE HAS BEEN REMOVED 2018-08-30!
|DB configuration name:||offline_oftp2_pre_script|
If OFTP2 offline handling is enabled, you may enter here the absolute path to an executable which will be executed by the OS4X offline handler before the offline handler processes the file. This is normally a transferer script.
post-script for offline tool
THIS FEATURE HAS BEEN REMOVED 2018-08-30!
|DB configuration name:||offline_oftp2_post_script|
If OFTP2 offline handling is enabled, you may enter here the absolute path to an executable which will be executed by the OS4X offline handler after the offline handler has processed a file. This is normally a cleanup script.
remove successfully handled offline OFTP2 file entries
THIS FEATURE HAS BEEN REMOVED 2018-08-30!
|DB configuration name:||oftp2_offlinefile_remove_entries|
If OFTP2 offline handling is enabled, successfully processed files will be removed from the offline queue (the database table only, not from the filesystem!) if this feature is activated.
Activate OFTP2 secure authentification directly after certificate delivery?
|DB configuration name:||activate_ssidauth_after_delivery|
If enabled, OS4X activates secure authentification method for the given partner right after an automatic certificate exchange.
Don't send EERP messages immediately in OFTP2 sessions?
|DB configuration name:||no_instant_oftp2_eerp|
After successful receipt of an OFTP2 file, you may suppress the automatic sending of an EERP by activating this feature. You should ensure to send an EERP via "os4xeq" with all parameters given in the "end receive script".
Send EERP in synchronous session?
|DB configuration name:||configOftp2SyncEerp|
In OFTP2, file handling (like decompression, signature verification and decryption) is being processed in an asynchronous, forked process (because this handling can take a very long time in terms of network connections; many minutes are not uncommon). If you have to deal with synchronous data transfers where an EERP MUST be transfered in the same OFTP2 session, you can enable this option. Beware of the (default: 1MB) size limit of received files for enabling this feature.
Maximum size of sync. EERP files (in kB)
|DB configuration name:||configOftp2SyncEerpMaxsize|
If the above mentioned synchronous EERP handling for OFTP2 is enabled, you have to define a filesize limit of the transfered file. Files bigger that this limit are not handled by the synchronous EERP process.
Add log entry for synchronous EERP handling
|DB configuration name:||configOftp2SyncEerpLog|
If synchronous file handling takes place, an optional log entry can be places in the receive log every time this process is activated. Warning: may increase your receive log massively!
Delete original OFTP2 handled files which have been enqueued by send queue daemon?
|DB configuration name:||deleteToBeEnqueuedTouchedFiles|
If a file, which has been in status 10 ("to be enqueued for OFTP2"), may result in a temporary OFTP2 file if one of the options for OFTP2 file handling is enabled (compression, signing or encryption). If this is the case, the original file would stay in it's original state. When enabling this feature, OS4X deletes this original file for security reasons from the filesystem. WARNING: no undo or recovery is available!
OFTP2 security policy
Starting with OS4X release 2016-08-16, you can define which security settings match your internal company security policy with easy-to-answer configurations. The following parameters help to configure these values in an easy way. These settings are only relevant for the reception of files, sending files with another settings is possible nevertheless with potentionally different partner settings.
The following configuration options can be defined to a behaviour explained below:
- File encryption (dabase configuration name: "
- File compression (dabase configuration name: "
- File signature (dabase configuration name: "
The configuration options explained:
- unconfigured: All files are accepted
- Allow: All files are accepted, both with activated and deactivated security option.
- Require: The security option MUST be activated for incoming files, otherwise the file will be rejected with an appropriate error message.
- Reject: The security option MUST NOT be activated for incoming files, otherwise the file will be rejected with an appropriate error message.
- Require partner value: Require partner value: The file must be sent by the remote party according to the settings which are activated or deactivated in your partner configuration. If the security option is not fulfilled, the file will be rejected with an appropriate error message.
If a security policy is not fulfilled, an offered file will be rejected. A log entry in the receive log will occur per file. The partner is given the information not to retry this sending process again.
Allow fallback to unsecure OFTP 2 authentification
|DB configuration name:||oftpv2_allow_unsecure_auth|
If enabled (all other values than zero, '
0') it is possible to connect to OS4X with a disabled secure authentification mechanism, even if the identified partner (via SSID and password) has a secure authentification method activated. If this configuration is disabled (which is the default), OFTP2 sessions are directly closed with a secure session error message.
Preferred cipher suite
|DB configuration name:||oftp2_policy_preferred_cs|
This configured cipher suite will be the preferred one for incoming files. With the option below, files using another cipher suite can be rejected. The list of cipher suites is dynamically obtained from the OFTP2 system. If the configuration value is "Use partner configured value", incoming files shall (or must, depending on the option below) be using the cipher suite which is defined at partner level.
Deny other cipher suites than the preferred
|DB configuration name:||oftp2_policy_deny_unpreferred_cs|
If a ciphersuite is configured in "Preferred cipher suite" and incoming files use another cipher suite, this option will reject the incoming file with an appropriate error message.
External IP address or hostname of this OFTP2 system
|DB configuration name:||oftp2_external_hostname|
This configuration option is used in new certificate signing requests as the common name ("CN") of this OFTP2 system.
Activate auto-cleanup of old certificates?
|DB configuration name:||configOftp2AutoCleanup|
Since certificates will expire, OS4X will warn you about this fact. If you want OS4X to clean up expired certificates automatically (so you don't have to do this manually), you can enable this checkbox.
Automatically enable disabled certificates?
|DB configuration name:||configOftp2AutoEnableInactiveCert|
If an old certificate has been archived by the mechanism above, disabled (say: not yet enabled) certificates can be enabled dynamically. This is also a mechanism for automatic handling during certificate renewal.
Logging enables OS4X to insert human readable messages into log tables. You may turn some features on or off to suite your needs.
|DB configuration name:||use_syslog|
If you turn on this checkbox, major errors will be logged to the server's syslog facility with the severity LOG_ERR. Major errors are table misconfigurations or process dependant messages (fork failures, memory allocation problems etc.).
enable log vault
|DB configuration name:||enable_log_vault|
Enabling this feature activates code to move log entries from the direct access log tables to slower log vault tables, where all messages (older than a configurable amount of days) are kept. This enhances the access to the online logs.
maximum age for fast logs
|DB configuration name:||logvault_days|
After this amount of days, log entries will be moved from one log to the vault.
move send logs every x timeslices
|DB configuration name:||logvault_sendq_timeslices|
The entries older than the above configured value ('maximum age') of the send log will be moved to the slower vault every this amount of time slices of the send queue daemon. This configuration value cooperates with the configuration value 'time slice for send queue daemon'. Only logs belonging to that server ID will be moved to the vault!
move receive logs every x timeslices
|DB configuration name:||logvault_recq_timeslices|
The entries older than the above configured value ('maximum age') of the receive log will be moved to the slower vault every this amount of time slices of the receive queue daemon. This configuration value cooperates with the configuration value 'time slice for receive daemon'. Only logs belonging to that server ID will be moved to the vault!
archive received xERP messages & archive sent xERP messages
|DB configuration name:||oftpv2_archive_received_xerp & oftpv2_archive_sent_xerp|
It may be useful archive positive and/or negative end-to-end responses. These xERP messages can be seen as acknowledgements from the partner (received xERP) or from yourself (sent xERP). The web interface contains a archive viewer on the left hand: "xERP log". This feature may be needed in some countries for legal issues.
enable script logging
|DB configuration name:||enable_script_logging|
Enabling this feature logs all script calls, parameters, returncodes and output to the script logs. In the web interface, you can take a look at the script logs with the link „Script log“. In this interface, you can also restart event scripts (even if they have changed in the configuration: you can then execute the original or the new one, depending on executability of the script file).
Enable directory scanner logging?
|DB configuration name:||enable_dirscanner_logging|
If enabled, the directory scanner logs every single execution script based on the found file.
Enable continuous write of OS4X debug daemon output?
|DB configuration name:||os4xdebugd_continuous_write|
When enabling this feature, the OS4X debug daemon creates a debug log file (and starts the configured event script if existant) after the ring buffer is full. In this case, no message is lost.
If this feature is enabled, starting with OS4X release 2015-08-25 a button with the label "Collect today's logs" is available which lets you send all collected debug daemon dump files of this day and enqueue it to a specific partner for debugging. Requirements for this feature are:
- OS4X debug daemon is running
- The temporary directory is accessible and writable by the OS4X debug daemon
- The event "debug daemon log event" does not change the filename prefix "os4x-logfile-<YYYYmmdd>" (where "YYYY" is the current year with four digits, "mm" is the actual month starting at "01" with two digits and "dd" is the actual day, starting with "01" and two digits).
The partner to which the files are being enqueued is possible to be searched. By default, the partner "OS4X-Update" is searched. If the partner is not found, no partner search is pre-set and the whole partner list is being presented. If exactly this pre-set partner "OS4X-Update" is found, it it selected automatically, so you don't have to click on it to activate the selection. Only if a single partner is selected in the partner search list, the files are being enqueued to this partner after submission (either via "Save" button or via double click).
The virtual filenames of the logfiles is "OS4X-LOGFILE-<counter>" where "<counter" is an incremented number, starting with 1 (one). The comment of the automatically enqueued files is "
OS4X logs - automatically enqueued via administrative web interface".
Absolute path to logfile of OS4X API
|DB configuration name:||os4xapi_logfile|
The OS4X API, which is the background service for OS4X Webaccess and OS4X Proxy, logs into this file.
OS4X API loglevel
|DB configuration name:||os4xapi_loglevel|
The above configured file will be written in the configured log level.
Suppress unsuccessful connect log entries?
|DB configuration name:||suppress_unsuccessful_connect_logs|
If an incoming connection fails before OFTP handshake could be initiated, a logging entry is normally made in the style of:
unsuccessful connect try from IP 'aaa.bbb.ccc.ddd'
If you want to ignore these messages (i.e. when using a system monitoring which just watches if the TCP/IP port is open), enable this feature.
The GUI offers some parameters which influence the default behaviour.
Send signals to running processes
|DB configuration name:||webgui_kill_processes|
The PHP backend can send running processes a signal, i.e. for reloading their configuration (when clicking "Save") or cancelling transfer processes. If the webserver is not running on the same machine as the OS4X daemons do, or if the webserver user is not privileged to send signals to running OS4X processes (i.e. they are running in another user context), you should disable this checkbox, otherwise (which is the default) keep it activated for a seamless integration of GUI and backend.
Disable PID check of daemons
|DB configuration name:||disable_PID_checks|
The OS4Xapi can check if daemons which should run with a given process ID really exist. If they don't exist, the OS4Xapi will cleanup running information (= their PIDs) in the database. This feature is available in Linux and MacOS, partially in AIX. If you get unwanted results, disable this feature.
Show partners with unknown medium
|DB configuration name:||display_partners_with_unknown_medium|
Since the configurable partner database schema is highly configurable, many partner entries may have an unknown transmission medium configured (valid values are configurable for ISDN, unencrypted TCP/IP and encrypted TCP/IP aka. TLS). If this configuration option is enabled, all partners (even with unknown medium values) are displayed in the partner list.
Enable simple configuration
|DB configuration name:||simple_config_gui|
In many installations, most complex situation are not needed for this installation. As a minimizer for unneeded configuration options, most uncommon configuration options are not visible when enabling this configuration option. Elements which are hidden when this config option is activated are:
- Partner table
- Partner import
- Cipher suites
Partner management for OFTP2 is also more easy, so a more or less incomplex system will be shown in order to allow non-common users to administrate the system well.
Min. age for expiration warning of certificates
|DB configuration name:||gui_cert_warning_days|
The administrative web interface can show expiring certificate warnings and expired certificate errors in the tab "Welcome", section "Possible configuration problems". The configured amount of days are used for calculation which certificates to display.
Theme for administrative GUI
|DB configuration name:||gui_theme|
The admin web interface supports the switch of the used theme for displaying information. You can switch the theme without saving dynamically. When saving this config, all subsequent calls to the web interface will switch to the configured theme.
Disable health check of database
|DB configuration name:||gui_disable_db_healthcheck|
Disabling the database health check will not include database table checks in the section "Possible configuration option" in the "Welcome" tab of the administrative web interface. By disabling these checks, you can lower your database overhead massively.
Filtered filesystems from "Welcome" tab
The administrative web interface shows the filling state of all mounted filesystems, except the filesystems contained in the list of excluded filesystems. A filesystem can be exluded from the displayed list by clicking on the entry bar on the "Welcome" page, then answering "Yes" to the delete question. The deleted file system(s) are listed here in a grid, where they can be removed so the removed entry will be displayed again on the welcome page.
User own defined URLs
|DB configuration name:||use_own_defined_urls|
If enabled, the menu on the left side in the administrative web interface will add an entry with a configured name (see below).
Name of entry
|DB configuration name:||own_defined_urls_menuentry_name|
The name of the menu entry which contains user-defined URLs is changeable.
Own defined URLs
The AS2 functionality is configurable per-partner and globally. The global parameters are configurable here.
TCP/IP port for HTTP communication listener
|DB configuration name:||configAs2HttpPort|
This is the numeric port of the plain TCP/IP listener for incoming HTTP sessions.
TCP/IP port for HTTPS communication listener
|DB configuration name:||configAs2HttpsPort|
This is the numeric port of the encrypted TLS listener for incoming HTTPS sessions.
Use OFTP2 certificate for HTTPS?
|DB configuration name:||configAs2UseOftp2Cert|
When enabling this checkbox, the OS4X OFTP2 certificate is being used as HTTPS TLS certificate (the most easy way to support HTTPS).
|DB configuration name:||configAs2HttpsServerCert|
If the OFTP2 certificate is not used for HTTPS, a separate HTTPS certificate file can be configured for encrypted HTTPS connections. The file must contain the public certificate (optionally included chain) and RSA/DSA unprotected private key.
|DB configuration name:||configAs2ExternalUrl|
The external URL is contained in outgoing messages, defining where to post the corresponding asynchronous MDN to.
Overwrite existing incoming files
|DB configuration name:||configAs2Overwrite|
If any incoming file has the same name on the filesystem, this option enables OS4X AS2 to overwrite this file.
Append Unix timestamp (incl. microsends) to received file?
|DB configuration name:||configAs2AppendTimestamp|
If a new file is received, the current timestamp incl. microseconds of the running operating system will be appended to the filename in order to make it unique.
Ignore certificate purpose for signature checks?
|DB configuration name:||configAs2IgnoreCertPurpose|
If enabled, the purpose of the used certificate for a specific functionality is not checked and used anyway (even if the certificate usage forbids this).
Write temporary logs & Keep logs ... days
|DB configuration name:||configAs2Debug|
|DB configuration name:||configAs2KeepDays|
If enabled, all incoming messages will be saved for a configurable time period into the database for later analysis. You can download a dump of that data via the button "Download logs".
Relative filename for undefined receive files
|DB configuration name:||configAs2EmptyRecFilename|
If (against the RFC) no filename is specified by the sender, OS4X AS2 can use this filename as a default value. Inform your opponent sending party to correctly define a transmission filename if this happens regularly.
Send queue displayed columns
The list of columns configure the default state of the columns when opening the send queue overview. The columns can be re-activated afterwards via the column header management.
other interesting configurable values
Some values are not configurable via web interface, but also have a useful meaning when running OS4X. These configuration value names are:
os4xclientd_port: TCP/IP port of the program OS4X client daemon
webinterface_path: Absolute path of the web interface on the webserver. This is useful for upgrading processes in order to update the path correctly.