View source for BRconfig.sys

The '''Business Rules! configuration file''' (generally referred to as the "'''BRConfig.sys'''") contains ''environmental specifications'' that support the use of standards to be applied across multiple operating environments. In other words when an environment changes your application need not change. Only the configuration file needs to change. 

BRConfig.sys specifications are specified in a plain text file which Business Rules! automatically accesses at [[BR32.exe]] start-up. You can create and edit this file with any text editor. The line length is limited to 800 characters. See also [[Config for Beginners]].

===Invoking BRConfig.sys===
Whenever [[Business Rules!]] is started with the [[BR32.exe]] command, it automatically searches for a Business Rules! configuration file. Unless you specify otherwise (as a parameter for the BR startup command), Business Rules! assumes that the configuration file is named BRConfig.sys (or BRCONFIG.SYS). Older versions of the Business Rules! configuration file defaulted to the name WBConfig.sys.  If BRConfig.sys is not found then WBConfig.sys will be searched for and used if possible.

There is no limit to the number of configuration files that may exist. If you want Business Rules! to access a configuration file that has a name other than BRConfig.sys (or WBConfig.sys), you must specify its name as part of the BR start-up command. (See the explanation of the [[BR32.exe]] [[command]] or the [[Getting Started]] for more information.)

Business Rules! configuration files may include one or more of the system's BRConfig.sys specifications. A comment, when separated from the specification by one or more spaces, may follow each of these specifications. When Business Rules! is started, the screen displays BRConfig.sys specifications that contain errors. These errors are ignored (default settings are used for any specification with an error), and processing continues without interruption.

The remainder of this article contains details about individual BRConfig.sys specifications.

Each specification in the BRConfig.sys file may be followed by at least one space, an exclamation point (!) and a comment. Business Rules! will ignore everything after the exclamation point.

Note: If BR is unable to remove the [[WBServer.dat]] file when the first user logs in, it will attempt to truncate the file to zero bytes before proceeding.

==Overriding BRConfig.sys specifications==

Most specifications set in the BRConfig.sys file can be replaced or overridden in programs by using the syntax "execute 'config XXXXXXXX'" where "XXXXXXXX" is one of many available keywords and associated values.  [[Config]] does not actually change the file; it simply overrides the specification in the file. CONFIG will take effect when a program is active. It may be used in a procedure file and it may be specified with the [[Execute]] statement. 

A listing of the current specifications and their values can be viewed after Business Rules! is started by entering [[STATUS CONFIG]] at a command prompt from within Business Rules.

==Defaults==

BR! [[4.0]]+ automatically looks for a configuration file called BRConfig.sys and programs ending with [[.BR]] before looking for their .WB counterparts.

