A Guide to System Environment (SYSENV) Configuration Records (CFG) (General)

SYSENV config records:

All the modern config records discussed below follow the same naming convention.  They are all named CFG_<SOMETHING>, and there may be multiple instances for CFG_<something> found in the SYSENV table; these multiple instances allow the <something> configuration to be specific to a particular application and user, or a specific user (regardless of application), or a specific application (regardless of user), or a global default.  In order, the specific instances are named:

CFG_<something>*<appid>*<username>

CFG_<something>**<username>

CFG_<something>*<appid>

CFG_<something>

The <something> process will look, from the most to least specific, for a matching configuration record.

CFG_CTO: Controls CTO and AREV32 connection behavior

* 1. IP Address of engineserver, or path to revcap32.dll (may be . or windows path, or URL of EngineServer)

* 2. Port number {]EngineName]StartupFlags]ShutdownFlags}

* 3. foreground color name

* 4. background color name

* 5. title

* 6. routine to run (may be explicit string «NONE» to override default behavior of calling AREV32 when using AREV32_CHILD_FORM/AREV32_STANDALONE_FORM)

* 7. Font name

* 8. Macro record name (or <table><space><record name> if not in SYSENV)

CFG_IDX_SETS: Used to determine which version of IDX_SETS are used original or .NET

Field 1: X

Field 2: blank (to use most recent version of .NET), or IDX_SETS1 to use original IDX_SETS

CFG_INET: Controls RUN_OECGI_REQUEST behavior, used by both INET_ and O4W_ routines

Security Routine (INET_SECURITY) ] Wrapup Routine (INET_FINALIZE) ] Abort routine (INET_ABORTED)

Error text (@TM delimited)

Default CGI extension (.CGI) ] Default page url portion (/page)

Blank by default, set to 1 to have multiple instances of variables in the queryparam reduced to just the first instance

@VM delimited list of INET_xxx routines that are allowed to run

CFG_LOGIN: Used to determine whether OI does single sign on, and how it validates users

*——————————————————-

* SYSENV*CFG_LOGIN

*——————————————————-

* This record controls single sign on behavior

* Set loginmode (field 1) , user groups ( fields 2,3, 4) as needed

* Save as CFG_LOGIN*MYAPP to make an application specific setting

* Save as CFG_LOGIN to affect all applications in this copy of OpenInsight

*—

* Layout

*—

* <1> = LoginMode

* <2> = LDAP Groups whose members are Normal users

* <3> = LDAP Groups whose members are Admin users

* <4> = LDAP Groups whose members are Sysadmin users

*—

*–

* LoginMode Description

*–

* LoginMode = "0" (or "" or invalid) =⇒ use legacy authentication, require a username/password combination define in the OpenInsight application users list.

* LoginMode = "1"         =⇒ get network user name, no password required, user name must exist in OpenInsight application users list.

* LoginMode = "2"         =⇒ get network user name, no password required, user must be a member of a network group listed in config record <2>, <3>, or <4>

*—

* Notes

*–

* The Login process will search for a record named CFG_LOGIN*appname, for example CFG_LOGIN*EXAMPLES

* If that record does not exist OI will search for this record, CFG_LOGIN

* If CFG_LOGIN does not exist OI will behave as if loginmode = 0

CFG_O4W: Used for embedded O4W forms (specifically, the O4W_CHILD_FORM and O4W_STANDALONE_FORM)

/* Layout of CFG_O4W{*{<appid>}{*<userid>}}

* 1. Default URL (used if no create params specified)

* 2. {Default Width] Default Height}

* 3. SiteName ]

* 4. URL for site ]

* {5. Title] }

* {6. ProgType] }

* {7. ProgDetail] }

* {8. Width\Height] }

*/

CFG_OIBRW: Used to control the new Banded Report Writer

* 1. path or url to use for connection (use . Or windows path for direct connection, or EngineServer URL)

* 2. Port (for EngineServer, if used)

* 3. engineName (blank to auto-determine, or * to use the current oengine)

* 4. Startupflags (blank for defaults, 0 if using the current oengine)

* 5. Shutdownflags (blank for defaults, 0 if using the current oengine)

* 6. Routine to return tables and procedures (blank for default RTI_BRW_FILTER)

CFG_OIPI: Used to control which print engine (OIPI or OIPI.NET) is used

Field 1 is either VSPRINTER2 (which uses OIPI.NET) or anything else (which used OIPI)

CFG_NETOI: Used to process many common output conversion codes locally, rather than on the host

Field 1 is either 0 (NetOI will not process the conversion codes locally, but will continue to rely on the host for all OCONV processing) or 1, (NetOI will process the available conversion codes locally and not on the host)

CFG_QPTR: Used for q-pointer persistence configuration (in CTO/AREV32/OI)

*——————————————————-

* SYSENV*CFG_QPTR

*——————————————————-

* This record controls Q-POINTER (dynamic table access) behavior

* Set cache flag (field 1)

* Save as CFG_QPTR*MYAPP*MYUSER to make an application and user specific setting

* Save as CFG_QPTR**MYUSER to make a user specific setting

* Save as CFG_QPTR*MYAPP to make an application specific setting

* Save as CFG_QPTR to make a global setting

*—

* Layout

*—

* <1> = Cache flag

*—

*–

* Cache flag Description

*–

* Cache flag = "0" (or "" or invalid) =⇒ Always resolve q-pointer record information, do not cache tables when found

* Cache flag = "1"         =⇒ Once resolved, retain resolved information in cache for increased performance

*—

* Notes

*–

* - The config record information is only accessed when the application starts up; changes to this record will not take effect until the user exits and re-enters OI

* - The "Open File" process will search for a record named CFG_QPTR*appname*username, for example CFG_QPTR*EXAMPLES*SAMPLEUSER

* – If that record does not exist OI will search for this record, CFG_QPTR**username, for example CFG_QPTR**SAMPLEUSER

* – If that record does not exist OI will search for this record, CFG_QPTR*appname, for example CFG_QPTR*EXAMPLES

* – If that record does not exist OI will search for this record, CFG_QPTR

* - If no CFG_QPTR records are found OI will behave as if cache flag = 0

* - When cache flag is "0":

* – OI will resolve the q-pointer each time the q-pointer is accessed 

* – Any changes to any q-pointer will be immediately seen when the q-pointer is next accessed

* - When cache flag is "1":

* – OI will resolve the q-pointer only when the q-pointer is first accessed 

* – Any changes to a previously-accessed q-pointer will NOT be reflected when the q-pointer is next accessed - the previously-resolved table will continue to be used

* – To see any changes to a previously-accessed q-pointer, you must either exit and re-enter OI, 

* – or run DETACH_TABLE on the q-pointer table (for example, "DETACH_TABLE QPTR")