Difference between revisions of "OS4X plugin os4xplugin engdatv2 decode"
| Line 27: | Line 27: | ||
*if "automatic sender learning" is activated, a list of companies is configurable for which the confirmation of newly added entries will be done without confirmation by an administrator. | *if "automatic sender learning" is activated, a list of companies is configurable for which the confirmation of newly added entries will be done without confirmation by an administrator. | ||
*automatic decompression of files can be activated. | *automatic decompression of files can be activated. | ||
| + | |||
| + | === Automatic sender learning === | ||
| + | When a sender is found in the ENGDAT abstract file, it will be searched in the job sender's company. If it does not exist within this company, it can be created automatically (via "automatic sender learning" mechanism). If this is the case, the whole hierarchy of the sender person (including location, department and person) will be created. If one of the hierarchy level already exists, it will not created again, the existing entry will be re-used. | ||
| + | |||
| + | |||
| + | |||
== Return values == | == Return values == | ||
| Line 32: | Line 38: | ||
*1: wrong arguments or configuration file not readable | *1: wrong arguments or configuration file not readable | ||
*2: database connection error | *2: database connection error | ||
| − | |||
| − | |||
Revision as of 10:17, 30 October 2014
Purpose
Recognize the ENGDAT abstract file in a job and analyze its content. The ENGDAT abstract file is separated into different segments, the following are taken into account:
- UNB: Address code of recipient and sender
- MID: Output of the document ID
- EFC:
- Filename
- File sequence number
- Compression
- Format (Plaintext & ODDC77 encoding)
- FTX (free text, comment; both for job and single files supported)
The plugin marks the found ENGDAT abstract file with the XML attribute "type=ENGDAT" in order to let it be deleted by the remove ENGDAT plugin.
If a file is marked with the compression type "gzip" in the field EFC4891, the following checks will be executed:
- Is the file really a GZIP compressed file?
- If yes: is the suffix of the file "
.gz"? If not, the suffix will be appended to the filename as long as no other file with the same name exists. - Decompression of the file.
- The name of the file in the ENGDAT abstract file (without the suffix "
.gz") will be modified, so the original filename is available.
Requirements
- OS4X configuration file
/etc/os4x.confexists or the file pointed to via the environment variable$OS4X_CFGFILEexists. The referenced configuration file defines the used database, from which the temporary directory and license information will be extracted.
Configuration
- "automatic sender learning" can be disabled.
- if "automatic sender learning" is activated, newly added entries can be configured to be confirmed by an administrator.
- if "automatic sender learning" is activated, a list of companies is configurable for which the confirmation of newly added entries will be done without confirmation by an administrator.
- automatic decompression of files can be activated.
Automatic sender learning
When a sender is found in the ENGDAT abstract file, it will be searched in the job sender's company. If it does not exist within this company, it can be created automatically (via "automatic sender learning" mechanism). If this is the case, the whole hierarchy of the sender person (including location, department and person) will be created. If one of the hierarchy level already exists, it will not created again, the existing entry will be re-used.
Return values
- 0: everything OK
- 1: wrong arguments or configuration file not readable
- 2: database connection error