Starting with version [[4.0]], [[programs]] save as .BR files instead of .WB files. [[Option (Config)|[Option]] 29 can be specified to suppress this feature.

===%env-var%===

All BRConfig.sys specifications and [[Config]] commands will accept an [[environment variable]] specified in the format %env-var%, where "env-var" is the name of an environment variable that has already been set up at the operating system level.

Whenever an environment variable specified in this format is encountered, Business Rules! will substitute the contents of the environment variable in the BRConfig.sys specification. If the specified environment variable is not defined at the operating system level, no substitution will occur. (In some cases an error will result, but in others the environment variable format will be accepted as a literal specification.)

The environment variable will probably be most useful for specifying user-specific information. The BRConfig.sys specifications for which it is expected to be most useful include [[Substitute]] and [[Include]].

==Specifications==


===Application_Name===

{{:Application_Name}}

===Attribute===

{{:Attribute (Config)}}

===BaseYear===

{{:BaseYear}}

===Break===

{{:Break (Config)}}

===BRServer===

{{:BRServer (config)}}

===ChainDflt===

{{:ChainDflt}}

===Collate===

{{:Collate}}

===Collate Alternate===

{{:Collate Alternate}}

===Color===

{{:Color}}

===Command Console Colors===

The SCREEN C [xx] specification determines the foreground and background colors of the command console. Running the following example program sets a white foreground and dark red background for the command console.

The name of this program is: COMCONSL.BR

 00100 EXECUTE "CONFIG ATTRIBUTE [CMD_CONSOLE]/#HRGB:R"
 00200 EXECUTE "CONFIG SCREEN C [CMD_CONSOLE]"

====Output====
[[image:ccc.jpg]]

===DataHilite===

{{:DataHilite}}

===Decimal Statement===
{{:Decimal (Config)}}

===DimOnly===

{{:DimOnly}}

===Drive===

{{:Drive}}

===S/23-DRIVES===

The '''S/23-Drives''' [[BRConfig.sys]] specification, designed for Business Rules! compatibility with code converted from the IBM System/23, assigns up to nine System/23 drive numbers to DOS drive letters.

====Comments and Examples====
The primary advantage of the S/23-DRIVES specification is that it supports drive assignments without depending upon the hardware configuration; nonexistent drives can be routed to an existing drive.

====Syntax====
[[Image:S23.png|350px]]

====Start-up Default====
S/23-DRIVES ABCCCCCCC

====Parameter====
"Drive letter" is the drive to which a System/23 drive should be assigned. This parameter may be repeated up to nine times.

The System/23 drive number is indicated by the ordinal position of the drive letter parameter. In the default specification S/23-DRIVES ABCCCCCCC, for instance,<br>
System/23 drive 1 goes to drive A;<br>
System/23 drive 2 goes to drive B;<br>
System/23 drives 4-9 go to drive C.

Other specifications, such as S/23-DRIVES ABCDDDDDD or S/23-DRIVES ACBCCCCCC, work in the same manner.

====Technical Considerations====
# The [[CONFIG]] command can be used during program execution to override the BRConfig.sys file's [[S/23-DRIVES]] specification.
# Although the S23-DRIVES statement may continue to function in current versions of Business Rules! (4.1+), it is no longer supported.

===EXECUTE===
{{:Execute (Config)}}

===Editor===

{{:Editor}}

===Environment Variable Simulation===

The [[ENV$]] function, which is used to interrogate the BR environment, has been expanded to permit the simulation of setting an environment variable with configuration statements.

   CONFIG SETENV  SIZE  '10 x 24'

This allows a program to use ENV$("SIZE") to retrieve the value "10 x 24", (quotes excluded). In the event SIZE was previously defined in the environment it will *appear* as set to the new value for the duration of the BR session.

See [[SETENV]] for more details.


===FieldBreak===

{{:FieldBreak}}

===FieldHelp===

{{:FieldHelp}}

===FileNames===

{{:FileNames}}

===FlowStack===

{{:FlowStack}}

===FONT===
{{:Font (Config)}}

===FORCE VISIBILITY (4.16+)===

 CONFIG FORCE VISIBILITY [ ON  OFF ]

If FORCE VISIBILITY is ON, then, upon opening a new child window, this causes labels, text boxes, and buttons that underlay the new window to be copied to this new window.  Underlying portions of fields on the parent window that span across child window boundaries also get copied to the child window.  This simulates the way the old BR console works with see-through windows.

References to controls that begin in the portion of the parent window that is covered by the child window are converted to corresponding addresses on the child window.

Before running the following example, type CONFIG FORCE VISIBILITY ON from command line.  In this example, a picture, a label, a button, and a textbox are printed to the graphical console.  When a child window is opened, the label, the button, and the textbox are copied from the parent window to the child window. The picture does not get copied.

The name of this example is: FORCE_V.BR

 00100    PRINT FIELDS "5,3,P 3/5": "Matrix.ico"
 00200    PRINT FIELDS "2,3,C 5": "ABCDE"
 00300    PRINT FIELDS "3,3,C 6,,B20": "WXYZ"
 00400    INPUT FIELDS "4,3,C 4": VAR$
 00500    OPEN #1: "srow=2,scol=2,rows=10,cols=15,border=S,parent=0",display,outin
 00600    INPUT #1, FIELDS "8,1,C 4": VAR$

Also, try running this program with VISIBILITY OFF.

;CLOSE FREE

CLOSE FREE clears the underlying parent area and copies the child window controls to the parent window.

In this example, a picture, a label, a button, and a textbox are printed to a child window of the graphical console. The child window is then closed using CLOSE FREE.  As a result, the label, the button, and the textbox are copied from the child window to the parent window. The picture does not get copied.

The name of this example is: CLOSFREE.BR

 00100 OPEN #1: "srow=2,scol=2,erow=10,ecol=15,border=S,parent=0",display,outin
 00200 PRINT #1, FIELDS "1,1,P 3/5": "Matrix.ico"
 00300 PRINT #1, FIELDS "4,1,C 5": "ABCDE"
 00400 PRINT #1, FIELDS "5,1,C 6,,B20": "WXYZ"
 00500 INPUT #1, FIELDS "6,1,C 4": VAR$
 00600 CLOSE #1, FREE:
 00700 KSTAT$(1)

Note that FORCE VISIBILITY has no effect on GUI controls (such as GRID and LIST). Only labels, text, and buttons are processed by FORCE VISIBILITY. This feature accommodates certain old BR window behaviors in existing programs. It should not be used for new development.


===ForStack===

{{:ForStack}}

===Graphic Image Cache (Client Server Only)===
The caching of Picture images on the client is available. Whenever a picture is sent to a BR client the image is saved on the client along with its filename. If another reference is made to the same image (while caching is on), the cached image is used instead of re-forwarding the image to the client. A config statement can turn caching off or on:

 PICTURE CACHE_ON | CACHE_OFF 

The default is CACHE_ON

[[image:ConfigPic.png]]

This setting may be overridden on a case by case basis by specifying CACHE_ON or CACHE_OFF following the image filename, for example:

 00100 MYIMAGE$="mugshot.jpg,CACHE_OFF"  to temporarily override cache default
-or-
 00200 PRINT FIELDS "1,10,P 3/7,, 20" : "mugshot.jpg,CACHE_OFF"    ! temporarily overrides cache default

===Graphic_LineDraw===

{{:Graphic_LineDraw}}

===HelpDflt===

{{:HelpDflt}}

===Icon===

{{:Icon}}

===Include===

{{:Include}}

===Insert===

{{:Insert}}

===Keyboard===

{{:Keyboard}}

===Logging===

{{:Logging}}

===Login_Name$===

{{:Login_Name$}}

===@login_name===

{{:@Login_Name}}

===MaxRecall===
{{:MAXRECALL}}

===Max_Sort_Memory nn MB===

'''Max_Sort_Memory''' sets the maximum amount of work memory used for sorting and indexing. This prevents long sorting operations from dominating a workstation's memory.

===Non-GUI mode (4.15+)===

Non-GUI mode ignores GUI statements when they are encountered as of 4.15.

====Syntax====
 CONFIG GUI {ON|OFF}
[[Image:Gui.png]]

===Option===
{{:Option (Config)}}

===PageOflow===
{{:PAGEOFLOW (Config)}}

===PrintDir===

{{:PrintDir}}

===PRINTER===
{{:Printer}}

===Printer Initialization===
The maximum length of printer initialization strings has been expanded from 32 bytes to 64 bytes.


===PrintScreen===

{{:PrintScreen}}

===RD===

{{:RD}}

===Rem===
{{::Rem (config)}}

===RpnStack===

{{:RpnStack}}

===Screen===

{{:Screen}}

===SpoolCmd===

{{:SpoolCmd}}

===SpoolPath===

{{:SpoolPath}}

===StatusLine===
{{:Statusline}}

===Style===

{{:Style}}

===Substitute===

{{:Substitute}}

===TypeAhead===

{{:TypeAhead}}

===UserLevel===
{{:Userlevel}}

===WorkPath===

{{:WorkPath}}

===WorkStack===

{{:WorkStack}}

===WSID===

{{:WSID}}


<noinclude>
[[Category:Config]]
[[Category:Files]]
</noinclude>