ONYX - 9.0 - Usage
General configuration settings (mapping.conf)
Sommaire
- 1 ONYX SERVER
- 2 WEB CONFIG
- 3 SPOOLER CONFIG
- 4 MAP_SCANFOLDER CONFIG
- 5 MAP_RAWD CONFIG
- 6 MAP_STATD CONFIG
- 7 MAP_SCHEDULER CONFIG
- 8 MAPREPORT CONFIG
- 9 USERS ACCESS
- 10 LOGS
- 11 MAPCPYSPLF
- 12 DEFAULT SPOOL FILES VALUES
- 13 MAPREPORT EXPERT
- 14 EXPERT PATH
- 15 EXPERT OPTIONS
- 16 OTHER
- 17 MAIL ALERT
- 18 LDAP
- 19 WORKFLOW
ONYX SERVER
ONYX Basic Configuration
- SYSTEM : Operating system.
- VERSION : OS version.
- ARCHIVE_RELEASE : Archival version.
- COMPANY_NAME : Company name.
- LANGUAGE : GUI language (English or French).
- DATE_FORMAT : Date format (DD/MM/YYYY).
- TIME_FORMAT : Time format (12 or 24).
- PATH_BASE_MAPPING : Default path (e.g. C:\Mapping\M-Processing_Server).
- PATH_BIN : Binaries path (e.g. C:\Mapping\M-Processing_Server\Applications).
- CONFIG : Configuration file (e.g. C:\Mapping\M-Processing_Server\Settings\mapping.conf).
- GROUP_ADMIN : Administrator group (e.g. mapadmin (default)).
- USER_ADMIN : Administrator username (e.g. mapadmin (default)).
- EDITOR : Text Editor path. Linux only (e.g. vi (default)).
- MAPPING_VERSION : ONYX version installed (e.g. autogenbuild_v9.0.0b.37402).
WEB CONFIG
Web server settings
- CGI_BIN : Path to Web server executables.
- MAPWEB_CMDIN : History of commands executed.
- MAPWEB_LOGIN : History of visited pages (mouse clicks on icons and buttons).
- MY_SERVER : Folder where the files used by the Web server are stored. DO NOT CHANGE!
- PATH_MENU : Folder where menu files are stored. DO NOT CHANGE!
- ROOT_MENU : Root folder where the folder structure begins.
- MAPPING_TRANSLATE : Path to translation files.
- PATH_VIEW_SETTINGS : Path to configuration file used to configure the display mode of the different types of spool files in the spooler.
- PCL_SPOOLS_VIEW : Default preview mode of PCL spool files: TEXT or PDF. If set to TEXT, the files are displayed in the preferred text editor (text / plain). If set to PDF, the files are opened in the specified PDF application. See the content of ViewSettings.conf for commands.
- NB_LINE_IN_VIEW : Maximum number of lines displayed the spooler, 1000 being the recommended value.
- CONTEXT_MENU : Enables ("on") or disables ("off") the drop-down menu in the top-left corner. If set to "off", the menu is hidden. Values not case-sensitive.
- TOOLSBAR_MENU : Enables ("on") or disables ("off") the 4 icons in the bottom-left corner (Back, Refresh, Main menu and Log out) and menu images.
- VIEW_SECURITY_LEVEL : Manages the access permissions to the different objects of user or group accounts.
- SPOOL_SECURITY : Manages the access permissions to the different files of user or group accounts.
- XPSVIEWER :
- SPOOL_TITLE_WIDTH : Changes the size of the "Jobs/Printers" menu.
- GUI_DISPLAY_ENVIRONMENT_LABEL : Text displayed on the environment banner.
- GUI_DISPLAY_ENVIRONMENT_COLOR : Colour code of the environment banner.
SPOOLER CONFIG
ONYX Spooler configuration settings.
- PATH_SPOOLER : Path to spooler configuration files (e.g. ...\Spooler).
- DAEMON_ID : Spooler daemon (e.g. map_daemon.ID).
- PORT_SOCKET_DAEMON : Daemon port (e.g. 2000).
- IP_SERVER_DAEMON : Daemon IP address (e.g. 127.0.0.1).
- NB_SOCKET_DAEMON : Number of sockets for the daemon (e.g. 100).
- LISTEN_PORT : Daemon listen port (e.g. 515).
- MAP_SERVER_MAIL : Mail server IP address (e.g. 127.0.0.1).
- MAP_DOMAIN_MAIL : Mail server domain (e.g. domain.local).
- TIMEOUT_TO_WAIT_SEC : Connection timeout of daemon client applications (e.g. 60).
- NB_MAX_PRINTER_EXECUTION :
- LOAD_SPOOLS_ON_VIEW :
MAP_SCANFOLDER CONFIG
SCANFOLDER (hot folder entry point) configuration settings
- SCANFOLDER_ID : Identifier (e.g. map_scanfolder.ID).
- MAP_SCANFOLDER_TIMER : Time elapsed between SCANFOLDER– in seconds (e.g. 6).
- CONFIG_PATH_ROBOT : Path to robot configuration file (e.g. ...\Settings\robot.conf).
- CHECK_FTP_FILE_ACCESS : Enables timeout when a file is FTPed, for a full file (Windows only)
- FTP_TIMEOUT_SEC : If the files are FTPed, max file access waiting time – in seconds (e.g. 10).
- SCANFOLDER_PATH_DUP_FILES : Folder where files processed by the rules engine will be moved.
- SCANFOLDER_FILTER : Default filter for files that should not be processed (e.g. *.tmp).
- SCANFOLDER_ACCEPT : Default filter for files that should be processed (e.g. *.xml, to process .xml files only).
MAP_RAWD CONFIG
Configuration settings for the RAW protocol daemon.
- MAPRAWD_ID : Listen server id.
- MAPRAWD_CONFIGFILE : Path to listen server's configuration file (e.g. ...\Settings\maprawd.conf).
- MAPRAWD_SERVERSTDIN : Path to listen server's input file.
- MAPRAWD_SERVERSTDOUT : Path to listen server's output file.
- MAPRAWD_SERVERSTDERR : Path to listen server's error file.
MAP_STATD CONFIG
- MAPSTATD_ID : Stats server's ID file.
- MAPSTATD_SERVER_IP : Stats server's IP address.
- MAPSTATD_PORT : Stats server's port.
- MAPSTATD_SERVERSTDIN : Stats server's input file.
- MAPSTATD_SERVERSTDOUT : Stats server's output file.
- MAPSTATD_SERVERSTDERR : Stats server's error file.
- MAPSTATD_CONFIGFILE : Stats server's configuration file.
MAP_SCHEDULER CONFIG
Configuration settings of server's scheduled tasks.
- SCHEDULER_ID : Server id.
- SCHEDULER_TEMPO :
- SCHEDULER_SERVERSTDIN : Path to input file.
- SCHEDULER_SERVERSTDOUT : Path to output file.
- SCHEDULER_SERVERSTDERR : Path to error file.
MAPREPORT CONFIG
Connect server configuration settings
- PATH_MAPREPORT : Path to Connect import files (e.g. ...\Import\mapreport).
- MAPREPORT_ID : Program id (e.g. map_report.ID).
- MAPREPORT_PORT :Listen port for Preview (e.g. 6789).
- MAPREPORT_SERVERSTDIN : Path to input file (e.g. ...\Temp\mapreport.stdin.txt).
- MAPREPORT_SERVERSTDOUT : Path to output file (e.g. ...\Temp\mapreport.stdout.txt).
- MAPREPORT_SERVERSTDERR :Path to error file (e.g. ...\Temp\mapreport.stderr.txt).
- MAPREPORT_SERVERTYPE : Database type (e.g. MySQL).
- MAPREPORT_SERVERADDRESS : Database server's IP address.
- MAPREPORT_SERVERPORT : Database server port (e.g. 3306).
- MAPREPORT_SERVERUSER : Database user (e.g. root).
- MAPREPORT_SERVERPASSWORD : Database password.
- MAPREPORT_SERVERVERSION :
- MAPREPORT_OVERFLOW :
USERS ACCESS
Configuration settings for individual user and group accounts.
- USERS_CONF : Path to user accounts configuration file with no connection to Active Directory (e.g. ...\Settings\USERS.conf).
- GROUPS_CONF : Path to group accounts configuration file with no connection to Active Directory (e.g. ...\Settings\GROUPS.conf).
- HTPASSWD_BIN : Path to executable which creates passwords (e.g. ...\apache\bin\htpasswd.exe).
- HTPASSWD_FILE : File where passwords are saved (e.g. ...\MapHTTPServer\htpasswd).
- USER_INFO : Password filename on the system (e.g. ...\passwd on Windows or /etc/passwd on Unix).
- GROUP_INFO : Obsolete.
- PRINTER_INFO :Obsolete.
- AUTH_MOD : Authentication mode.
LOGS
LOG file settings
- PATH_LOG : Path where the spooler's log files are saved (e.g. ...\Spooler\logs).
- PATH_LOG_CONF : "Translation" file for Mapping log files. The messages are not saved to log, but replaced with an index translated using the file specified (e.g. ...\Settings\log.conf).
- DAEMON_LOG : Spooler log file (e.g. map_daemon.log)
- LPR_LOG : LPR log file (e.g. map_lpr.log).
- CONTROL_LOG : map_control log file (e.g. map_control.log).
- LPD_LOG : LPD log file (e.g. map_lpd.log).
- PJL_LOG : map_raw log file (e.g. map_raw_log).
- LOG_LEVEL : Log verbosity leve 1 to 4, 4 being the highest level.
- STATS_TRACES : Enables the use of statistics. High or low. Not case-sensitive.
- MAPPING_USAGE_REPORT : Enables / Disables the statistics on the quantity of CPU resources used by Onyx, Connect and the spooler.
MAPCPYSPLF
Configuration settings for the MAPCPYSPLF command
- MAPCPYSPLF_MAPMOD : Processing mode: C to print; D to print and archive in M-Storage format; O to archive in M-Storage format only; U: Unix Archive, the spool files are copied to the folder; K: Print and Unix Archive, the spool files are printed then copied to PATH_ARCHIVE.
- MAPCPYSPLF_PAGM : Page size (e.g. A4).
- MAPCPYSPLF_LANG : Print language, PCL by default. Values are not case sensitive.
- MAPCPYSPLF_STATE : Spool file status. Ready to print (RDY) or held (HLD). Values not case sensitive.
- MAPCPYSPLF_KEEP : Keep spool file in the Saved state (YES or NO).
- MAPCPYSPLF_SNDFDP : Send overlay (YES or NO).
- MAPCPYSPLF_SNDPOL : Send fonts (YES or NO).
- MAPCPYSPLF_SNDLGO : Send images (YES or NO).
- MAPCPYSPLF_LENGTHIN : Obsolete.
- MAPCPYSPLF_LENGTHOUT : Obsolete.
- MAPCPYSPLF_STARTPAGE : Start page.
- MAPCPYSPLF_STOPPAGE : End page.
- MAPCPYSPLF_LENGTHREC : Spool file width (length of a record).
- MAPCPYSPLF_SPOOLNAME : Spool file title.
- MAPCPYSPLF_OVERFLOW : Number of lines per page.
- MAPCPYSPLF_ONEFILE : Obsolete.
- MAPCPYSPLF_DECIMAL : Decimal separator.
- MAPCPYSPLF_THOUSAND : Thousands separator.
- MAPCPYSPLF_CODEPAGE : Code page.
DEFAULT SPOOL FILES VALUES
Default spool files attributes retrieved if not specified in the command.
- DEFAUT_SPOOL_SAVE : Save spool file. YES or NO. Not case-sensitive.
- DEFAUT_SPOOL_PTY : Spool file priority, 1 being the lowest priority. Supported values 1 to 20.
- DEFAUT_SPOOL_NBCOPY : Number of copies.
- DEFAUT_SPOOL_RETENTION : Number of days during which spool files will be kept.
- DEFAUT_SPOOL_COMPRESS : "Compression date" field. Attribute inherited from AS/400 system sometimes used by client applications.
- DEFAUT_SPOOL_STARTPAGE : Start page.
- DEFAUT_SPOOL_STOPPAGE : End page.
- DEFAUT_SPOOL_SECURITY : Security level. 0 by default, same as 777
- DEFAUT_SPOOL_CODECOMPTA : Spool file numbering code used in accounting (not used internally)
- DEFAUT_SPOOL_FIDELITY : "Fidelity" attribute (not used internally). Attribute inherited from AS/400 system sometimes used by client applications (e.g. DEFAULT_FIDELITY).
- DEFAUT_SPOOL_PAPERSTATUS : Type of paper loaded in printer (e.g. DEFAULT_PAPER).
- DEFAUT_SPOOL_HOST : Host name (e.g. DEFAULT_HOST).
- DEFAUT_SPOOL_USER : Default username (e.g. DEFAULT_USER).
MAPREPORT EXPERT
Expert CONNECT settings
- SHELL_MAPREPORT : Path to Connect menu script.
- MENUS_MAPREPORT : Path where projects are imported.
- PATH_DES : Path where projects are imported.
- PATH_DBF : Path where projects are imported.
- PATH_DBL : Path where projects are imported.
- PATH_DBC : Path where projects are imported.
- PATH_DBW : Path where projects are imported.
- MAPREPORT_DEFAULT_FILTRE_TABLE : Default value of table name filter in Connect--> Extract (e.g. %).
- MAPREPORT_DEFAULT_FILTRE_OWNER : Default value of table owner filter in Connect--> Extract (e.g. %%).
EXPERT PATH
- PATH_IMPORT : Path where document templates are generated by Designer (e.g. ...\Import).
- PATH_PGM : Path where document templates are imported.
- PATH_HELP : Path where binary translation files are stored.
- PATH_PCL : Path where PCL document templates are imported.
- PATH_AFPDS : Path where AFP document templates are imported.
- PATH_ZEBRA : Path where ZEBRA document templates are imported.
- PATH_DPL : Path where DPL document templates are imported.
- PATH_IGP : Path where IGP document templates are imported.
- PATH_TEC : Path where TEC document templates are imported.
- PATH_IPL : Path where IPL document templates are imported.
- PATH_F_D : Path where F_D document templates are imported.
- PATH_PDF : Path where PDF document templates are imported.
- PATH_XPS : Path where XPS document templates are imported.
- PATH_EPL : Path where EPL document templates are imported.
- PATH_FONT_TTF : Path where font files (*.ttf) used in document templates are stored.
- PATH_FONT_XPS : Path where font files (*.odttf) used in XPS document templates are stored (map_xps command only).
- LIB_PATH : Path to spooler binary files.
- PATH_ARCHIVE : Path where Unix archive files (mapcpysplf –mapmod: U) are stored.
- PATH_TEMP : Path to temp folder.
- PATH_STATBIN : Obsolete.
- PATH_MAP_DAEMON : Name of map_daemon binary.
- PATH_MAP_EXEC : Name of map_exec binary.
- PATH_MAP_LPD : Name of map_lpd binary.
- PATH_MAP_LPR : Name of map_lpr binary.
- PATH_MAP_AXIOHM : Name of Axiohm driver binary.
- PATH_MAP_SAMSUNG : Name of Samsung binary.
- PATH_MAP_POS : Name of POS driver (EPSON printers only).
- PATH_MAP_RAW : Name of map_raw binary.
- PATH_MAP_MAIL : Name of map_mail binary.
- PATH_MAP_WIN32PRT : Name of MAP_WIN32PRT program (print to Windows local printer).
- PATH_MAP_USBPRT : Name of MAP_USBPRT program (print to USB).
- PATH_MAP_COMPRT : Name of MAP_COMPRT program (print to serial / parallel).
- PATH_MAP_RAWD : Name of map_rawd binary.
- PATH_MAP_STATD :
- PATH_MAP_SPLF : Name of map_splf binary.
- PATH_MAP_LPSTAT : Name of map_lpstat binary.
- PATH_CONF_IMP : Path and name of the file containing the information number returned by the printer.
- PATH_QUEUES : Folder where spooler queues and peripherals are stored.
- PATH_FIFOS : Folder where spooler FIFO files are stored.
- PATH_ETC_QUEUES : Folder where the queues and peripherals configuration files are stored.
- PATH_INFO : Folder where the queues and peripherals information files are stored.
- PATH_STDIN : Path and name of the file receiving the stdin.
- PATH_STDOUT : Path and name of the file receiving the stdout.
- PATH_STDERR : Path and name of the file receiving the sterr.
- RULES_PATH : Path to the spooler's operational rules.
- STATS_PATH : Path where the projects used are stored (e.g. ...\Spooler\stats).
- PATH_COUNTER_SPLF : File containing the spool file's id count.
- PATH_QUEUE_DEF : Name of the configuration file for queues and peripherals.
- ARCHIVE_IMPORT_PATH : Path from where the backups are imported (Deployments management).
- ARCHIVE_EXPORT_PATH : Path to where the backups are exported (Deployments management).
- DEPLOYMENT_CUSTOM_LOGFILE : Path and name of the backup log file.
- MAPPING_PATCH : To handle software patches in a multiplatform environment.
- PATH_KEYFILE :
- PATH_GHOSTSCRIPT :
EXPERT OPTIONS
Additional expert settings
- AIXTO19U_TABLE : Character conversion table.
- 19UTOAIX_TABLE : Character conversion table.
- EBCDICTOASCII_TABLE : Character conversion table.
- ASCIITOEBCDIC_TABLE : Character conversion table.
- MAPCPYSPLF_TMPCNT : File counter for temp remap files.
- MAPCPYSPLF_MAPCNT : File counter for remap files.
- LIST_OBJ : Path to lstobj.txt file.
- PRINT_INFO : Path and name of printer bin configuration file.
- EURO : Path and name of currency translation file.
- MESSAGES : Path and name of binary message file.
- PASSWORD : Password file for MapOut.
- MAPKEY : Path and name of the software license file.
- UCINFO : Text file containing CPU and system information.
- MAPWEB_FUNCTIONS : Not used.
- RULES_CONDITIONS : Path and name of the file containing the default values of parameter conditions for the rules engine.
- RULES_PARAMETERS : Path and name of the file containing the default values of parameter for the rules engine.
- RULES_COMMANDS : Path and name of the file containing the default values of commands for the rules engine.
- RULES_809 : Default name of rules engine.
- RULES_TABLES : Path and name of the file containing the list of resolution tables.
- HOST_LPD : Hosts file for LPD.
- RESLIB : Path to AFP resources (for InfoPrint Manager).
- STATS_SHELL : Binary which executes the stats i.e. map_stats.bat.
- IMPORT_BACKUP : If set to "yes", the files are saved when a format is imported.
- IMPORT_FONT : Overwrite fonts when a format is imported. YES or NO.
- PATH_EXPORT_SETTINGS : Path and name of deployment configuration file.
- PATH_COUNTER_EXPORT : Number of deployments. Path and filename.
- DAEMON_NO_HOLD_ON_ERROR : Queues of type Printer do not fall in error status (YES or NO).
- DAEMON_DONT_HOLD_ENTRY_ON_ERROR : Queues of type Entry Point do not fall in error status (YES or NO).
- XPSCONFIG :
OTHER
- KILL_ON_REFRESH : Delete binary files executed in the background while refreshing the Web UI (YES or NO).
- REFRESH_VIEW_DELAY : Refresh the display of spool files automatically every N seconds.
- ARCHIVEROOT : Path where .MAP are stored - for use with MapOut.
- USER_ICON : Enable user icons in the main navigation bar (YES or NO).
- UNICODE : Enable Unicode programs (YES or NO).
- MAP_006FILE_BASE : In the file management UI, place from where Mapping starts browsing the files. By default, it is empty, which means that the files are browsed from the root of the "C:" drive on Windows and "/" on Unix.
- CASHTRANSACTION_ID : For use with MPCM. Obsolete.
- CASHREDIRECTOR_ID : For use with MPCM. Obsolete.
MAIL ALERT
The parameters listed below let you configure automated e-mail alerts. For example, to send an e-mail automatically when the product's license keys are about to expire.
- MAP_MAIL_ALERT_ENABLED : Enable e-mail alerts (YES or NO).
- MAP_MAIL_ALERT_SERVER : SMTP mail server (e.g. 192.168.1.1).
- MAP_MAIL_ALERT_DOMAIN : Server domain controller.
- MAP_MAIL_ALERT_LOGIN : Server connection username.
- MAP_MAIL_ALERT_PASSWD : Server connection password.
- MAP_MAIL_ALERT_FROM : Sender's e-mail address.
- MAP_MAIL_ALERT_TO : Recipient's e-mail address.
LDAP
The parameters explained below let you configure a connection to an LDAP directory.
- LDAP_ACCESS : Enable access to LDAP (ON or OFF).
- LDAP_HOST : LDAP server's IP address.
- LDAP_HOST_BACKUP : Backup LDAP server's IP address.
- LDAP_DN : CN=Firstname LASTNAME,CN=Users,DC=domain,DC=local.
- LDAP_PWD : Password.
- LDAP_BASE_USERS : CN=Users,DC=domain,DC=local.
- LDAP_BASE_GROUPS : OU=Distribution Groups,OU=MyBusiness,DC=domain,DC=local.
- LDAP_UID : Login.
- LDAP_USERSFILTER : User class filter.
- LDAP_GROUPSFILTER : Groups class filter.
- LDAP_USERSLIST : Members list (e.g. member).
- LDAP_GROUPSLIST : Groups list (e.g. memberOf).
WORKFLOW
- Default configuration of workflow:
- USE_NEW_RULES : on / off (on by default),
- on = new graphical workflow
- off = old rules engine (command line)
- Configuration of workflow Web UI:
- SOAP_DEBUG : on / off (default), on = debug, off = normal
- SOAP_PATH_TEMP : Workflow temp path where temp files are created
- SOAP_PATH_LOG : Path where log files are stored, des fichiers .log y seront créés
- SOAP_LOCATION : Workflow service URL, formatted as a URL, by default http://127.0.0.1:8002/cgi-bin/mapsoapserver.exe
- SOAP_LOCAL_URL : 🗑Deprecated
- SOAP_DOCUMENT_URL : 🗑Deprecated
- Default values for mail server:
- MAIL_SERVER : Hostname or IP address of SMTP server
- MAIL_DOMAIN : Domain associated with SMTP server
- MAIL_PORT : Connection port (default 587 in TLS)
- MAIL_LOGIN : SMTP server login
- MAIL_PASSWORD : SMTP server password
- MAIL_FROM : Sender's address in "From" field
- Default values for Web and SOAP boxes:
- DEFAULT_FILE_TYPE : HTML file path used as a template for SOAP mailing (box Display messages in)
- DEFAULT_MAIL_BODY : File used as a template for mailing
- DEFAULT_ RESPONSE_BODY : Email body content type
- Other :
- PATH_CONFIG_CUSTOM_ACCESS : Path where xml conf files are stored; used to configure access to ACL.
- Example
- PATH_CONFIG_CUSTOM_ACCESS : Path where xml conf files are stored; used to configure access to ACL.
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<userconfig name='mapadmin'>
<spooler>
<columns />
<acls />
<view_config />
</spooler>
</userconfig>
- Formating control:
- RESOLVE_PERPAGE : Integer, number of pages
- Date control:
- MAP_CURRENT_DATE : Expected date format (without time) (e.g.
%d/%m/%Y
) - MAP_CURRENT_TIME : Expected time format (e.g.
%H:%M:%S
) - MAP_CURRENT_TIMESTAMP : Expect full date format (e.g.
%d/%m/%Y %H:%M:%S
)
- MAP_CURRENT_DATE : Expected date format (without time) (e.g.
- PostgresSQL database tracking :
- TRACKING_SERVERADDRESS : SQL server address
- TRACKING_SERVERPORT : SQL server port
- TRACKING_SERVERUSER : SQL user
- TRACKING_SERVERPASSWORD : SQL password
- TRACKING_SERVERBASENAME : Database name
- TRACKING_LIB_PATH : Path to database library (.dll expected)
- TRACKING_SERVERSCHEMA : Tables schema