ClassiX® Environment Variables

The following environment variables split up into system- and user environment variables. System variables are evaluated via ClassiX® base system, user variables control application- and user-specific settings. 

System Environment Variables

Name Description Value Comment
CX_ABEND log for ClassiX® abort string, logfile name. default: CX_SYSTEM\CXAbend.log or CX_ROOTDIR\system\CXAbend.log only for ClassiX® supervisor
CX_APPSWH directory name for  InstantView® modules string, default: CX_ROOTDIR\appswh
CX_APPSWH_HELP directory name for HTML documentation via F1 string, default: not defined it is possible to make multiple path specifications that are separated via semicolon; at first it makes sense to set the variables CX_HELPROOT and CX_HELPROOT_LOCAL
CX_BITMAP directory to search for bitmaps string, default: CX_ROOTDIR\bmp the directories are separated via semicolon and they are searched in the specified order
CX_CACHE_SIZE_FACTOR part, that the cache should get from the free memory number, default: 25 in %
CX_CLUSTERING pattern  number, default 0 defines a master object 
CX_DATABASE full path for the first database full path of the database file CLASSIX.INI environment variable; also see information about Database Security
CX_DEBUG_RCB_QUEUE deadlock retry debugging string, true or false, default: false lets logfiles get much bigger, therefore only insert for single clients
CX_FIXED_CACHE_SIZE fixed cache size number, default: 8 in MBytes
CX_GARBAGE_LOGGING_THRESHOLD keep record of garbage-collection runs which take longer than n milliseconds number (in milliseconds) logging in category cx.gc with INFO level
CX_HELPROOT directory name of the ClassiX® online documentation string, default: CX_ROOTDIR\DOC\L0L1\APPSWH  L0L1 stands for the two-digit identifier of the current language the ClassiX® online documentation is based on HTML; if the environment variable CX_HELPROOT has been defined, the HTML file gets searched in
CX_HELPROOT\L0L1\APPSWH;  L0L1 stands for the two-digit identifier of the current language
CX_HELPROOT_LOCAL directory names of the customized documentation, which is (/must be) only locally available (and not on the internet). This documentation includes the individual adjustments for the customer in reference to the  ClassiX® system and/or specifications to internal processes (organization handbook) string, default: not defined documents which have been found via CX_HELPROOT_LOCAL refer to other local documents with their hyperlinks or ONLY to the default documentation on the ClassiX® homepage (www.classix.de)
CX_IBUF_SIZE buffer size for InstantView® code in Bytes number, default: 200000 for extremely large InstantView® modules
CX_LICENSE_FILE path to license file string, such as c:\classix\classix.lic always needs to be specified, or the system cannot find a license file
CX_LOCAL_DIRECTORY ClassiX® directory on the local client string, such as c:\ClassiX always needs to be specified, in case controls are installed on the client or if a local copy of the ClassiX® DLLs helps start ClassiX® faster
CX_LOG_FILE switch Logging System on/off ON, OFF or filename in case the logging has been switched on, start/end, problem reports and alerts (depending on the Logging Settings) are written into a logfile, which is in the ClassiX® system folder. Additionally, it is possible to write text into the logfile from the applications  via function Log() of the SYSTEM Managers (also only if logging is switched on)
CX_LOG_STACK for errors, log the n top stack entries  number for debugging; stack entry logging can cause crashes, if the stack objects are already destroyed
CX_LOGGING_INI configuration file for Logging System filename file always searched in the ClassiX® system directory
CX_MACRO_LOGGING_THRESHOLD log only runtime macros, which have been running for at least n seconds number (in seconds, resolving takes 1 second) Logging for the category cx.rqdsp.time needs to be switched to DEBUG
CX_MAP indicates, where the DLL .map files are string, directory name  only for ClassiX® supervisor
CX_PATH additional paths in which it is searched for ClassiX® files string, directory name  the directories are separated via semicolon and browsed in the indicated order
CX_QUERY_MODE query mode NORMAL, COPY, LOW or LOW_COPY; Standard: NORMAL NORMAL: eventually repeat query in LOW mode, in case the address space is not enough
COPY: like NORMAL, copy the result collection internally at the end and return copy;
LOW: execute query in the existing address space as good as possible; at the end, release address space again;
LOW_COPY: LOW and COPY combined
CX_REPORT_FORCED_WRITE temporary switching the IV commands in the update mode any  only when working with OpenDB(READ) in MVCC mode; every switching gets logged in the logfile; only for tests.
CX_RESERVED_FOR_APPS Speicher, der für Programme reserviert werden soll, bevor die Cache-Größe berechnet wird number, default: 32 in MBytes
CX_ROOTDIR ClassiX®  installation -directory string, directory name cannot be set in CLASSIX.INI
CX_LISTVIEW_READONLY_TXN ObjectListView uses a read-only transaction for display and sorting, if the list contains more than n entries integer 0 or not set: normal transaction handling;
> 0: read-only transaction is used for display and sorting
CX_SHOW_LOADED_DLLS the logfile loggs all loaded DLLs; they are directly loaded via ObjectStore before defining the PAR  (Persistent Address Range) TRUE or FALSE, default: FALSE can be used to analyze address space errors, but it should not be set by default, since the ClassiX® start gets delayed
CX_SYSTEM ClassiX® system directory string, default: CX_ROOTDIR\system cannot be set in CLASSIX.INI
CX_SYSTEM_DB name of the database, which  persistently stores system information (for example from classix.dic) string, default: CX_DATABASE
CX_SYSTEM_OUT ClassiX®  system directory (writing) string cannot be set in CLASSIX.INI
CX_TS_CACHE_SIZE fixed cache size, if ClassiX® runs on a terminal server number, default: 64 in MBytes
CX_TXN_LOGGING_THRESHOLD only log the end of a database transaction, which takes at least n seconds number (in seconds, resolving takes 1 seconds) if not set, all transactions are logged; the Logging category cx.txn needs to be switched to DEBUG
CX_WORD_DOT path of the document model file for Word (*.dot)  string, e.g. %CX_ROOTDIR%\System\classix.dot

User Environment Variables

Name Description Value Comment
CX_BIN directory names of the DLLs and .exe file string, such as %CX_ROOTDIR%\Bin\%CX_VERSION%
CX_COUNTRY country code number between 0 and 255  for the administration of locale information (Locale)
CX_CUSTOMER_DATA customized data directory path \\ClassiX\customer\AppsWh\customer\data-directory used to import/export customized data, such as transaction descriptions and business processes
CX_CORBA_HOSTNAME CORBA Server Object name in the NamingService string should only be used, if a unique name makes sense; for scalability or system stability, the name hierarchy should be used
CX_CORBA_OPTIONS initialization values to the CORBA initialization routine (e.g. to select the NamingService) for example -ORBInitRef NameService=corbaloc:iiop:liserver:1245/NameService  
CX_CORBA_PROJECT CORBA project name string represents the middle part of the name hierarchy and should be preferred to CX_CORBA_HOSTNAME
CX_EDITOR path to the text editor and access parameter (s. Monitor Window) for example for Eclipse
C:\eclipse\eclipsecall %s %d %d -EC:\eclipse\eclipse.exe

Attention!
Put path name with space character into quotes:
c:\"Program Files"\Eclipse\...

CX_GHOSTDIR directory name of the ghostscript DLLs and .exe for example c:\programs\gs\gs6.53\bin required to create PDF files via OLE print (MS Word print)
CX_PROJECT_NAME project name for example evaluate the project-specifically derived modules are in the directory  appswh\%CX_PROJECT_NAME%\*.*
CX_PROJECT_INITIALS project short form for example EVA customized derived modules end with <module name>_%CX_PROJECT_INITIALS%.mod such as itmcoedt_ts.mod
CX_PROJECT project file name string, e.g. %CX_ROOTDIR%\projects\evaluate.cxp
CX_WEB_PROXY HTTP proxy server string, e.g. "192.168.1.1:3128" for internet connections (e.g. for currency tables -updating tax ID number check), in case a proxy server is required
CX_REGION region code  number, any for the administration of locale information (Locale)
CX_STATE state code number between 0 and 255  for the administration of locale information (Locale)
CX_VERSION DLL version to be used in the form Z.Z for example 4.1 or 4.2 the value should either be indicated as an environment variable on the computer, or predefined in the projekt.bat

Related Topics