BR Wiki - User contributions [en]

Encryption

2026-04-03T03:20:11Z

GomezL: Document Status Encrypt

(As of 4.30)

'''Encryption''' encompasses a number of different operations. These operations can be used independently or in combination to meet different needs. We use industry standard encryption available through OpenSSL. Three technologies are widely used for encrypting data. BR supports the first two listed below through its [[ENCRYPT]] and [[DECRYPT]] [[internal functions]].

==Overview of Two Encryption Methods==

1. '''Symmetric key ciphers''' – where the same key is used to encrypt and decrypt data. You can specify a key to encrypt some data and later use the same key to decrypt the data.

2. '''Hashing routines''' – one way routines that take data and convert it to a hash value. Sometimes these are thought of as checksums such as MD5 sum. Hash values are always the same length regardless of how big the hashed data is. A 10 gb file will have a hash result that is the same length as a 200 byte file. Hashing routines have a number of specific uses, including:
*Verify that data has not changed.
*Verifying that two files are the same.
*Validating passwords – this is based on the concept that if two values have the same hash value the values are equal. Using this technique improves security because it allows a server to store passwords in an unrecoverable format. Even the server software is unable to regenerate the original password. It is only capable of checking if the hash of a password matches the stored password hash.

==Symmetric Key Ciphers==
There are two encryption functions in the BR language, [[ENCRYPT$]] and [[DECRYPT$]].

ENCRYPT$(Data$ [,Key$ [,Encryption-type$ [,Initialization-vector$]]])
DECRYPT$(Data$ [,Key$ [,Encryption-type$ [,Initialization-vector$]]])

Data$ - The data to be encrypted

Key$ - The secret key to be used for encryption. If not specified this value will come from an OPTION 66 statement.

Encryption-type$ - The type of encryption to be done. If not specified, a common high strength encryption type will be employed. This is described in more detail below, but is generally only useful for interfacing with other typically non-BR programs.

Initialization-vector$ - This is an arcane part of encryption standards. It exists to prevent attackers from being able to tell whether the unencrypted data has changed. This is described in more detail below, but is general only needed when interfacing with other non-BR programs.

== Interfacing With Other Programs (encryption type and initialization vector)==
There are a number of different types of encryption that BR supports through OpenSSL: AES, BLOWFISH, DES, triple DES, RC4 and RC2. Most symmetric key ciphers are block ciphers meaning that they encrypt one block at a time. This means if you have a bit message, it is broken up into multiple blocks and each block is encrypted. The block size can be set as (128, 192, 256) bits. Some encryption types don't support all of these values so STATUS ENCRYPTION should be checked to see what encryption types are available in BR. Besides block size, there are also various schemes for blocking data. One might expect that using 256 bit blocking would simply take every 32 bytes and call it a block. This is not done though because there is a possibility that this would cause patterns in the encrypted data. To prevent this, there are various schemes known as codebooks which change the way data is blocked. Wikipedia explains this in more detail. If the encryption type is not specified AES:256:CBC:128 will be used. To be compatible with other programs the entire encryption type must be specified (cipher: key length: codebook: initialization vector length).

Initialization-vector – this is used to cause the same data encrypted with the same key to have a different encrypted result. This is significant because otherwise an attacker looking at data seeing the same encrypted result twice would know that the key and the unencrypted data have not changed. Regardless of whether or not you are concerned about this potential security issue, the standard encryption methods require this value so interfacing with other programs may require you to use it. It is a common practice to use a random number for this value and store the value at the beginning of (ahead of) the encrypted result. This is what BR does if this parameter is omitted.

As an example:
ENCRYPT$(“test”,“key”)
Produces a string containing “random number initialization vector”&”encrypted result”.

If the initialization vector is explicitly specified as in:
ENCRYPT$(“test”,“key”,“AES:256:CBC:128”,“RANDOM”)
the result would be simply “encrypted result”.

DECRYPT$ has the same arguments as ENCRYPT$ with the exception of the first parameter which is the encrypted data. DECRYPT$ expects to be used with the same key$, encryption-type$, and initialization-vector$ as was used to encrypt the data. As with ENCRYPT$, if key$ is not specified, the value from the OPTION statement will be used. If encryption-type$ is not specified, “AES:256:CBC:128” will be used. If the initialization vector is not specified, it will be assumed that the encrypted data starts with an initialization vector.

==Hashing Routines==
Three common forms of hashing are allowed in BR. They are MD5, SHA, and SHA-1. These are also provided through the ENCRYPT$ function specifying a null key$ value:

ENCRYPT$(data$, “”, “MD5”) ENCRYPT$(data$, “”, “SHA”) ENCRYPT$(data$, “”, “SHA-1”)

Hashing is also referred to as Message Digests or digests. This is what the MD in MD5 means. There is no way to restore data that has been hashed. Hashing is a one way function so DECRYPT$ will yield an error.

==Asymmetric Encryption==
Asymmetric key encryption is also known as public/private key encryption.

Public/private keys are created as a pair by a key generator. They are a pair, and it is not possible to have two public keys for the same private key or vice versa. With regard to public/private key pairs, what one key encrypts the other key can decrypt, and neither key can decrypt what it has encrypted. When a private key is used to encrypt data, the result is called a signature because everyone who has the public key can decrypt it.

This technique is used for:

Signing (using certificates) – A private key can be used to sign data. The result of such signing can be tested/validated with the corresponding public key.

Data encryption – A public key can be used to encrypt data. This data can then only be decrypted by the corresponding private key.

Hashes and signing are different but used together. Rather than signing a large block of data which would create a large signature, only the hash is signed to create much smaller fixed length signature data. When verifying a large block of signed data, the data is used to create a hash value and the hash value is compared to a decrypted signature.

Asymmetric encryption is not accessible through the BR ENCRYPT$, DECRYPT$ functions. However, it is used by our SSL client server connections and HTTPS. Certificates are most commonly used by SSL and HTTPS and are less useful for other application processes.

In the Client Server model the client knows the server’s public key and the server uses its private key to encrypt and decrypt. BRclient.exe connects to BRListener.exe by opening an SSL socket on the server using DHE_RSA-AES256-SHA Encryption. Handshaking is performed using a private key stored on the server within BRListener. Once authenticated, the socket is then passed to BRServer.exe for actual data processing.

Encryption is invoked by Business Rules HTTP support as follows:

CONFIG HTTPS port-number [ LOG file-pathname ] [CERT= cert-file-basename]
CONFIG OPTION 66 private-key-file-encryption-password
OPEN #400: “HTTP=SERVER”, DISPLAY, OUTIN

The BRSERVER executable directory must contain two files:

https-private.pem
https-cert.pem

These files are made by the following commands under Linux, MAC and cygwin for Windows: openssl req -new -x509 -out httpserver.pem -days 10000

(this will prompt for the OPTION 66 password)

mv privkey.pem https-private.pem
mv httpserver.pem https-cert.pem

This port specific service can then be accessed with browsers. When the specified port is accessed through a browser, BR establishes an HTTPS connection rather than an HTTP connection.

==Signing and Certificate Processing Industry Standards==
The purpose of certificates is to verify the authenticity of unencrypted data.

Certain companies are authorized by the government to act as a Certificate Authority (CA). These companies (e.g. Verisign) issue electronic certificates which can be used to issue second level certificates. Certificates can have expiration dates and the line of authority extends from a CA to any number of levels (but a chain is only as strong as its weakest link). Certificates contain a list of signatures (described below) that trace back to a CA as follows:

When a company needs to obtain a certificate from a CA, it prepares its own certificate and sends it to the CA for signature. Creating a certificate requires the pre-production of a private and public key pair. The certificate text properly identifies the signing authority, the owner of the certificate, and the owner’s public key. The signing authority externally verifies the identity of the owner before signing it. The CA provides the signature and the CA’s own public key for validating it.

Browsers know the CA identities and their public keys. A browser can verify a CA signed cert by hashing it, decrypting the signature with the known public key and matching the decrypted signature against the hash total.

Any company that is issued a (self-prepared authority signed) certificate by a CA can sign second level certificates issued to third parties. A second level cert contains the parent (CA issued) certificate, and includes the public keys of the issuer and the recipient. The signature is essentially the encrypted hash total of ‘itself plus all of its ancestors’. Additional levels each contain the chain of certificates leading from a CA issued cert to itself. By including public keys along with the identities of the owners, certificates become tools for validating the signatures of their owners. When signed data (with an encrypted hash total) is sent to clients the signatures insure that the data has not been altered along the way.

Ostensibly, a certificate cannot be counterfeited because it requires the signature of its parent which can only be produced with its parent’s private key. By providing both public keys ( signer and recipient ) in all certs along with signatures, a non-forgeable or alterable chain is established.

====Example:====
CA public key – known to browser
certificate 1 (signed by CA – contains owner’s public key)
certificate 2 (signed by second level - includes certificate 1 - contains owner’s public key)
final certificate (signed by third level - includes certificate 2 - contains owner’s public key)

A browser would find the CA information in the certificate and check to see if it is in the browser’s internal list. If not, it fails. Then it verifies that certificate 1 (which ends up being part of the final certificate) has been signed by the CA. After that it checks certificate 2 and verifies that it has been signed by the owner of certificate 1. Finally it checks the final certificate and verifies that it has been signed by the owner of certificate 2.

To assure the line authority of any certificate, the public keys are associated with signers, not with documents.

=='''Encryption Support by Version'''==

BR encryption support has evolved over time. The sections below distinguish between currently supported legacy algorithms, deprecated (removed) algorithms, and newer additions.

==Old List (Still Supported)==

The following algorithms are supported for backward compatibility and remain available in current versions:

===Symmetric Key Ciphers===
<pre>
DES (all modes)
DES-EDE / DES-EDE3 (Triple DES)
RC4 (40, 128)
RC2 (40, 64, 128)
BF (Blowfish)
CAST5
AES:128 / 192 / 256 (ECB, CBC, CFB, OFB)
IDEA
CAMELLIA:128 / 192 / 256
SEED
</pre>

===Message Digest Algorithms===
<pre>
MD5
SHA-1
MDC-2
RIPEMD-160
</pre>

==Deprecated (Removed / No Longer Available)==

The following algorithms were available in earlier versions but are no longer exposed in current builds:

<pre>
SHA (original / alias)
DSS
DSS-1
</pre>

These were removed due to obsolescence or lack of modern security relevance.

==In Development (Newer Additions)==

===Added in Version 4.31hdg===
<pre>
SHA-256
</pre>

==STATUS ENCRYPTION==

The command:

<pre>
STATUS ENCRYPTION
</pre>

displays the encryption and digest algorithms supported by the currently running BR executable. This is the authoritative source for determining which algorithms are available.

==Notes==

* Default encryption:
<code>AES:256:CBC:128</code>
* If no initialization vector is provided, BR prepends a random IV to the encrypted output.
* DECRYPT$ must use the same parameters as ENCRYPT$.

==Wishlist: Future Encryption Types==

The following modern algorithms are supported by OpenSSL but not currently exposed in BR:

* AES:128:GCM:96
* AES:192:GCM:96
* AES:256:GCM:96
* HMAC-SHA-256
* HMAC-SHA-512
* SHA-512
* ChaCha20-Poly1305
* PBKDF2 (password hashing)

<noinclude>
[[Category:Definitions]]
</noinclude>

MAX SORT MEMORY

2026-03-22T19:28:03Z

GomezL: /* Notes */

This [[CONFIG]] option sets the maximum memory allowed for SORT and INDEX operations ''(in megabytes)''. This is a [[BRconfig.sys]] statement.

=== Syntax ===

<pre>
MAX_SORT_MEMORY <integer> MB
</pre>

[[File:msm.png|400px]]

== Description ==

Specifies the maximum number of megabytes BR should use for sorting and indexing.

* Default: 8 MB
* Allowed range: 2–512 MB

== Example ==

<pre>
CONFIG MAX_SORT_MEMORY 512 MB
</pre>

== Notes ==

* The ``MB`` suffix is required after the integer value.
* This setting is a balance between CPU / Hard Disk Speed and available memory.
* Do not assume that bigger is better.
* 64 MB may be the sweet spot for your system.

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

MAX SORT MEMORY

2026-03-22T17:10:53Z

GomezL:

MAX SORT MEMORY

2026-03-22T17:09:26Z

GomezL: Document required MB and allowed values

This [[CONFIG]] option sets the maximum memory allowed for SORT and INDEX operations ''(in megabytes)''. This is a [[BRconfig.sys]] statement.

== Syntax ==

<pre>
MAX_SORT_MEMORY <integer> MB
</pre>

[[File:msm.png|400px]]

== Description ==

Specifies the maximum number of megabytes BR should use for sorting and indexing.

* Default: 8 MB
* Allowed range: 2–512 MB

== Example ==

<pre>
CONFIG MAX_SORT_MEMORY 512 MB
</pre>

== Notes ==

* The ``MB`` suffix is required after the integer value.

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

^KeyStroke and ^DataChg

2026-02-05T19:46:32Z

GomezL: Show Sample for ^DataCHG

As of [[4.30]], two new [[INPUT FIELDS]] field attributes are now supported which provide detailed control of user input:
*^KEYSTROKE - return control to the program when a keystroke is entered
*^DATACHG - return control to the program when data is changed
(a subset of ^KEYSTROKE)

When control is returned to a program as a result of these attributes, one of three new [[Fkey]] values is applied:

*140 - a character was appended to the data
*141 - the data changed other than appending a character
*142 - ( applies only to ^KEYSTROKE ) the data is unchanged but a key was pressed or a mouse action occurred that did not trigger a field exit

When a key is pressed with ^KEYSTROKE or ^DATACHG that sets a 140, 141 or 142 FKEY, it will also set the [[KStat$]] value. This allows the program to see what key was pressed. This KSTAT$ value will be cleared on the next [[RINPUT Fields]] operation.

If a navigation key operates within the field and ^KEYSTROKE is specified, it triggers fkey 142. If the navigation key causes focus to leave the field, fkeys 140-142 are not generated and KSTAT is not set.

===Sample===
00001 PRINT Newpage
00010 INPUT FIELDS "10,10,C 10,[D]S^DataCHGC"&Str$(New_Pos),ATTR '[A]': Dummy$
00020 PRINT FIELDS "1,70,n 10": Fkey
00025 LET New_Field$=Kstat$
00026 LET New_Pos=Curpos
00030 PRINT FIELDS "3,70,N 10": New_Pos
00040 PRINT FIELDS "4,70,C 10": Unhex$(New_Field$)&" "&New_Field$
00050 PRINT FIELDS "5,70,C 10": Dummy$
00090 LET Curfld(Curfld,Fkey) !:
GOTO 10

The program triggers ^DATACHG and displays the FKEY along with the value that was pushed to KSTAT$. Each keystrokeis processed. The input allows granular control.

;Note
While shift, control and alt do not change either the functionality or fkey value of navigation keys, KSTAT$ produces unique values for each of these settings. This complicates things a bit but provides more options for programmed responses to custom key combinations.

<noinclude>
[[Category:All Parameters]]
</noinclude>

DEBUG PROFILE

2025-09-12T17:23:21Z

GomezL: /* Additional resources */

= BR Profiler Main Page =

Use '''PROFILER.EXE''' to translate the BR Profiler output file into readable text.

== Generating profiler output ==

<pre>
DEBUG PROFILE SAMPLED filename
DEBUG PROFILE TIMED filename
DEBUG PROFILE STOP
</pre>

== Viewing profiler output ==
Use '''profiler.exe''' to view the contents of a log file:

<pre>
profiler.exe filename
profiler.exe filename raw
</pre>

== Additional resources ==

* See the FTP site: ''Dll_Distr/Profiler'' for samples and documentation.
* [[Profiler File Layout]] — Detailed description of the profiler log file format.

<noinclude>
[[Category:Debug]]
[[Category:Profiler]]
[[Category:Tools]]
</noinclude>

DEBUG PROFILE

2025-09-12T17:22:55Z

GomezL:

= BR Profiler Main Page =

Use '''PROFILER.EXE''' to translate the BR Profiler output file into readable text.

== Generating profiler output ==

<pre>
DEBUG PROFILE SAMPLED filename
DEBUG PROFILE TIMED filename
DEBUG PROFILE STOP
</pre>

== Viewing profiler output ==
Use '''profiler.exe''' to view the contents of a log file:

<pre>
profiler.exe filename
profiler.exe filename raw
</pre>

== Additional resources ==

* See the FTP site: ''Dll\_Distr/Profiler'' for samples and documentation.
* [[Profiler File Layout]] — Detailed description of the profiler log file format.

<noinclude>
[[Category:Debug]]
[[Category:Profiler]]
[[Category:Tools]]
</noinclude>

Profiler File Layout

2025-09-12T17:14:40Z

GomezL:

= Profiler Output File Format =

The profiler output file will be a sequence of variable-length records of various types. The first byte of each record provides the record type, while the length and record information are record-type specific. All numbers are in '''network byte order'''.

== CREATE MODULE MAPPING ==

* '''Byte 1:''' 1
* '''Byte 2–3:''' 16-bit module number
* '''Byte 4–5:''' 16-bit File Name Length
* '''Byte 6–end:''' File Name

== CURRENT LINE ==
Current line information begins with this record and ends with an '''END CURRENT LINE''' record.

* '''Byte 1:''' 3
* '''Byte 2–3:''' module number
* '''Byte 4–7:''' line number
* '''Byte 8:''' clause number

== TIME SPENT IN LINE ==
These records exist only for timed sampling. They always occur between '''CURRENT LINE''' and '''END CURRENT LINE'''.

* '''Byte 1:''' 4
* '''Byte 2–9:''' 8-byte time spent in line (nanoseconds)

== BACKTRACE INFORMATION ==
These records may or may not exist depending on creation options. They always occur between '''CURRENT LINE''' and '''END CURRENT LINE'''.

Note: Apart from the record type identifier, these records have the same format as '''CURRENT LINE'''.

* '''Byte 1:''' 5
* '''Byte 2–3:''' module number
* '''Byte 4–7:''' line number
* '''Byte 8:''' clause number

== FUNCTION NAME ==
These records may or may not exist depending on creation options. They follow immediately after either '''CURRENT LINE''' or '''BACKTRACE INFORMATION'''.

* '''Byte 1:''' 7
* '''Byte 2:''' 8-bit name length
* '''Byte 3–on:''' function name

== GOSUB ==
These records may or may not exist depending on creation options. They follow immediately after either '''CURRENT LINE''' or '''BACKTRACE INFORMATION'''.

* '''Byte 1:''' 8

== MAIN ROUTINE ==
These records may or may not exist depending on creation options. They follow immediately after either '''CURRENT LINE''' or '''BACKTRACE INFORMATION'''.

This indicates that the given line is neither in a GOSUB nor in a function body.

* '''Byte 1:''' 9

== END CURRENT LINE ==

* '''Byte 1:''' 6

= Potential Syntax =

* <code>DEBUG PROFILE SAMPLED filename</code>
* <code>DEBUG PROFILE TIMED filename</code>
* <code>DEBUG PROFILE STOP</code>

== Profiler.exe ==
To use the profiler.exe available on the ftp site in /Dll_Distr/profiler to get a nice listing of what is in the log file use.
* profiler.exe filename
or
* profiler.exe filename raw

Profiler File Layout

2025-09-12T17:10:42Z

GomezL:

Profiler File Layout

2025-09-12T17:01:59Z

GomezL: Created page with "The profiler output file will be a sequence of variable length records of various types. The first byte of each record will provide the record type, the length and record information will be record type specific. All numbers are network byte order. CREATE MODULE MAPPING Byte 1: 1 Byte 2-3: 16 bit module number Byte 4-5: 16 bit File Name Length Byte 6-end: File Name CURRENT LINE Current line information is started with this record and will be ended with a END CURRENT..."

The profiler output file will be a sequence of variable length records of various types. The first byte of each record will provide the record type, the length and record information will be record type specific. All numbers are network byte order.

CREATE MODULE MAPPING
Byte 1: 1
Byte 2-3: 16 bit module number
Byte 4-5: 16 bit File Name Length
Byte 6-end: File Name

CURRENT LINE
Current line information is started with this record and will be ended with a END CURRENT LINE
record
Byte 1: 3
Byte 2-3: module number
Byte 4-7: line number
Byte 8: clause number

TIME SPENT IN LINE
these records will only exist for timed sampling
they will always occur between CURRENT LINE and END CURRENT LINE
Byte 1: 4
Byte 2 – 9: 8 bit time spent in line in nano-seconds.

BACKTRACE INFORMATION
these records may or may not exist depending on creation options
they will always occur between CURRENT LINE and END CURRENT LINE
Note: besides the record type identifier, these records have the same format as CURRENT LINE
Byte 1: 5
Byte 2-3: module number
Byte 4-7: line number
Byte 8: clause number

FUNCTION NAME:
These records may or may not exist depending on creation options.
These records will follow immediately after either CURRENT LINE or BACKTRACE INFORMATION
Byte 1:7
Byte 2: 8-bit name length
Byte 3- on: function name

GOSUB:
These records may or may not exist depending on creation options.
These records will follow immediately after either CURRENT LINE or BACKTRACE INFORMATION
Byte 1:8

MAIN ROUTINE:
These records may or may not exist depending on creation options.
These records will follow immediately after either CURRENT LINE or BACKTRACE INFORMATION
This indicates that the given line is neither in a GOSUB or in a function body.
Byte 1:9

END CURRENT LINE
Byte 1: 6

Potential syntax

DEBUG PROFILE SAMPLED filename
DEBUG PROFILE TIMED filename
DEBUG PROFILE STOP

DEBUG PROFILE

2025-09-12T17:01:43Z

GomezL:

Use PROFILER.EXE to translate the BR Profiler output file into readable text.

To generate profiler output:
DEBUG PROFILE SAMPLED filename
or
DEBUG PROFILE TIMED filename
and
DEBUG PROFILE STOP to end the profile

Also, to use the profiler.exe to get a nice listing of what is in the log file.
profiler.exe filename
or
profiler.exe filename raw

See ftp site Dll_Distr/Profiler for samples and documentation.

[[Profiler File Layout]] -- Details about the profiler log

<noinclude>
[[Category:Debug]]
</noinclude>

DEBUG PROFILE

2025-09-12T17:00:26Z

GomezL:

DEBUG PROFILE

2025-09-12T16:57:29Z

GomezL: Created page with " Use PROFILER.EXE to translate the BR Profiler output file into readable text. To generate profiler output: DEBUG PROFILE SAMPLED filename or DEBUG PROFILE TIMED filename and DEBUG PROFILE STOP to end the profile Also, to use the profiler.exe to get a nice listing of what is in the log file. profiler.exe filename or profiler.exe filename raw See ftp site Dll_Distr/Profiler for samples and documentation."

Debug

2025-09-12T16:56:13Z

GomezL:

see also: [[BR32.exe Debug]]

There are many [[commands]], [[statements]], [[debuggers]], etc that will help you to '''debug''' a [[Business Rules!]] [[program]].

Some [[editors]] such as [[MyEdit (BR Edition)]] provide an vast array of their own tools for use in debugging.

Debug versions of BR32.exe are used almost exclusively during the [[beta]] process of upcoming versions of Business Rules!.

Other than functions in the [[:Category:Debug|debug category]], the [[Go]] [[command]] can be very useful for debugging programs

The '''DEBUG CONSOLE OFF''' command is supported as of BR [[4.18a]].

[[DEBUG PROFILE]] -- Used to create Itemized Profile log file for troubleshooting performance.

<noinclude>
[[Category:Debug]]
[[Category:Needs Help]]
</noinclude>

-202,020,202.02

2025-06-05T12:57:41Z

GomezL:

[[PD]] is a Packed Decimal.

PD 6.2 can store +/ 999,999,999.99

'''-202,020,202.02''' is the value read from an empty, never written, [[PD]] '''6.2''' field.

[[Category:Number]]

SQL

2025-05-23T15:48:50Z

GomezL:

SQL manages data via a relational data management system. As of 4.3, BR includes several special ways of working together with SQL.

====CONFIG DATABASE db-ref ODBC-MANAGER====
CONFIG [[DATABASE]] db-ref ODBC-MANAGER will invoke the ODBC Manager to define or identify a file DSN. Once this is done you can issue the command [[STATUS]] DATABASE –P to see the connect string that the ODBC Manager used to make the connection. Thereafter you can use that connection string to establish the connection to the database as follows:

CONFIG DATABASE db-ref CONNECTSTRING="Driver={Microsoft Access Driver (*.mdb)}DBQ=C:\inetpub\wwwroot\BegASP\Chapter.14\Contact.mdb"
- or -
CONFIG DATABASE db-ref DSN=’dsn-ref ‘

;Additional Optional Parameters:

[, USER= department | LOGIN_NAME | ? ]
[, {PASSWORD= dept-password | PASSWORDD=encrypted-passwd | BR_PASSWORD | ? ]

Where '''?''' indicates prompt and '''BR_PASSWORD''' indicates the password used during client login. If running the standard model (not client-server) then this is equivalent to "?". '''encrypted-passwd''' is the DB password encrypted with the key stated in OPTION 66.

'''CONFIG DATABASE MAX_COLUMN_WIDTH nnnn'''
Some database column types are variable length. SQL requires advanced buffer allocation. This would unnecessarily tax the system if not restricted. This statement sets a maximum width for all columns. Memory is allocated to the minimum of (this amount or the column width). "nnnn" is the maximum column width. The default is 2000 characters.

''''CONFIG DATABASE CLEAR { db-ref | ALL }'''
This will close the specified database or all open databases.

'''Sample Connection Strings:'''

Using a SQL Server /w SQL Login:
CONFIG database db-ref connectstring="DRIVER=SQL Server;SERVER=server;Initial Catalog=database;UID=username;PWD=password"
db-ref is the database reference.
server is the SQL Server [FQDN] or IP Address
database is the [SQL Server Database]
username is the [SQL Server User Name]
password is the [SQL Server Password]

Using a SQL Server /w Windows Authentication:
CONFIG database db-ref connectstring="DRIVER=SQL Server;Initial Catalog=database;Persist Security Info=True;MultipleBC_TableResultSets=True; Database=database;SERVER=server;Login Name=username;Password=BR_PASSWORD"
db-ref is the database reference.
server is the SQL Server [FQDN] or IP Address
database is the [SQL Server Database]
username is the [SQL Server User Name]
Note that BR_PASSWORD will use the users Active Directory password to connect to the SQL Server.
Note that "SQL Server" is one of several choices for SQL Server, another choice would be SQL Server Native Client 11.0

====OPEN statements====

OPEN #20: "DATABASE= db-ref", SQL "sql-statement", OUTIN
- or -
OPEN #20: "DATABASE= db-ref, Name= filename" , SQL, OUTIN
Where filename refers to a DISPLAY file containing a SQL statement that gets executed when a WRITE statement is processed.

Example:
OPEN #20: "DATABASE=MyData",SQL "SELECT FILENO,BALANCE from MASTER WHERE FILENO=?",OUTIN

====Sequence of Operations====
#Begin processing with a WRITE statement.
#If the WRITE contains an IO list of values then it is used to populate the SQL before it is executed. In this process IO list values replace question marks positionally from left to right. These question marks only work with SQL arguments that refer to stored data. Question marks cannot be specified where SQL keywords or table column names appear.
#Resulting SQL may or may not produce a result set. If it does, the result set may be processed like a BR file opened RELATIVE. Some operations that use file positioning may be slow since the whole result set may not be in memory immediately. Simple sequential access should be fairly quick.
#Once SQL has been populated by an IOlist, it may be reused with the same values by issuing a WRITE with no IOlist.
#READ IOlist variable associations are positional with each READ accessing one row of values.

===SQL read/write example===

00001 execute "CONFIG database Inventory connectstring=""DRIVER=SQL Server;SERVER=COMPUTER;Initial Catalog=Inventory;Integrated Security=True;Persist Security Info=False;Pooling=False;MultipleActiveResultSets=False;Encrypt=False;TrustServerCertificate=True"""
00002 let sqlconnection = 1
00003 ! READ test
00004 open #sqlconnection: "DATABASE=Inventory",SQL "SELECT [Name],[Address],[City],[Country],[DateOfBirth],[Age] FROM [Inventory].[dbo].[Customer]",OUTIN
00005 write #sqlconnection:
00006 do
00007 read #sqlconnection, using 'form POS 1,C 50,C 50,C 50,C 50,C 50,N 3': Name$,Address$,City$,Country$,DateOfBirth$,Age eof ignore
00008 ! if EOF was encountered, then we are finished reading the result set
00009 if file(sqlconnection)<>0 then exit do
00010 let dob$ = ""
00011 ! only convert SQL date to BR date if it is non-empty, otherwise BR_DATE$ bombs
00012 if DateOfBirth$<>"" then
00013 let dob$ = BR_DATE$(DateOfBirth$)
00014 end if
00015 ! show user the next result row
00016 print Name$,Address$,City$,Country$,dob$,Age
00017 loop
00018 close #sqlconnection:
00019 !
00020 ! WRITE test
00021 open #sqlconnection: "DATABASE=Inventory",SQL "insert into [Inventory].[dbo].[Customer] ([Id],[Name],[Address],[City],[Country],[DateOfBirth],[Age]) values (6,'Tom, Jerryngton', '123 Big Walkway', 'Dallas', 'USA', '1982-01-01', 35);",OUTIN
00022 write #sqlconnection:
00023 close #sqlconnection:

===SQL Date Format Functions===

A$=SQL_DATE$(BR-date-string,"format-mask") ! format date for storage
B$=BR_DATE$(SQL-date-string,"format-mask") ! unpack DB date value

* Note: SQL DATETIME fields are "Packed for Storage", but "DATE" fields are returned as a CCYY-MM-DD string in a SQL Query. DATE returns "BLANK" for "Empty or Null Date"

===SQL Table Interrogation===

'''ENV$(STATUS)''' has been extended to interrogate database connections and ODBC data sources. A program called ENVDB.BRS (listed below) has been written to demonstrate how this extension works and to show how to setup linkage to a database or ODBC data source. Run the program as is to bring up the Microsoft ODBC manager. Then select a data source and look at the output from the program. This will also show you how to get and use connect strings. In this example lines 1900 and 2000 accomplish the same open as line 1800 in my environment.

Try it on your Windows workstation. As long as you have one or more ODBC drivers supported you can use it without having to install a database. You can even use it to interrogate Excel files because Microsoft provides an ODBC driver for that.

A sample program to demonstrate database interrogation entry is:
01000 ! Replace Envdb
01100 dim DATABASES$(1)*100
01200 dim DATABASE$*100
01300 dim TABLES$(1)*100
01400 dim TABLE$*100
01500 dim COLUMNS$(1)*100
01600 dim COLUMN$*100
01700 dim C$*100,FLD1$*40,FLD2$*40,FLD3$*40,FLD4$*40
01800 Execute "CONFIG database testdb odbc-manager"
01900 ! Execute "CONFIG database testdb DSN='Accounts Payable'"
02000 ! Execute "CONFIG database testdb connectstring=""DSN=Excel Files;DBQ=L:\orders\Beneficial PORCEL.xls;DefaultDir=L:\orders;DriverId=1046;MaxBufferSize=2048"""
02100 open #1: "name=envdb.txt,replace",display,output
02200 Dump_Table: ! ***** Dump Table Layout
02300 let OUTFD = 1
02400 let ENV$("status.database.LIST", MAT DATABASES$) !List of db's
02500 for DATABASE=1 to UDIM(DATABASES$) !For each connected database
02600 let DATABASE$=DATABASES$(DATABASE)
02700 let FNSHOW_DATABASE(DATABASE$, "status.database."&DATABASE$)
02800 next DATABASE
02900 end
03000 !
03100 def FNSHOW_DATABASE(DATABASE$*100, ST_PREFIX$*100)
03200 print #OUTFD: DATABASE$
03300 let OUT_PREFIX$=CHR$(9)
03400 print #OUTFD: OUT_PREFIX$&"DSN="&ENV$(ST_PREFIX$&".DSN")
03500 print #OUTFD: OUT_PREFIX$&"CONNECTSTRING="&ENV$(ST_PREFIX$&".CONNECTSTRING")
03600 print #OUTFD: OUT_PREFIX$&"Tables:"
03700 let ST_PREFIX$=ST_PREFIX$&".TABLES"
03800 let ENV$(ST_PREFIX$&".LIST", MAT TABLES$)
03900 for TABLE = 1 to UDIM(MAT TABLES$)
04000 let TABLE$=TABLES$(TABLE)
04100 let FNSHOW_TABLE(TABLE$,ST_PREFIX$&"."&TABLE$,OUT_PREFIX$&CHR$(9))
04200 next TABLE
04300 fnend
04400 !
04500 def FNSHOW_TABLE(TABLE$*100, ST_PREFIX$*100, OUT_PREFIX$)
04600 print #OUTFD: OUT_PREFIX$&TABLE$
04700 let OUT_PREFIX$=OUT_PREFIX$&CHR$(9)
04800 print #OUTFD: OUT_PREFIX$&"Table remarks="&ENV$(ST_PREFIX$&".REMARKS")
04900 print #OUTFD: OUT_PREFIX$&"Table type="&ENV$(ST_PREFIX$&".TYPE")
05000 print #OUTFD: OUT_PREFIX$&"Columns:"
05100 let ST_PREFIX$=ST_PREFIX$&".COLUMNS"
05200 let ENV$(ST_PREFIX$&".LIST", MAT COLUMNS$)
05300 for COLUMN = 1 to UDIM(MAT COLUMNS$)
05400 let COLUMN$=COLUMNS$(COLUMN)
05500 let FNSHOW_COLUMN(COLUMN$, ST_PREFIX$&"."&COLUMN$,OUT_PREFIX$&CHR$(9))
05600 next COLUMN
05700 fnend
05800 !
05900 def FNSHOW_COLUMN(COLUMN$*100, ST_PREFIX$*100, OUT_PREFIX$)
06000 print #OUTFD: OUT_PREFIX$&COLUMN$
06100 let OUT_PREFIX$=OUT_PREFIX$&CHR$(9)
06200 print #OUTFD: OUT_PREFIX$&"Column type="&ENV$(ST_PREFIX$&".TYPE")
06300 print #OUTFD: OUT_PREFIX$&"Column length="&ENV$(ST_PREFIX$&".LENGTH")
06400 print #OUTFD: OUT_PREFIX$&"Column decimals="&ENV$(ST_PREFIX$&".DECIMALS")
06500 fnend

===Other===
For more information about '''SQL''' or '''Structured Query Language''' see [[Wikipedia:SQL]].

===CLIENT_SERVER RECONNECT===
You can modify WBCONFIG.SYS or execute in code.

Sample:
EXECUTE "CONFIG CLIENT_SERVER RECONNECT_AFTER=120 RECONNECT_TIME=120"

The default 120 is two minutes; set the values to 99999 to wait 27 hours (infinity).

Please remember that the BRServer.exe components will remain "Active" in the server's task manager until the timeout period has passed.

When executing a SQL command, Client Server "appears to be hung" waiting for a response. if you reach the limit (IE 120 seconds), BRClient will believe it has timed out, and "Crash".

===SQL LOCK_TIMEOUT===
In SQL, [LOCK_TIMEOUT] instructs the SQL Server session to wait a certain number of seconds before returning an error.

* The default value is -1
* 120 is a reasonable value, and it works in tandem with CLIENT_SERVER RECONNECT.

Sample Code to set the [LOCK_TIMEOUT] settings:

Call the function providing the SQL Connection Name and the desired timeout.

If there is a blocking transaction, that transaction will trigger an error 3006 with SQL State of "42000"

Sample Function:
64230 DEF FNSET_LOCK_TIMEOUT(SLT_Connection$,SLT_Timeout)
64232 DIM SLT_SQL$*9999
64234 SLT_SQL$="SET LOCK_TIMEOUT "&str$(SLT_Timeout)
64236 OPEN #(Updhandle=Fngethandle): "DATABASE="&SLT_Connection$,SQL SLT_SQL$,OUTIN
64238 WRITE #Updhandle:
64240 CLOSE #Updhandle:
64242 FNEND

<noinclude>
[[Category:Terminology]]
[[Category:SQL]]
</noinclude>

Editor

2025-04-20T15:29:22Z

GomezL: /* Known Third Party Editors */

Many editors are supported for BR! [[Source code]].

The purpose of the EDITOR statement is to identify the program used by the [[EDIT]] command.

Editor "editor-program" [ REMOVE ] [NOWAIT]

While the '''Editor''' specification is normally placed within a BRCONFIG.SYS file, it can also be specified with the [[config|Config]] command or within a program line using the [[Execute]] statement to issue the Config command.

====Examples====
An Editor Statement could be typed in the command console like:

Config Editor "C:\Program Files\NotePad++\NotePad++.exe"

Or added to [[BRConfig.sys]] like:

Editor "C:\Program Files\NotePad++\NotePad++.exe"

Or perhaps added to BRConfig.sys, but only applicable to an individual user (Herbert) like:

@"Herbert" Editor "C:\Program Files\Mills Enterprise\MyEditBR\MyEditBR.exe"

 

REMOVE and NOWAIT affect the way the EDIT command uses the editor program. REMOVE causes BR to remove the source file when editing is complete.

====See also====

*[[Edit]]
*[[wikipedia:comparison_of_text_editors]].

 

====Known Third Party Editors====

These editors can process .wbs/.brs [[Business Rules! Editable Source]] code.

*NotePad
*[[PFE32]]
*[http://www.textpad.com/ TextPad]
*[[My Edit BR]]
*[http://www.mills-enterprise.ca MyEditBR website]
*[http://www.brixoft.net/prodinfo.asp?id=1 Source Edit]
*[[EditPad Pro]]
*[[Notepad++]] (open source)
*[http://www.ultraedit.com/ UltraEdit]
*[https://sourceforge.net/projects/jedit/ JEdit] (open source)
*[http://www.crimsoneditor.com Crimson Editor] (open source)
*[http://www.lugaru.com/ Epsilon]
*[http://www.context.cx/ ConTEXT]
*[http://www.andre-simon.de/ WinHighlight]
*[http://editra.org/index.php Editra]
*[https://www.cursor.com/ Cursor]

<noinclude>
[[Category:Utilities Third Party]]
[[Category:Config]]
[[Category:Basics]]
[[Category:Needs Help]]
</noinclude>

0317

2025-03-03T15:17:22Z

GomezL:

{{Error
|0317
|attempt to [[redimension]] an [[array]] that is already on the [[RPN stack]]
|attempt to redimension an array that is already on the RPN stack
This error was added in BR! version [[4.2]].

The following program demonstrates the error. Remember that X & Y are the same array in this example, and you cannot assign the results of FN_Y to the same array.

00010 dim x(10)
00020 let '''x(1)<nowiki>=</nowiki>'''fn_y(mat x)
00030 end
00040 def fn_y(mat y)
00060 mat y(1)
00070 let y(1)<nowiki>=</nowiki>123
00080 let fn_y<nowiki>=</nowiki>y(1)
00090 fnend

|Type [[GO]] and hit enter to continue.

You can solve the above example like this becomes 1:
00010 dim x(10),
00020 let temp<nowiki>=</nowiki>fn_y(mat x)
00025 let x(1)<nowiki>=</nowiki>temp
00030 end
00040 def fn_y(mat y)
00060 mat y(1)
00070 let y(1)<nowiki>=</nowiki>123
00080 let fn_y<nowiki>=</nowiki>y(1)
00090 fnend

Another alternative Becomes 123:

00010 dim x(10),
00020 let fn_y(mat x)
00030 end
00040 def fn_y(mat y)
00060 mat y(1)
00070 let y(1)<nowiki>=</nowiki>123
00080 let fn_y<nowiki>=</nowiki>y(1)
00090 fnend

}}
[[Category:Error Codes]]

0317

2025-03-03T15:14:38Z

GomezL:

{{Error
|0317
|attempt to [[redimension]] an [[array]] that is already on the [[RPN stack]]
|attempt to redimension an array that is already on the RPN stack
This error was added in BR! version [[4.2]].

The following program demonstrates the error. Remember that X & Y are the same array in this example, and you cannot assign the results of FN_Y to the same array.

00010 dim x(10)
00020 let '''x(1)<nowiki>=</nowiki>'''fn_y(mat x)
00030 end
00040 def fn_y(mat y)
00060 mat y(1)
00070 let y(1)<nowiki>=</nowiki>123
00080 let fn_y<nowiki>=</nowiki>y(1)
00090 fnend

|Type [[GO]] and hit enter to continue.

You can solve the above example like this: (X(1)=1)

00010 dim x(10),
00020 let temp<nowiki>=</nowiki>fn_y(mat x)
00025 let x(1)<nowiki>=</nowiki>temp
00030 end
00040 def fn_y(mat y)
00060 mat y(1)
00070 let y(1)<nowiki>=</nowiki>123
00080 let fn_y<nowiki>=</nowiki>y(1)
00090 fnend

Another alternative: (X(1)=123)

00010 dim x(10),
00020 let fn_y(mat x)
00030 end
00040 def fn_y(mat y)
00060 mat y(1)
00070 let y(1)<nowiki>=</nowiki>123
00080 let fn_y<nowiki>=</nowiki>y(1)
00090 fnend

}}
[[Category:Error Codes]]

BRSerial.dat

2024-03-04T15:52:46Z

GomezL:

The '''BRSerial.dat''' file contains your [[Business Rules!]] license information. You can easily check the license information contained in this file by using [[CheckSerial.exe]].

You may Rename BRSerial.dat to BrSerial.[BR Version] such as BRSerial.42 or BRSerial.43.

[[UserID$]]
<noinclude>
[[Category:Files]]
</noinclude>

BRSerial.dat

2024-03-04T15:52:01Z

GomezL:

The '''BRSerial.dat''' file contains your [[Business Rules!]] license information. You can easily check the license information contained in this file by using [[CheckSerial.exe]].

You may Rename BRSerial.dat to BrSerial.[BR Version] such as BRSerial.42 or BRSerial.43.

<noinclude>
[[Category:Files]] [[UserID$]]
</noinclude>

Sort Facility

2023-06-09T19:58:33Z

GomezL: Sort expanding on A vs B for "Address Out"

Business Rules sort facility allows you to produce a sorted output file from a randomly ordered file of records, and to rearrange the records in a variety of ways.

A simple [[Index and Sort facilities Tutorial#Basic Overview of SORT|Sort Tutorial]] is now available.

==Sort Command==
The SORT command is the instruction that tells BR to begin the sorting procedure. Its only parameter is an optional control file name that contains all the specifications about how a particular file, or set of files, is to be sorted.

BR will execute the SORT command in any of the following 3 ways:

#From READY mode. When followed by the name of the sort control file, SORT can be executed from READY mode.
#From a procedure file. When followed by either a sort control file name or by the specifications that make up a single sort group, SORT can be executed from a procedure file.
#With the EXECUTE statement. When the name of the sort control file is included, SORT may be specified by the EXECUTE statement.

BR SORT facility allows you to produce a sorted output file from a randomly ordered file of records, and to rearrange the records in a variety of ways.

===Comments and Examples===
The following example causes the sort specifications in ALPHABET.FIL to be executed (when ALPHABET.FIL is a sort control file in the form of an internal file):
SORT ALPHABET.FIL

Alternatively, and more easily edited sort control files can be created as [[PROC]] files. For example:
PROC SAMPLESORT

This command will run the procedure file SAMPLESORT, which begins with the SORT command, and contains all the sort control information. The SAMPLESORT procedure file might look like this:

Sort
! Creating a sort file, don't you worry!
FILE orders.int,,,samplesort2,,,,,R,,REPLACE,SHR
ALTS RO 1,"VERYQUICKFOX"
RECORD I,106,2,C,"TX","TX",OR
RECORD I,106,2,C,"LA","LA",OR
RECORD I,106,2,C,"tx","tx",OR
RECORD I,106,2,C,"la","la",OR
SUM
MASK 31,30,C,A,1,30,C,A

SORT tells BR to run a sort as the first step of the procedure. The comment will show up on the operator's screen. Only FILE and MASK are required. Each parameter will be described in detail below, but this particular SORT will return a file named samplesort2 of the data in the ORDERS.INT file, containing only the customer information from Texas and Louisiana arranged alphabetically according to "VERYQUICKFOX". Commas are necessary when skipping optional parameters within each line.

===Syntax===
SORT [<[[Sort control file|control file]]>]
[[Image:Sort.png]]

===Defaults===
1.) Look to the next lines in the procedure file for the sort specifications.

===Parameters===
The "control file" parameter specifies the name (and path, if required) of the sort control file to be executed. The sort control file contains up to six different types of specifications:
# COMMENT (use ! as the first character of a comment)
# FILE
# ALTS
# RECORD
# SUM
# MASK

FILE and MASK are required, others are optional.

The use of SORT without a control file-ref can only be done from within a procedure. All required sort specifications must then immediately follow the SORT command. (See [[Sort Facility]] for more information).

Sort control files can be created in a text editor as a procedure file, or as an internal file using WRITE. The simplest way is using a procedure file, since you can easily view and edit the file.

===Technical Considerations===
The '''Sort''' command performs a [[Clear]] operation (unless a program is active) and begins execution of the SORT control file. The number of RECORD specifications that may be used in sort control files is 20.

A user-defined collating sequence may be accessed through the FILE specification's collating sequence parameter. See [[COLLATE ALTERNATE]] in [[BRConfig.sys]] for more information.

==Types of Sort Specifications==

Six different types of sort specifications are allowed in each sort group. FILE and MASK are required. The following table summarizes some information about the sort specifications:

[[Image:SortSpecs.png]]

Below are six sections describing each SORT specification in detail.

===Comment===

The optional Comment (!) specification displays a message to the operator on the screen. Usually it's a description of the current sort. Comments appear exactly as you enter them.

====Comments and Examples====
BR displays up to twenty lines worth of Comments per sort group. Comments or Comment lines exceeding this amount are ignored. If a Comment is longer than 43 characters, it will wrap to the next line on the screen. The following is an example of SORT's Comment:

! Now sorting customer file

====Syntax====

[[Image:SortComment.png]]

====Parameters====
After the required '''!''' symbol, you mat include an optional message.

'''Message''' is the information to be displayed on the screen exactly as it is entered.

====Technical Considerations====

1) Comment specifications may be placed anywhere before the MASK specification in the sort group.

===SUM===

SUM is an optional specification that causes BR to display a summary of record counts after a file has been sorted. The way the titles are displayed is currently under development.

====Comments and Examples====

SUM should be used only when an operator will be in attendance during the sort, as execution will not continue between sort groups until <ENTER> has been pressed.

SUM displays three record counts:
# the total number of records in the input file not including deleted records.
# the number of records that were included in the sort.
# the number of records that were written to the output file.

The following example replaces the first and last messages printed by the SUM specification. The "Records read" and "Records selected" titles are left unchanged, but the single space in the fourth position causes the title for "Records output" to be omitted.

SUM Sort of HIST.FIL completed,,, ,Press <CR> to continue

====Syntax====

[[Image:SortSum.png]] 

====Defaults====
#Display "Sort successfully completed."
#Display "Records read"
#Display "Records selected"
#Display "Records output"
#Display "Press any key to continue."

====Parameters====
{|
|-valign="top"
|width="90"|'''Title1'''||is a replacement for the message "Sort successfully completed", which will automatically be displayed unless you specify otherwise.
|-valign="top"
|width="90"|'''Title2'''||is a replacement for the title "Records read". Unless you specify otherwise, BR displays this title next to a count of the total number of records read from the input file.
|-valign="top"
|width="90"|'''Title3'''||is a replacement for the title "Records selected". Unless you specify otherwise, BR displays this title next to the total number of records, which were included in the sort.
|-valign="top"
|width="90"|'''Title4'''||is a replacement for the title "Records output", which is displayed next to the total number of records that were written to the output file.
|-valign="top"
|width="90"|'''Title5'''||is a replacement for the message "Press Enter to continue", which is automatically displayed unless you specify otherwise.
|-valign="top"
|}

====Technical Considerations====

#To entirely suppress a message, enter a space for the title. There is no way to suppress record counts when SUM is specified.
#BR truncates any title parameter, which is longer than 70 characters.
#The number of records selected displayed on the third line and the number of records output displayed on the fourth line should always be the same.

===FILE===

The FILE specification is a required specification that identifies the following:
#Names of input and output files.
#Directory for workspace.
#Type of output file.
#Desired collating sequence.
#Optional replacement of previous output files with the same name.
#File sharing rules for the input file.

====Comments and Examples====
The following specification indicates that MASTER is the file to be sorted. It can be found in the VOL subdirectory on drive C. SORTOUT is the name of the output file. This can also be found in the VOL subdirectory on drive C. The WORK subdirectory, on drive D, is the designated work space. An address-out sort (PD3 format) is to be performed, and the native collating sequence is to be used (unless the BRConfig.sys file or CONFIG command has specified ALTERNATE):

FILE MASTER,VOL,C,SORTOUT,VOL,C,WORK,D,A,N

In the following example, SORT.IN is the file to be sorted. It is located in the current directory on the current drive. SORT[WSID].OUT is the output file. The current drive and directory will be used for the work space. In the name SORT[WSID].OUT, the [WSID] will be replaced with the current workstation ID. A record-out sort using the alternate collating sequence is called for. If SORT[WSID].OUT already exists, BR will replace it with the newly sorted file.

FILE SORT.IN,,,SORT[WSID].OUT,,,,,R,A,REPLACE

====Syntax====

[[Image:SortFile.png]]

====Defaults====
#Use the current directory.
#Use the current drive.
#Record-out sort (FILE spec)
#Default according to the COLLATE specification in the BRConfig.sys file.
#Do not replace existing file by same name.
#Use SHRI.

====Parameters====
{|
|-valign="top"
|width="150"|'''Input file name'''||is the name of the internal file containing the records to be sorted. "Path" is the sequence of directories, which leads to this file. "Drive" is the drive on which the subdirectory path and file can be found.
|-valign="top"
|width="150"|'''Output file name'''||is the name of the file that is to contain the sorted records (or just the record numbers of the records in sorted order). "Path" is the sequence of directories, which leads to this file, and "drive" is the drive on which the subdirectory path and file can be found.
|-valign="top"
|width="150"|'''Workpath'''||is a sequence of subdirectories, which leads to the disk area where BR should create a temporary Workspace. "Workrive" is the drive on which this subdirectory path can be found. There is no need to specify a name for the work file, as BR handles this internally. See the Technical Considerations section below for formulas to help you estimate work file space.
|-valign="top"
|width="150"|'''FILE spec'''||allows you to choose from three different sort storage methods. "A" calls for an address-out sort, which is to be stored in PD3 format. "B" calls for an address-out sort, which is to be stored in B4 format. (''Note: Not BH4'') In both cases, the "address" which is being stored is the relative record number. "R" calls for a record-out sort, which means that each entire record is written to the output file. See the Technical Considerations section below for formulas to help you estimate address-out and record-out space. Address-out sorts execute much more quickly than record-out sorts, and the B storage method is faster than the A storage method. When using the A Method, PD 3 has a limit of 99,999, so any records >10,000 will have a 0 in the PD 3 value. When possible using "B" to avoid problems with large data sets.
|-valign="top"
|}

{|
|-valign="top"
|width="150"|'''Collating sequence'''||allows you to specify a collating sequence for the sort. "A" calls for the alternate collating sequence to be used, and "N" calls for the native sequence to be used. In most instances, the FILE specification collating sequence will override the BRConfig.sys file's COLLATE specification (for the sort only). There is one exception, however: if the FILES specification is N, and the BRConfig.sys specification is COLLATE ALTERNATE, the alternate collating sequence will be used. The following table should help clarify when each sequence is used. NOTE that the column labeled BRConfig.sys refers to the specification currently in use, whether it was actually specified by the BRConfig.sys file or by the CONFIG command:
[[Image:SortFileTable.png]]
'''*Note''' the exception with this option
|-valign="top"
|}

{|
|-valign="top"
|width="150"|'''REPLACE'''|| replaces an old sort output file (if it exists under the specified name) with the new output file. This eliminates the need to free or drop the file before sorting. REPLACE should only be used with caution, as the existence of the output file may indicate that a previous error has occurred. You may wish to restrict the use of this parameter to WSID temporary files and to address-out files.
|-valign="top"
|}

{|
|-valign="top"
|width="150"|'''share spec'''|| allows you to specify file sharing rules for the input file. Any one of the NOSHR, SHRI, SHR or SHRU keywords is accepted. Keep in mind that the sort output file will not be in sorted order if SHR is specified and a record's sort field is modified by another workstation during the sort. (See "[[share specs]]" for more information about share parameters)
|-valign="top"
|}

'''All commas must be included in the FILE specification, even if some parameters are omitted'''.

====Technical Considerations====
1) To estimate the amount of space BR will need for its temporary work space, use the following formula (applies to both address-out and record-out sorts):

: Number of records selected x 2
: x Sort key length + 4
: = N [round up to a multiple of 1024]

2) To estimate the byte size of a PD3-formatted output file for an address-out sort (specified with the "A" parameter), use the following formula:

: Number of records selected
: x 4
: + 15
: = N [round up to a multiple of 512]

3) The record limit for a PD3-formatted address-out sort ("A"), is 99,999 records.

4) To estimate the byte size of a B4-formatted output file for an address-out sort (specified with the "B" parameter), use the following formula:

: Number of records selected
: x 5
: + 16
: = N [round up to a multiple of 512]

5) The record limit for a B4-formatted address-out sort ("R"), is 2.147 billion (2**31-1) records.

6) To estimate the byte size of the output file for a record-out sort (specified with the "R" parameter), use the following formula:

: Number of records selected
: x Record length + 1
: = N [round up to a multiple of 512]

7) BR automatically clears the controls (including collating sequence) set by one sort group before it begins executing the next sort group.

===ALTS===

The optional ALTS specification allows you to either reorder part of the collating sequence or to set certain characters equal to a new collating value.

====Comments and Examples====

ALTS is frequently used to set the values of uppercase letters to the same values as their lowercase counterparts.

ALTS specifications take effect only during character comparisons when C is specified as the format type.

The following example reorders the collating values for the uppercase letters A through Z to match the collating values for their lowercase counterparts:

ALTS RO,97,"ABCDEFGHIJKLMNOPQRSTUVWXYZ"

The following example reorders lowercase letters so that vowels are sorted before consonants:

ALTS RO,97,"aeioubcdfghjklmnpqrstvwXYZ"

The following nine specifications set the collating values for the characters 1 through 9 to a collating value of 48. These values come into effect only when the sort is performed on C field types. It does not effect the sorting of the digits 1 through 9 when they appear in N fields:

ALTS EQ,48,"123456789"

====Syntax====

[[Image:SortAlts.png]]

====Parameters====

In the top route of the syntax diagram, "RO" indicates that a set of characters is to be reordered.

"New starting value" is the first value to be assigned in the reordering process. It must be a number from 0 to 255, and it must not be allowed to increment beyond 255. Thus if you enter a value of 253, only three characters may be reordered.

"Character sequence" is a list of up to 28 characters which are to be reordered. It must be enclosed in quotation marks. The value which is specified as the "new starting value" will be assigned to the first character specified in the "character sequence". The next sequential value will be assigned to the second character in the "character sequence", and so on. If you wish to reorder more than 28 characters, you must use an additional ALTS specification.

In the lower route of the syntax diagram, "EQ" indicates that a new, single collating value is to be assigned to the specified characters (the value and the characters are set equal).

"New value" is a value from 0 to 255 which is to be assigned to the character. "Character sequence" is the character or set of characters which is to be given a new value; it must be enclosed within quotation marks.

====Technical Considerations====

1) If the ALTERNATE collating sequence is used for the sort, the following implied ALTS specification is automatically registered before any other ALTS specification is executed. Subsequent and overlapping ALTS specifications will take precedence over this specification:

ALTS RO,176,"0123456789"

2) There is no limit to the number of ALTS specifications in a single sort group.

3) BR automatically clears all controls (including collating sequence and ALTS reordering) set by one sort group before it begins executing the next sort group.

===Record===

The optional RECORD specification allows you to specifically include or eliminate particular records from the sorting procedure.

====Comments and Examples====
Each RECORD specification tells BR to examine a specific field, called the select field, and determines whether or not the record should be included in the sort. If the value of the select field falls inside the specified limits and I (include) has been specified, BR includes that record in the sort.

If the value of the select field falls outside the specified limits and O (omit) has been specified, BR includes that record in the sort.

When two or more RECORD specifications are connected by the keyword "AND" (also the default), a single record must meet the qualifications of both before it will be included in the sort.

The RECORD specification in the following example tells BR to include only the records that fall inside the specified limits. The select field starts in position one of the record and is four characters in length. It is in packed decimal (PD) format. If the select field is equal to or greater than 100, and not more than 999, it will be included in the sort.

RECORD I,1,4,PD,"100","999"

The following six RECORD specifications demonstrate the use of AND and OR. If a record passes the test in the first specification, it is automatically included in the sort. If it does not pass this test, it is evaluated according to the next three record specifications. If it does not receive a true evaluation for each, it may still be able to pass the requirements of the last two specifications. If it does not pass any of the three tests, it is not included in the sort:

RECORD I,40,5,C,"55024","55036",OR
RECORD I,49,15,C,"DAKOTA","DAKOTA",AND
RECORD I,20,15,C,"OUST RD","OUST RD",AND
RECORD I,15,5,C,"47315","47722",OR
RECORD I,49,15,C,"DAKOTA","DAKOTA",AND
RECORD I,20,15,C,"RIDGE RD","RIDGE RD"

The following record specification uses comparison fields in each individual record as the select field's lower and upper limits. An example of how it would be used is to identify all inventory items which are either understocked or overstocked. The select field (which represents the current inventory amount), is described as the six-character field that starts at position 28. If the value of this field is less than the value of the field that starts at position 52 (the minimum inventory amount) or greater than the value of the field that starts at position 59 (the maximum inventory amount), it will be included in the sort.

RECORD O,28,6,N,52,59

====Syntax====

[[Image:SortRecord.png]]

====Defaults====

1) Use AND.

====Parameters====

RECORD's first parameter must either be "I" (include) or "O" (omit). If you choose I, BR will include all records with select fields that fall inside the values you specify. If you choose O, BR will exclude all records with select fields that fall outside the values you specify.

"Start pos" is the starting position of the select field, and "field length" is its character length. "Form spec" indicates the format of the field (C, N, PD, etc.; see the discussion of [[Category:File_Operations#Format_Specifications|format specifications]] in the [[File Operations]] Section for more information).

BR compares the data in the specified field to lower and upper limits before determining whether or not its record should be included in the sort.

"Lower limit start pos" identifies the starting position of another field in the record. BR will use the value of this comparison field as the lower limit of the select field. The format type of the comparison field must be identical to that of the select field, and the field length must be the same.

"Upper limit start pos" identifies the starting position of the field which contains the upper limit value for the select field. The format type of this comparison field must be identical to that of the select field, and the field length must be the same.

"Lower limit" and "upper limit" are constants enclosed within quotation marks. BR will consider these to be the low and high limit values for the select field in determining whether or not the record should be included. BR will not accept strings greater than 40 characters in length for this parameter. It is important to distinguish between uppercase and lowercase letters when using these options, as BR makes a letter-for-letter comparison on character fields.

"OR" and "AND" are the RECORD specifications' last two parameters. If all the RECORD specifications in a sort group are joined by "AND", a record must pass the requirements of each before it will be included in the sort. The following two specifications, for instance, require that the value of a certain four-character field in the record fall outside 2000 and 8000 and that a certain two-character field is equal to MN. If a record doesn't pass both these tests, it is not included in the sort.

RECORD O,3,4,C,"2000","8000",AND
RECORD I,28,2,"MN","MN"

The "OR" parameter gives a second try to records that don't pass the first set of requirements. When it is included at the end of a RECORD specification, "OR" tells BR that the next RECORD specification begins a new set of requirements. If the current record passes the first set of requirements, BR does not check to see if it will pass any others. If the record does not pass the first set, however, BR sequentially checks to see if it will pass any other sets. As soon as it passes the requirements for one set of RECORD specifications, BR includes it in the sort.

When "passing"lower and higher limits in the "record" section be sure and enclose the incoming variables with the appropriate quote sequence. This is just and example:

LET Data_Record$='RECORD I,'&Str$(Recpos)&',8,C,"'&V_File$&'","'&V_File$&'"'

In the above example we are passing the Record Position and the lower and upper file numbers we want included in the "filter"

====Technical Considerations====

1) BR allows up to 20 RECORD specifications per sort group. (On releases prior to 3.21b, the limit was ten)
2) When the OR parameter is used, processing will be faster if the first conditions are the ones most likely to result in a true evaluation.
3) The two different types of lower and upper limit parameters may be specified in the same RECORD specification.
4) When I is specified, the RECORD specification's parameters are inclusive. This means that a record will be included in the sort if the select field's value is equal to the upper or lower limit value or if it is between the upper and lower limit values.
5) When O is specified, RECORD's upper and lower limits are exclusive; the select field value may not be equal to either the upper or lower limit if it is to be included in the sort.

===MASK===

MASK is a required specification that identifies up to ten sort fields and the manner (ascending or descending) in which they should be sorted.

====Comments and Examples====
A sort field contains the specific information to be sorted. When you wish to organize records in descending order by zip code, for example, the sort field is the zip code. The following MASK specification defines two sort fields. The first starts in position 1 and is four characters long; it is in packed decimal (PD) format, and it is to be sorted in ascending order. The second field starts in position 10 and is three characters long. It is in character (C) format, and is also to be sorted in ascending order.

MASK 1,4,PD,A,10,3,C,A

====Syntax====

[[File:SortMask.png]]

====Parameters====

"Start position" is the starting record position of the field to be sorted, and "field length" is its character length.

"Form spec" indicates the format, or data type, of the field. The format specifications which can be used in the MASK specification include the following: B (Binary); BL (Binary low); BH (Binary high); C (Character); D (Double-precision); L (Long); N (Numeric); PD (Packed decimal); S (Single-precision) and ZD (Zoned decimal). See [[:Category:File_Operations#Format_Specifications|Format Specifications]] in the [[File Operations]] section for more information about each of these format types.

The last parameter must either be "A" to sort the specified record in ascending order, or "D" to sort it in descending order.

====Technical Considerations====
#The following field lengths are required for the D, S & L format specs: D is 8; S is 4; & L is 9.
#The total sort key length may not exceed 32,767 bytes.
#Up to ten fields may be specified with the MASK specification.
#MASK must always be the last specification in a sort group.
#The existence of MASK flags the end of the current sort group. BR will automatically treat any specifications that follow as part of the next sort group.

==Sort Specification==

The ! (for a comment), FILE, ALTS, RECORD, SUM and MASK specifications each control a different aspect of the sorting procedure. A set of these specifications makes up a sort group.

===Sort Group===

A sort group contains all the necessary specifications for controlling the sorting of a single file. If only one file is to be sorted, a single sort group may simply follow a SORT command when it is specified in a procedure file. When several files are to be sorted, the sort group for each file may be placed together in a single sort control file.

==Sort Control File==
{{:Sort control file}}

==Sort Baseyear Processing==

If a Y is appended to the A/D (ascending/descending) indicator of sort MASK statements or the I/O (include/exclude) field of RECORD statements, the field is subject to BASEYEAR processing.

If such a field is in display format, then the first two characters are assumed to be a BASEYEAR dependent value. If the field is packed (BH or PD) then the storage format is assumed to be YYMMDD, YYMM or YY format depending on the length of the field, similar to INDEX (see above table).

The Y2K sorting and indexing features interpret year zero as zero (instead of 2000) if the month and day are zero. Leading blanks in baseyear sensitive fields are replaced with zeroes for sorting purposes, provided the remainder of the field contains only numeric data.

Prior to release 3.83e, BR ignored the digits to the left of the rightmost six digits of a date value unless century was specified in the mask.

;Example:

... DAYS(1001021,"YMD") produced the same result as DAYS(001021,"YMD")

Now if BR is unsuccessful applying the "YMD" mask it now tries "CYMD". This change has inconvenienced some dealers. Therefore OPTION 18 is provided to ignore the presence of digits to the left of the rightmost six digits.

==Improving Sort Speed==

All of the following factors can affect the speed of a sorting operation:

# Number of records to be sorted. The fewer the records, the faster the sort.
# Type of sort. Address-out sorts takes less time to run than a record-out sorts because they require fewer disk reads and writes. Also the B storage method for address-out sorts is faster than the A storage method.
# RECORD specification(s). When RECORD specifications cause many records to be omitted from the sort, the sort runs faster.
# Length of sort field. The shorter the sort field, the faster the sort.
# Order of records in the input file. Files with records that are already close to the desired order sort more quickly than more randomly ordered files.
# Record size. The smaller the input records the faster the sort.
# Storage size of the computer. In general, the greater the storage, the faster the sort. If the computer does not have enough storage, it must use work files: the time required to read from and write to these files adds to the amount of time the sort takes.

<noinclude>
[[Category:Sorting and Indexing]]
[[Category:Facility Commands]]
[[Category:Needs Help]]
</noinclude>

Category:Format Specifications

2023-04-11T16:27:00Z

GomezL:

See the format specifications below for more details on each.

See also [[Format specifications]] for a chart comparing their uses.

Format specifications tell Business Rules the form that a particular data field will be in. A format specification is required whenever data is input into or output from a program. It is also required with the full screen processing statements. Format specs are not required in the following situations: with unformatted internal files, with all display files, and when unformatted PRINT statements are used.

Not all format specifications are alike in their uses. Some can be used with internal and external files, but not with display files. Some can be used only with full screen formatting. And some format specifications behave differently depending on whether they are used for input or output.

== '''Common SQL Fields and BR Equivilants''' ==

<TABLE BORDER="1" CELLSPACING="1" CELLPADDING="3" WIDTH="100%" ALIGN="Center">

<TR>
<TH>SQL Field</TH>
<TH>BR Equivilant</TH>
<TH>Example</TH>
</TR>

<TR>
<TD>COUNTER</TD>
<TD>N</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>INTEGER</TD>
<TD>N</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>LONG INTEGER</TD>
<TD>N</TD>
<TD>N 12</TD>
</TR>

<TR>
<TD>SINGLE</TD>
<TD>S</TD>
<TD>S</TD>
</TR>

<TR>
<TD>DOUBLE</TD>
<TD>D</TD>
<TD>D</TD>
</TR>

<TR>
<TD>BINGINT</TD>
<TD>N/A</TD>
<TD>N 10</TD>
</TR>

<TR>
<TD>SMALLINT</TD>
<TD>BH</TD>
<TD>BH 2</TD>
</TR>

<TR>
<TD>FLOAT</TD>
<TD>L</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>DECIMAL</TD>
<TD>N or PD</TD>
<TD>N 12.2 or PD 6.2</TD>
</TR>

<TR>
<TD>DATETIME</TD>
<TD>N/A</TD>
<TD>Typically Stored as separate fields</TD>
</TR>

<TR>
<TD>DATE</TD>
<TD>C or D</TD>
<TD>C 8 or D</TD>
</TR>

<TR>
<TD>CHAR</TD>
<TD>C</TD>
<TD>C 30</TD>
</TR>

</TABLE>

<noinclude>
[[Category:Field Specifications]]
[[Category:All Parameters]]
</noinclude>

Category:Format Specifications

2023-04-11T16:26:21Z

GomezL:

See the format specifications below for more details on each.

See also [[Format specifications]] for a chart comparing their uses.

Format specifications tell Business Rules the form that a particular data field will be in. A format specification is required whenever data is input into or output from a program. It is also required with the full screen processing statements. Format specs are not required in the following situations: with unformatted internal files, with all display files, and when unformatted PRINT statements are used.

Not all format specifications are alike in their uses. Some can be used with internal and external files, but not with display files. Some can be used only with full screen formatting. And some format specifications behave differently depending on whether they are used for input or output.

Common SQL Fields and BR Equivilants

<TABLE BORDER="1" CELLSPACING="1" CELLPADDING="3" WIDTH="100%" ALIGN="Center">

<TR>
<TH>SQL Field</TH>
<TH>BR Equivilant</TH>
<TH>Example</TH>
</TR>

<TR>
<TD>COUNTER</TD>
<TD>N</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>INTEGER</TD>
<TD>N</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>LONG INTEGER</TD>
<TD>N</TD>
<TD>N 12</TD>
</TR>

<TR>
<TD>SINGLE</TD>
<TD>S</TD>
<TD>S</TD>
</TR>

<TR>
<TD>DOUBLE</TD>
<TD>D</TD>
<TD>D</TD>
</TR>

<TR>
<TD>BINGINT</TD>
<TD>N/A</TD>
<TD>N 10</TD>
</TR>

<TR>
<TD>SMALLINT</TD>
<TD>BH</TD>
<TD>BH 2</TD>
</TR>

<TR>
<TD>FLOAT</TD>
<TD>L</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>DECIMAL</TD>
<TD>N or PD</TD>
<TD>N 12.2 or PD 6.2</TD>
</TR>

<TR>
<TD>DATETIME</TD>
<TD>N/A</TD>
<TD>Typically Stored as separate fields</TD>
</TR>

<TR>
<TD>DATE</TD>
<TD>C or D</TD>
<TD>C 8 or D</TD>
</TR>

<TR>
<TD>CHAR</TD>
<TD>C</TD>
<TD>C 30</TD>
</TR>

</TABLE>

<noinclude>
[[Category:Field Specifications]]
[[Category:All Parameters]]
</noinclude>

Category:Format Specifications

2023-04-11T14:23:26Z

GomezL:

See the format specifications below for more details on each.

See also [[Format specifications]] for a chart comparing their uses.

Format specifications tell Business Rules the form that a particular data field will be in. A format specification is required whenever data is input into or output from a program. It is also required with the full screen processing statements. Format specs are not required in the following situations: with unformatted internal files, with all display files, and when unformatted PRINT statements are used.

Not all format specifications are alike in their uses. Some can be used with internal and external files, but not with display files. Some can be used only with full screen formatting. And some format specifications behave differently depending on whether they are used for input or output.

Common SQL Fields and BR Equivilants

<TABLE BORDER="0" CELLSPACING="1" CELLPADDING="3" WIDTH="100%" ALIGN="Center">

<TR>
<TH>SQL Field</TH>
<TH>BR Equivilant</TH>
<TH>Example</TH>
</TR>

<TR>
<TD>COUNTER</TD>
<TD>N</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>INTEGER</TD>
<TD>N</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>LONG INTEGER</TD>
<TD>N</TD>
<TD>N 12</TD>
</TR>

<TR>
<TD>SINGLE</TD>
<TD>S</TD>
<TD>S</TD>
</TR>

<TR>
<TD>DOUBLE</TD>
<TD>D</TD>
<TD>D</TD>
</TR>

<TR>
<TD>BINGINT</TD>
<TD>N/A</TD>
<TD>N 10</TD>
</TR>

<TR>
<TD>SMALLINT</TD>
<TD>BH</TD>
<TD>BH 2</TD>
</TR>

<TR>
<TD>FLOAT</TD>
<TD>L</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>DECIMAL</TD>
<TD>N or PD</TD>
<TD>N 12.2 or PD 6.2</TD>
</TR>

<TR>
<TD>DATETIME</TD>
<TD>N/A</TD>
<TD>Typically Stored as separate fields</TD>
</TR>

<TR>
<TD>DATE</TD>
<TD>C or D</TD>
<TD>C 8 or D</TD>
</TR>

<TR>
<TD>CHAR</TD>
<TD>C</TD>
<TD>C 30</TD>
</TR>

</TABLE>

<noinclude>
[[Category:Field Specifications]]
[[Category:All Parameters]]
</noinclude>

Category:Format Specifications

2023-04-11T14:22:16Z

GomezL:

See the format specifications below for more details on each.

See also [[Format specifications]] for a chart comparing their uses.

Format specifications tell Business Rules the form that a particular data field will be in. A format specification is required whenever data is input into or output from a program. It is also required with the full screen processing statements. Format specs are not required in the following situations: with unformatted internal files, with all display files, and when unformatted PRINT statements are used.

Not all format specifications are alike in their uses. Some can be used with internal and external files, but not with display files. Some can be used only with full screen formatting. And some format specifications behave differently depending on whether they are used for input or output.

Common SQL Fields and BR Equivilants

<TABLE BORDER="0" CELLSPACING="1" CELLPADDING="3" WIDTH="100%" ALIGN="Center">

<TR>
<TH>SQL Field</TH>
<TH>BR Equivilant</TH>
<TH>Example</TH>
</TR>

<TR>
<TD>COUNTER</TD>
<TD>N</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>INTEGER</TD>
<TD>N</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>LONG INTEGER</TD>
<TD>N</TD>
<TD>N 12</TD>
</TR>

<TR>
<TD>SINGLE</TD>
<TD>S</TD>
<TD>S</TD>
</TR>

<TR>
<TD>DOUBLE</TD>
<TD>D</TD>
<TD>D</TD>
</TR>

<TR>
<TD>BINGINT</TD>
<TD>N/A</TD>
<TD>N 10</TD>
</TR>

<TR>
<TD>SMALLINT</TD>
<TD>BH</TD>
<TD>VH 2</TD>
</TR>

<TR>
<TD>FLOAT</TD>
<TD>L</TD>
<TD>N 6</TD>
</TR>

<TR>
<TD>DECIMAL</TD>
<TD>N</TD>
<TD>N 12.2</TD>
</TR>

<TR>
<TD>DATETIME</TD>
<TD>N/A</TD>
<TD>Typically Stored as separate fields</TD>
</TR>

<TR>
<TD>DATE</TD>
<TD>C or D</TD>
<TD>C 8 or D</TD>
</TR>

</TABLE>

<noinclude>
[[Category:Field Specifications]]
[[Category:All Parameters]]
</noinclude>

BR Forum

2019-05-21T13:16:20Z

GomezL: Link to Register on Forum was broken.

The '''BR Forum''' ([http://brforum.brulescorp.com brforum.brulescorp.com]) is the place to post your questions, answers and other discussions about the Business Rules! programming language.

To keep up to date with what is going on on the BR Forum, it is suggested that you subscribe to the [http://brforum.brulescorp.com/rss.php BR Forum's RSS feed].

===New Users===
*[http://brforum.brulescorp.com/ucp.php?mode=register Register]
*[http://brforum.brulescorp.com/viewforum.php?f=20&sid=60fc6da8b23fc4ddab1355116d9e3906 Help using the BR forum]

When you get there, please check out the "[http://brforum.brulescorp.com/viewforum.php?f=20&sid=60fc6da8b23fc4ddab1355116d9e3906 Using this forum]" section for a few pointers to help you get started.

You must be registered in the new forum in order to post messages. To do so, go to [http://brforum.brulescorp.com/ brforum.brulescorp.com] and [http://brforum.brulescorp.com/profile.php?mode=register&sid=ee5bc51d99c90d7865769931e18acb22 Register]. New registrations must be approved by a moderator, so there could possibly be a slight delay before that takes place. Once you are registered, log in using the [http://brforum.brulescorp.com/login.php Log in] link in the upper right corner and you're ready to go.

==Older Forum: the Maillist==
The older "BR_forum" maillist is still in wide spread use as a portal to the online forum, just remember that every email you send or receive here will be published.

*[http://brulescorp.com/mailman/listinfo/br_forum_ads.net maillist]

Floating Point Numbers

2019-04-29T17:42:33Z

GomezL:

Floating point numbers are numbers which allow the decimal point to "float" to any position.

The Business Rules syntax is nEm, where n is a numeric constant indicating the sign and significant digits in the number, E represents base 10, and m is a signed integer representing the power to which 10 is raised.

The largest and smallest numbers available to the system vary according to the hardware and operating system being used. The system function [[INF]] can be used to print the largest possible number on any given system; 1/INF generates the smallest number. Some caution should be used in working with numbers near these minimum and maximum extremes (e.g., using exponential notation in SORT). Also, for any given combination of hardware and Business Rules, the system infinity function INF and some testing should be combined to determine whether or not intermediate values used in calculations will be truncated.

All numbers in memory are floating point numbers. The form of the number when written to disk or printed depends on the format or mask used in writing the number. Number variables are designated by NOT ending with a dollar sign in Business Rules.

The fact that floating-point numbers cannot precisely represent all real numbers, and that floating-point operations cannot precisely represent true arithmetic operations, leads to many surprising situations. This is related to the finite precision with which computers generally represent numbers. in BUsiness Rules, floating point numbers can only provide 16 digits of precision, this is before or after the decimal place.

Examples:

Values that fit in Floating Point:
print using 'form n 20.2':1234567890123.45 --> 1234567890123.45
print using 'form n 20.8':1234567.89012345 --> 1234567.89012345

Values that do not fit in Floating Point:
print using 'form n 20.2':123456789012345.67 --> 123456789012346.00
print using 'form n 20.8':1234567890.1234567 --> 1234567890.12346000

<noinclude>
[[Category:Definitions]]
</noinclude>

System (command)

2019-03-26T06:54:53Z

GomezL: /* Using SYSTEM to exit BR */

The '''System (SY)''' [[:Category:commands|command]] can do two things:
#Exit BR and return control to the [[operating system]], or
#Perform a '''shell call''' (an operating system command) while BR is active.

System can be executed from [[READY mode]], from a [[procedure file]], or with the [[Execute]] [[statement]].

==Using SYSTEM to exit BR==

Entering SYSTEM or it's short form, SY into the command line while in ready mode will exit BR. The same can be done using an [[Execute]] Statement or a procedure file. Optionally, the SYSTEM LOGOFF may be used when in client server to clear the login credentials. The next time client server is started, the user will be requested to enter their credentials.

[[image:Sy.jpg]]
[[image:System2.jpg]]

==Using SYSTEM to send commands to the operating system==
===Comments and Examples===
One use of the SYSTEM command is to run a program. In the following example, the SYSTEM command runs a program called BACKUP. By default, the first program waits until the other program has finished running, and then continues where it left off. The syntax includes the SYSTEM keyword and then the OS command, which in this case is the program name and location of the data to handle.

SYSTEM BACKUP C:\\*.DAT A: /S

When the same command is used with an asterisks preceding the program name, BACKUP, the BR program restores its own screen upon re-entry:

SYSTEM *BACKUP C:\\*.DAT A: /S

The statement below tests to see what type of operating system the program is running on, then executes the appropriate SYSTEM command for the operating system:

00100 IF FILE$(0)(1:3)="CON:" THEN EXECUTE "SYSTEM DIR" :!ELSE EXECUTE "SYSTEM ls -al /usr/BR"

===Using Batch Files with System Exits===

One use of the System command is to pass a return code to the host operating system as it permanently exits from BR. In the following example, a DOS [[batch file]] tests the return code ([[ERRORLEVEL]]) and performs a specific action according to its value.

BR PROC START
IF ERRORLEVEL 101 GOTO BADERROR
IF ERRORLEVEL 100 GOTO BACKUP
IF ERRORLEVEL 99 GOTO FORMAT
GOTO DONE
:BACKUP
BACKUPBR
:FORMAT
FORMAT A:
BRSTART
:BADERROR
ECHO BAD ERROR RETURN CODE >100
:DONE

If the command SYSTEM 100 were used to exit from BR while the above batch file was active, DOS would start a back-up procedure as soon as the BR exit was complete.

==Syntax==
SYSTEM [< code for OS>|[*]<OS command>]
[[Image:System.png]]

==Defaults==
:1) Return control to the operating system with a return code of zero.
:2) Do not restore screen.

==Parameters==
'''Code returned to OS''' parameter sets the value of the operating system return code which may be accessed using ERRORLEVEL in DOS batch files, and through the $? substitution in a Linux shell.

'''OS command''' parameter is an operating system command which BR passes to the operating system for execution. If the result of the command requires no operator action, BR is immediately reentered after the command finishes execution. Since BR is active during the entire process, all variable values and memory remain the same. When the '''OS command''' parameter is preceded by an asterisk, the BR screen is restored upon re-entry. The '''OS command''' parameter must be a '''string variable''' or a string enclosed in quotes.

Additional Flags that can alter the behavior of the shell call as follows:

{|
|-valign="top"
|width="60"|'''-E or -e'''||"Errors" indicates that any Operating System errors returned from the shell should be reported (as error 4300). Otherwise shell call operating errors are ignored. Occasionally Windows returns error values for fairly nominal exceptions. So the -e is provided as an error return sensitivity level flag. Further information can be obtained by querying SYSERR or SYSERR$
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-M or -m'''|| Run the program "minimized".
|-valign="top"
|width="60"| ||If a lower case m is specified, the process or program runs in a DOS command shell without displaying the DOS window, but with a corresponding icon on the task bar (effectively running the shelled process/program "minimized") This is only applicable in Windows. It is ignored on all other systems. If -m is omitted, the shelled program will open in a separate application window.
|-valign="top"
|}

{|
|-valign="top"
|width="60"| ||If an upper case M is specified, the same thing happens except the task does not appear on the taskbar. It runs invisibly. Furthermore [[SPOOLCMD]] calls use lowercase m.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-s'''||Server Shell Call (this is the default for Unix). If -s is omitted on Windows, then this shell call is performed on the client.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-@'''||If using Client Server, then it runs the program on the client. Client Shell Call is the default for Windows. If -@ is omitted, on Unix the shell call is performed on the server.
|-valign="top"
|width="60"| ||(search path not implemented on client)
|-valign="top"
|}

{|
|-valign="top"
|width="60"| ||Note- Ctrl-] ALWAYS performs a DOS shell call on the client.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-c'''||The main program "continues" to run while running the called one. Windows launches the task and resumes BR operation where it left off. For Unix, the command is framed with NOHUP and &. If -c is omitted, then the shell call waits til the process is finished (up to the # seconds specified in SHELL LIMITS) before returning to BR.

For [[OSX]] 10.6 you need

sys -c | (pipe) Shell commands with a pipe make BR Continue after executing the sys -c (continue), if you do not insert the | pipe, then the script does not run under Br [[4.18]] and up.
This was found on a Macintosh client that just updated to OSX 10.6.x

|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-r'''||"Restore" means that Windows always performs shell in a separate window. (Unix ignores shell standard out data). If -r is omitted. then Unix forwards standard out and stdin data to and from the client window.
|-valign="top"
|width="60"| ||Restores screen after running command on all systems. In windows, the screen is always restored, so this flag is essentially ignored. This is the same as sys *command. The newer syntax is more readable and preferred.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-w'''||("without shell") When a Windows application is called, use a -w flag to tell BR not to call COMMAND.COM, but to call the application directly. It must be a program (i.e. "exe") and not a script. The Search Path is used ON SERVER only (if no slashes). This option does NOT open a DOS window. It does not use Bourne shell. It enables unfiltered return values. A Timeout or Ctrl-A kills the process. If -w is omitted, then a timeout or Ctrl-A does NOT kill the process, which can leave orphans.
|-valign="top"
|}

{|
|-valign="top"
|width="60"| ||Note- Currently -w is ignored in Unix standard models.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''blank'''||Application standard output is forwarded to the client. However the Bourne shell is utilized to initiate the process. The shelled program CAN be an executable script.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-p'''||("Page Standard Output") - This option applies to Unix server only. If -p is omitted, then output goes to screen without pausing
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-t9999'''||Wait up to the specified number of seconds (for client server only). If -t is omitted, wait the number of seconds specified in the [[SHELL LIMIT]] statement (see [[BRConfig.sys]] chapter for more information on [[SHELL LIMIT]])
|-valign="top"
|}
 

==Technical Considerations==
:1) Simultaneous pressing of the Ctrl key and the right- bracket (]) key has the same effect as the SYSTEM command's shell call, except that no command string is automatically executed upon access to the operating system. Pressing of these keys causes BR immediately access the operating system and display the system prompt. Between each operating system operation, a message about what action is required to return to BR will be displayed.
:2) Too frequent or careless use of the SYSTEM command can make it more difficult to move your program to a new operating system. ADS strongly recommends the use of the FILE$ function in programs and procedures which access the resident operating system. This function allows programs to test the type of operating system before proceeding with a system-dependent sequence of commands. While the FILE$ function can always be programmed in at a later date, you may be able to save a great deal of time and recoding by placing it in programs as they are written.
:3) When the system call (either Ctrl-] or the [[SYSTEM]] command) starts and then exits a secondary software program before returning to [[BR]], the [[CODE]] function will reflect any return code that the secondary program has passed to the operating system. As soon as BR is reactivated, the value of [[CODE]] can be tested to Verify whether or not the secondary program was successful. This is currently valid for Linux versions of [[BR]] only.
:4) [[BR]] passes all quotation marks within or surrounding the "string-expr" parameter back to the operating system.
:5) The screen may be cleared on some Linux terminals when the [[SYSTEM]] call is completed. If this is undesirable, see [[Terminal Considerations]] for a possible remedy.
:6) BR now searches PATHs during Windows shell call.
:7) Shell calls to Windows applications are no longer maximized.
:8) System calls -M -W -C -R now operate like their corresponding lower case flags. This case sensitivity had been suppressed to allow passing the flags to DOS, but that made the rules too obscure.
:9) Concerning Unix shell calls, the following flag combinations are prevented-
:-W and -C 
:-R and -C 
:-W and -R 
:In other words Without Shell, Restore Screen, and Continue are mutually exclusive options. If more than one is specified at a time, error [[2222]] is generated.

For disambiguation purposes, also see [[System Parameter]].

<noinclude>
[[Category:Commands]]
[[Category:Executive Commands]]
</noinclude>

BRlistener.exe

2019-01-18T17:23:38Z

GomezL:

The '''BRListener.exe''' file is a [[32 bit]] C++ application which serves as the [[connection agent]] for the server side of [[Business Rules!]] [[Client Server]] installations.

GENERAL: You must be logged in as [[Administrator]] in order to run Setup (BRListener.exe). (Or [[superuser]] for [[SCO]])

In order to run BRListener.exe, [[BRListener.conf]] must be properly configured.

Copy BRListener.exe to the proper [[System32]] folder.

If you have a BR Service running:

# Stop the BR Service on the machine where you intend to install. If your previous installation was done using InstallShield, use "stop BR service" from the Programs/BR Service icon list.
# You can also stop the BR Service by going to start, run, and typing "install /release".
# If your previous installation was done using InstallShield, you can remove it by using the Add/Remove Programs feature in the Control Panel. In this case, your [[BRConfig.sys]] and [[license file]] will not be removed. This is to make them available for subsequent use.
# When you run install, installation will modify your BRListener.conf file if your target directory is different from the one previously specified.

*BRListener ([[4.13]]) was changed to allow multiple label statements. It works in conjunction with a new build of the Client ([[4.12c]]).

The listeners recognize a qualifying prefix on [[brlistener.conf|CONF]] file statements. This supports having different listeners active at the same time. This permits testing in production client-server environments.

@release = 1.2 PORT=8555
@release = 2.0 PORT=8557
@release < 2.0 EXECUTABLE = /ads/sys/br.d/brserver
@release >= 2.0 EXECUTABLE = /ads/sys/br.d/brserver.new

The full syntax for the Windows brlistenerinstaller is:

brlistenerinstaller [/RELEASE] [/ALTERNATE alternate] [brlistener-path]

[/RELEASE] removes this service.
[/ALTERNATE alternate] uses an alternate service name. This will result in a service named BR_Listener-(alternate).

The second brlistener must be installed using the ALTERNATE keyword followed by a number. Under Linux this is handled by naming the listeners differently.

Persistent Login – Brlistener Release 2.0 in MULTISESSION Mode

A Client session ID is stored in the registry on the client side and associated with the user login name. This is maintained in memory by the BRlistener along with the user's login-name and password. The listener first checks the user's client session ID before prompting for login info.

[BRclient] communicates with [BRlistener] over TCP encrypted by TLS.

<noinclude>
[[Category:Files]]
[[Category:Client Server]]
</noinclude>

System (command)

2018-11-01T15:50:30Z

GomezL:

The '''System (SY)''' [[:Category:commands|command]] can do two things:
#Exit BR and return control to the [[operating system]], or
#Perform a '''shell call''' (an operating system command) while BR is active.

System can be executed from [[READY mode]], from a [[procedure file]], or with the [[Execute]] [[statement]].

==Using SYSTEM to exit BR==

Entering SYSTEM or it's short form, SY into the command line while in ready mode will exit BR. The same can be done using an [[Execute]] Statement or a procedure file.

[[image:Sy.jpg]]
[[image:System2.jpg]]

==Using SYSTEM to send commands to the operating system==
===Comments and Examples===
One use of the SYSTEM command is to run a program. In the following example, the SYSTEM command runs a program called BACKUP. By default, the first program waits until the other program has finished running, and then continues where it left off. The syntax includes the SYSTEM keyword and then the OS command, which in this case is the program name and location of the data to handle.

SYSTEM BACKUP C:\\*.DAT A: /S

When the same command is used with an asterisks preceding the program name, BACKUP, the BR program restores its own screen upon re-entry:

SYSTEM *BACKUP C:\\*.DAT A: /S

The statement below tests to see what type of operating system the program is running on, then executes the appropriate SYSTEM command for the operating system:

00100 IF FILE$(0)(1:3)="CON:" THEN EXECUTE "SYSTEM DIR" :!ELSE EXECUTE "SYSTEM ls -al /usr/BR"

===Using Batch Files with System Exits===

One use of the System command is to pass a return code to the host operating system as it permanently exits from BR. In the following example, a DOS [[batch file]] tests the return code ([[ERRORLEVEL]]) and performs a specific action according to its value.

BR PROC START
IF ERRORLEVEL 101 GOTO BADERROR
IF ERRORLEVEL 100 GOTO BACKUP
IF ERRORLEVEL 99 GOTO FORMAT
GOTO DONE
:BACKUP
BACKUPBR
:FORMAT
FORMAT A:
BRSTART
:BADERROR
ECHO BAD ERROR RETURN CODE >100
:DONE

If the command SYSTEM 100 were used to exit from BR while the above batch file was active, DOS would start a back-up procedure as soon as the BR exit was complete.

==Syntax==
SYSTEM [< code for OS>|[*]<OS command>]
[[Image:System.png]]

==Defaults==
:1) Return control to the operating system with a return code of zero.
:2) Do not restore screen.

==Parameters==
'''Code returned to OS''' parameter sets the value of the operating system return code which may be accessed using ERRORLEVEL in DOS batch files, and through the $? substitution in a Linux shell.

'''OS command''' parameter is an operating system command which BR passes to the operating system for execution. If the result of the command requires no operator action, BR is immediately reentered after the command finishes execution. Since BR is active during the entire process, all variable values and memory remain the same. When the '''OS command''' parameter is preceded by an asterisk, the BR screen is restored upon re-entry. The '''OS command''' parameter must be a '''string variable''' or a string enclosed in quotes.

Additional Flags that can alter the behavior of the shell call as follows:

{|
|-valign="top"
|width="60"|'''-E or -e'''||"Errors" indicates that any Operating System errors returned from the shell should be reported (as error 4300). Otherwise shell call operating errors are ignored. Occasionally Windows returns error values for fairly nominal exceptions. So the -e is provided as an error return sensitivity level flag. Further information can be obtained by querying SYSERR or SYSERR$
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-M or -m'''|| Run the program "minimized".
|-valign="top"
|width="60"| ||If a lower case m is specified, the process or program runs in a DOS command shell without displaying the DOS window, but with a corresponding icon on the task bar (effectively running the shelled process/program "minimized") This is only applicable in Windows. It is ignored on all other systems. If -m is omitted, the shelled program will open in a separate application window.
|-valign="top"
|}

{|
|-valign="top"
|width="60"| ||If an upper case M is specified, the same thing happens except the task does not appear on the taskbar. It runs invisibly. Furthermore [[SPOOLCMD]] calls use lowercase m.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-s'''||Server Shell Call (this is the default for Unix). If -s is omitted on Windows, then this shell call is performed on the client.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-@'''||If using Client Server, then it runs the program on the client. Client Shell Call is the default for Windows. If -@ is omitted, on Unix the shell call is performed on the server.
|-valign="top"
|width="60"| ||(search path not implemented on client)
|-valign="top"
|}

{|
|-valign="top"
|width="60"| ||Note- Ctrl-] ALWAYS performs a DOS shell call on the client.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-c'''||The main program "continues" to run while running the called one. Windows launches the task and resumes BR operation where it left off. For Unix, the command is framed with NOHUP and &. If -c is omitted, then the shell call waits til the process is finished (up to the # seconds specified in SHELL LIMITS) before returning to BR.

For [[OSX]] 10.6 you need

sys -c | (pipe) Shell commands with a pipe make BR Continue after executing the sys -c (continue), if you do not insert the | pipe, then the script does not run under Br [[4.18]] and up.
This was found on a Macintosh client that just updated to OSX 10.6.x

|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-r'''||"Restore" means that Windows always performs shell in a separate window. (Unix ignores shell standard out data). If -r is omitted. then Unix forwards standard out and stdin data to and from the client window.
|-valign="top"
|width="60"| ||Restores screen after running command on all systems. In windows, the screen is always restored, so this flag is essentially ignored. This is the same as sys *command. The newer syntax is more readable and preferred.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-w'''||("without shell") When a Windows application is called, use a -w flag to tell BR not to call COMMAND.COM, but to call the application directly. It must be a program (i.e. "exe") and not a script. The Search Path is used ON SERVER only (if no slashes). This option does NOT open a DOS window. It does not use Bourne shell. It enables unfiltered return values. A Timeout or Ctrl-A kills the process. If -w is omitted, then a timeout or Ctrl-A does NOT kill the process, which can leave orphans.
|-valign="top"
|}

{|
|-valign="top"
|width="60"| ||Note- Currently -w is ignored in Unix standard models.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''blank'''||Application standard output is forwarded to the client. However the Bourne shell is utilized to initiate the process. The shelled program CAN be an executable script.
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-p'''||("Page Standard Output") - This option applies to Unix server only. If -p is omitted, then output goes to screen without pausing
|-valign="top"
|}

{|
|-valign="top"
|width="60"|'''-t9999'''||Wait up to the specified number of seconds (for client server only). If -t is omitted, wait the number of seconds specified in the [[SHELL LIMIT]] statement (see [[BRConfig.sys]] chapter for more information on [[SHELL LIMIT]])
|-valign="top"
|}
 

==Technical Considerations==
:1) Simultaneous pressing of the Ctrl key and the right- bracket (]) key has the same effect as the SYSTEM command's shell call, except that no command string is automatically executed upon access to the operating system. Pressing of these keys causes BR immediately access the operating system and display the system prompt. Between each operating system operation, a message about what action is required to return to BR will be displayed.
:2) Too frequent or careless use of the SYSTEM command can make it more difficult to move your program to a new operating system. ADS strongly recommends the use of the FILE$ function in programs and procedures which access the resident operating system. This function allows programs to test the type of operating system before proceeding with a system-dependent sequence of commands. While the FILE$ function can always be programmed in at a later date, you may be able to save a great deal of time and recoding by placing it in programs as they are written.
:3) When the system call (either Ctrl-] or the [[SYSTEM]] command) starts and then exits a secondary software program before returning to [[BR]], the [[CODE]] function will reflect any return code that the secondary program has passed to the operating system. As soon as BR is reactivated, the value of [[CODE]] can be tested to Verify whether or not the secondary program was successful. This is currently valid for Linux versions of [[BR]] only.
:4) [[BR]] passes all quotation marks within or surrounding the "string-expr" parameter back to the operating system.
:5) The screen may be cleared on some Linux terminals when the [[SYSTEM]] call is completed. If this is undesirable, see [[Terminal Considerations]] for a possible remedy.
:6) BR now searches PATHs during Windows shell call.
:7) Shell calls to Windows applications are no longer maximized.
:8) System calls -M -W -C -R now operate like their corresponding lower case flags. This case sensitivity had been suppressed to allow passing the flags to DOS, but that made the rules too obscure.
:9) Concerning Unix shell calls, the following flag combinations are prevented-
:-W and -C 
:-R and -C 
:-W and -R 
:In other words Without Shell, Restore Screen, and Continue are mutually exclusive options. If more than one is specified at a time, error [[2222]] is generated.

For disambiguation purposes, also see [[System Parameter]].

<noinclude>
[[Category:Commands]]
[[Category:Executive Commands]]
</noinclude>

Multi-Line Textbox

2018-10-20T18:30:43Z

GomezL:

'''Multi-Line TextBoxes''' are accomplished in BR! by using an [[Input Fields]] [[statement]]. Here is a sample:

00010 DIM Buff$*2048
00012 LET Buff$='start with something'
00020 RINPUT FIELDS '#0,5,2,text 14/58/20,[D]s': Buff$

Syntax: Text [Rows]/[Columns]/[Max Char]

<noinclude>
[[Category:Widget]]
</noinclude>

Multi-Line Textbox

2018-10-20T18:30:28Z

GomezL:

Text

2018-07-09T17:06:39Z

GomezL: /* TEXT FIELD FORMAT */

== TEXT FIELD FORMAT==
As of 4.3

10 (R)INPUT FIELDS “row, col, TEXT rows/cols[/capacity], leading-attr, …”:

This format is similar to the C/V/G format with the ^ENTER_LF attribute except:
No trailing space padding or trimming occurs.

Rows and columns are specified.
Field capacity or newlines can cause a vertical scrollbar to appear.

Supported leading attributes are ^ENTER_LF (the default), ^ENTER_CRLF and ^NOWRAP.
The TEXT keyword will imply ^ENTER_LF unless ^ENTER_CRLF is specified.

^ENTER_LF (the default) causes the ENTER key to add LF characters to the data and to go to a new line left justified. The cursor will retrace the data when backspace or left-arrow is keyed, meaning the on-screen LF characters are represented by moving the cursor, instead of allowing it to rest on invisible LF characters.

^ENTER_CRLF may be specified in lieu of ^ENTER_LF. When that is the case, carriage returns entered are represented in the data as carriage-return-linefeed (CRLF) character pairs. ^NOWRAP may be specified to suppress word wrapping. When ^NOWRAP is active, data is entered on the current line until ENTER is keyed to go to the next line. Both horizontal and vertical scroll bars appear as needed.

Tabs are entered into the text. Shift-tab is ignored.

Home, End and the arrow keys all operate relative to the current line as opposed to operating on the text box as a whole.

Depressing the Control key causes the following keys to operate in the normal string entry mode:

*Enter – Returns control to the BR program
*Tab – Goes to the next control
*Shift-Tab – Goes to the prior control
*Home – Goes to the beginning of data or the first field
*End – Goes to the end of data or the last field
*Left-Arrow/Up-Arrow – Goes to the prior control
*Right-Arrow/Down-Arrow – Goes to the next control
* [[CurPos]] introduced.

A sample program to demonstrate TEXT entry is:
01000 ! Rep Text
01020 ! Test New Text Field Type
01040 dim TEXT$*300, TEXT$(1)*80
01060 print NEWPAGE
01080 rinput fields "3,10,text 4/40/300,uh": TEXT$
01100 print fields "10,10,c": TEXT$
01120 print TEXT$
01140 let STR2MAT(TEXT$, MAT TEXT$, CHR$(10))
01160 print MAT TEXT$

<noinclude>
[[Category:Format Specifications]]
[[Category:All Parameters]]
</noinclude>

Text

2018-07-09T17:05:07Z

GomezL: /* TEXT FIELD FORMAT */

Text

2018-07-09T17:04:02Z

GomezL: /* TEXT FIELD FORMAT */

== TEXT FIELD FORMAT==
As of 4.3

10 (R)INPUT FIELDS “row, col, TEXT rows/cols[/capacity], leading-attr, …”:

This format is similar to the C/V/G format with the ^ENTER_LF attribute except:
No trailing space padding or trimming occurs.

Rows and columns are specified.
Field capacity or newlines can cause a vertical scrollbar to appear.

Supported leading attributes are ^ENTER_LF (the default), ^ENTER_CRLF and ^NOWRAP.
The TEXT keyword will imply ^ENTER_LF unless ^ENTER_CRLF is specified.

^ENTER_LF (the default) causes the ENTER key to add LF characters to the data and to go to a new line left justified. The cursor will retrace the data when backspace or left-arrow is keyed, meaning the on-screen LF characters are represented by moving the cursor, instead of allowing it to rest on invisible LF characters.

^ENTER_CRLF may be specified in lieu of ^ENTER_LF. When that is the case, carriage returns entered are represented in the data as carriage-return-linefeed (CRLF) character pairs. ^NOWRAP may be specified to suppress word wrapping. When ^NOWRAP is active, data is entered on the current line until ENTER is keyed to go to the next line. Both horizontal and vertical scroll bars appear as needed.

Tabs are entered into the text. Shift-tab is ignored.

Home, End and the arrow keys all operate relative to the current line as opposed to operating on the text box as a whole.

Depressing the Control key causes the following keys to operate in the normal string entry mode:

*Enter – Returns control to the BR program
*Tab – Goes to the next control
*Shift-Tab – Goes to the prior control
*Home – Goes to the beginning of data or the first field
*End – Goes to the end of data or the last field
*Left-Arrow/Up-Arrow – Goes to the prior control
*Right-Arrow/Down-Arrow – Goes to the next control
* [[CurPos]] introduced.

A sample program to demonstrate TEXT entry is:
01000 ! Rep Text
01020 ! Test New Text Field Type
01040 dim TEXT$*300, TEXT$(1)*80
01060 print NEWPAGE
01080 rinput fields "3,10,text 4/40/300,uh": TEXT$
01100 print fields "10,10,c": TEXT$
01120 print TEXT$
01140 let STR2MAT(TEXT$, MAT TEXT$, CHR$(10))
01160 print MAT TEXT$

<noinclude>
[[Category:Field Specifications]]
[[Category:All Parameters]]
</noinclude>

Copy

2017-09-25T14:35:37Z

GomezL: /* Technical Considerations */

The '''Copy (COP)''' [[command]] copies one or more files in numerous ways:
# From one directory to another on the same or different disks.
# From one place on a directory to another place on the same directory. In this case you must give the resultant copy a different name.
# From a file to a printer.
# The -S option has been added to allow copying of a file which is currently open. The file to be copied must be opened for sharing ([[Shr]] or [[ShrI]]). If it is opened [[NoShr]], a file sharing violation error [[4148]] will occur when Copy with -S is attempted.

==Comments and Examples==

When using the copy command, you may specify a drive letter or number, and a path. You may also use [[wildcard characters]] '''?''' and '''*''' in place of alphanumeric characters in file names. [[Redirection symbols]] '''>''' and '''>>''' redirect screen output to a printer, a file, or another device.

The following command copies the file SAMPLE from the default directory of a disk in drive A to the default directory of a disk in drive B. The file name remains the same:

COPY A:SAMPLE B:

The next command copies the file SAMPLE from the subdirectory \TEST1 on a disk in drive A to the subdirectory \TEST2 on the same disk. If TEST2 does not exist as a subdirectory, Business Rules names the file TEST2 and places it in the default directory on the default drive:

COPY A:\TEST1\SAMPLE A:\TEST2

The following command copies SAMPLE from one place in the subdirectory \TEST1 on a disk in drive A to another place in the same subdirectory. The copied file is renamed SAMPLE1:

COPY A:\TEST1\SAMPLE A:\TEST1\SAMPLE1

The next command copies the file SAMPLE from the default directory of a disk in drive B to a printer attached to the first parallel port:

COPY B:SAMPLE PRN:

The same file can be copied to the printer at the first serial port with the following command:

COPY B:SAMPLE AUX:

The next command copies all files with names starting with SAMPLE, a period and any extension from a disk in drive A to a disk in drive B. The '''D''' in the command causes deleted records to be removed from any of the SAMPLE files which are internal files. The '''C''' in the command causes Business Rules! to prompt for a diskette change if the disk in drive B fills up before the copying process is completed.

COPY A:SAMPLE.* B: -DC

The following example copies the internal file SAMPLE from a disk in drive A to a disk in drive B, setting the record length of the new file at 128:

COPY A:SAMPLE B: -128

As of 4.2, COPY supports copying a print file unaltered to a printer:
COPY PRT\EDITLIST.255 DIRECT:/HP4

==Syntax==
COPY <from file> {[AUX:]|[PRN:]|[<to file>]} {[>[>]<output file>]|[PRINT]} [<[[copy option|-option]]>][-...]

[[Image:Copy.png]]

==Defaults==
# Copy the file, using the current file name, into the current directory on the current drive.
# Display a log of all performed actions in the [[command console]].

==Parameters==

Copy requires the '''from file''' parameter, which provides the information necessary for identifying the file or files you wish to copy.

After the '''from file''', you may specify the optional parameter '''to file''', which is the name (and path, if required) of the file you are creating.

'''PRN:''' allows you to copy the file indicated in the '''from file''' to the printer attached to the first parallel port on DOS systems. This string must be translated with the [[SUBSTITUTE]] specification in [[BRConfig.sys]] to specify the appropriate output device on [[Linux]] systems.

'''AUX:''' copies the '''from file''' file to the printer attached to the first [[serial port]]. This string must be translated with the SUBSTITUTE specification for Business Rules! Linux versions.

In place of the '''PRN:''' or '''AUX:''' parameters, you may also specify COM1:, COM2:, LPT1:, LPT2:, etc. to indicate the port to which your printer is attached (see the drive discussion in the Definitions chapter for more information). These device references will operate properly only on Business Rules DOS versions. They may be mapped to new references with the BRConfig.sys file's SUBSTITUTE specification.

The redirection symbol in the '''>file-ref''' parameter saves messages that normally appear on the screen to the specified file. The '''PRINT''' parameter sends these same messages to the printer rather than to the screen or a file.

'''Option''' may be one or more of several optional parameters. Such option(s) can follow the copy command when separated from the rest of the command with a dash:

{|
|-valign="top"
|width="10%"|'''-A'''||tells the system to copy only files that have the archive bit on. The system turns the archive bits in the original files off when the copying process is complete. This option applies to Business Rules! [[DOS]] versions only.
|-valign="top"
|width="10%"|'''-C'''||prompts for a diskette change if the disk is full.
|-valign="top"
|width="10%"|'''-D'''||omits deleted records from the copy, but responds only when used with internal files. It is important to rebuild all related index files after using this option.
|-valign="top"
|width="10%"|'''-N'''||prevents the screen from showing a log of performed actions.
|-valign="top"
|width="10%"|'''-P'''||causes scrolling to pause after a full screen of information has been displayed. (Press <CR> for next screen.)
|-valign="top"
|width="10%"|'''-S'''||option has been added to allow copying of a file which is currently open. The file to be copied must be opened for sharing (SHR or SHRI) if it is opened NOSHR, error [[4148]] (file sharing violation) will occur when COPY with the -S is attempted.
|-valign="top"
|width="10%"|'''-V'''||requires the operator to Verify each action before Business Rules! performs it.
|-valign="top"
|width="10%"|'''-#'''||represents output file record length. Internal file record lengths are shortened or expanded (with blanks) to match the number you indicate (version [[2.04]]+). When specified with other options, the record length must always be last.
|-valign="top"
|}

==Technical Considerations==
Prior to version [[3.0]] the -S switch meant preserve space. That syntax is no longer supported. -s now refers to file sharing as noted above.

COPY to a printer :DEVICE was being rejected. COPY to a PRN: or WIN: device is still illegal. (Use TYPE with redirection for PRN: and WIN:)

While the [Source] Directory is very flexible supporting *, *.* & *.*.* to include "All Files", the [Destination] Directory is less flexibe.

Examples:

Copy Source\* Destination
* This sample will copy all files to Destination - This is the preferred syntax for copy

Copy Source\* Destination\*
* This sample will copy all files to Destination but will Remove any Extension so "Sample.wb" will become "Sample"

Copy Source\* Destination\*.*
* This sample will copy all files to Destination but complex files like "Sample.wb.brs" will become "Sample.wb"

Copy Source\* Destination\*.*.*
* This sample will copy all files to Destination complex files like "Sample.wb.brs" will become "Sample.wb.brs" - Files with more "." would also be truncated.

==Client Server==

COPY filename @:filename (@ indicates Client system)

Copies filename TO client current directory

(Or specify @:pathname relative to client current directory.)

COPY @:filename filename

Copies filename FROM client current directory.

If you are trying to use [[absolute paths]] on the [[client]], specify @::

This is really most useful with [[OPEN:]] and [[SAVE:]] file selection browsers.

Use caution when using absolute paths on the client because [[permissions]] and [[file systems]] can be different from one computer to another.

Normally BR will use the [[startup directory]] to copy things and you can change this in the shortcut if needed.

<noinclude>
[[Category:Commands]]
[[Category:File Management Commands]]
</noinclude>

Copy

2017-09-25T14:34:44Z

GomezL: /* Technical Considerations */

TRANSLATE

2017-06-25T18:33:15Z

GomezL: Sample program to create a "Translate" file.

TRANSLATE=<file ref>
The "TRANSLATE=file-ref" parameter indicates that character translation is required for all input or output of C, V, G, N, ZD or PIC strings. The file-ref must identify either a 256- or 512-byte file. The first 256 bytes are used as an input translation table.

This optional parameter allows the translation of data to or from another collating sequence. Internally, all computers represent letters of the alphabet, punctuation marks and even digits according to an arbitrary numbering scheme. Today, the common coding schemes is ASCII (American Standard Code for Information Interchange). In the past, EBCDIC (Extended Binary Coded Decimal Interchange Code) was used, especially for main frames. Probably the most common use of the TRANSLATE= capability is translating files between ASCII and EBCDIC.

An example of the difference between ASCII and EBCDIC is that the uppercase letters A, B and C are represented by 65, 66 and 67 respectively in ASCII; but in EBCDIC, they are 193, 194 and 195. Also, in ASCII, the blank or space character is represented by the number 32 while in EBCDIC it is number 64. Although all systems that currently run Business Rules the ASCII coding scheme, some older computer systems use EBCDIC.

Used in [[Open]] statements: [[Open Display|Display]], [[Open Internal|Internal]], [[Open external|external]], and [[Open communications|communications]].

The translate table is made up of 256 characters starting with the replacement value for CHR$(0), and ending with CHR$(255).

See also the [[XLATE$]] internal function.

Sample Programs to create "TRANSLATE" tables:
* This program created a TRANSLATE table that will only allow "Common Characters", and filter out unwanted symbols. Tihs is commonly used when importing data from Electronic Data files.

00100 DIM Tbl$*512,Edi_Xlate$*512
00110 LET Edi_Xlate$ = Rpt$(" ", 32)&" !"&Chr$(34)&"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~*"&Rpt$(" ", 128)
00120 LET Edi_Xlate$(11:11)=Chr$(10) : LET Edi_Xlate$(14:14)=Chr$(13)
00130 LET Tbl$=Edi_Xlate$&Edi_Xlate$
00140 OPEN #1: "NAME=EDI_XLATE,RECL=512,replace",EXTERNAL,OUTPUT
00150 WRITE #1,USING 160: Tbl$
00160 FORM Pos 1,C 512
00170 CLOSE #1:
00180 END

<noinclude>
[[Category:All Parameters]]
</noinclude>

TimeOut

2017-01-26T14:54:59Z

GomezL:

The TIMEOUT error trap can be used with the WAIT parameter The WAIT= parameter on INPUT/RINPUT statements will trigger an error based on the [WAIT] settings.

<noinclude>
[[Category:Terminology]]
[[Category:Error Conditions]]
</noinclude>

4.31

2017-01-26T14:49:15Z

GomezL: /* Version 431ga */

Release Notes 4.31h

The prior versions were [[4.1]] and [[4.2]] and [[4.30]].

As Of 06/30/2015

===Version 430+zmf===
Added final keepalive send before turning off the copy_sort_index_sys_cmd flag. 
Revised SSL shutdown wait loop. 
Set SSL shutdown start time (this was causing a reconnect timeout because it wasn't set). 

Changed close listener wait from 5 seconds down to 2 seconds.

===Version 431===
Made connection status global. 
Prevented sending KB char to server when reconnecting. 
Level 14 logging of client-server messages (debug version only). 

===Version 431a===
Error [[413]] message (window not on top) clarified. 
Suppressed logging in checkSSL until CS version match established. 
Polished up source terms and spelling errors - no object affect. 
Revised order of Menu Display responses to brserver. 
Allowed BR MSG() keyboard function to work when Command Console is the active window. 

===Version 431b===
Corrected exit pre-processing for both normal and unattended modes. 
Changed "blank" references to "blanksPtr". 
Completely revised UNATTENDED_INPUT_CALL processing. 
Changed HTTP "Client-Inquiry" to "PAGE-URL". 
Added HTTP support for "PAGE-HEADER". 

Revised error messages that pertain to system errors to indicate as much. 
Added some DLL errors to the BRERR$ definitions file. 

Added support for getting cookies via http. 
Cleaned up some errors causing dumps during termination. 
Switched log information to message boxes for errors that occur while uploading the client DLL. 

Revised SYSTEM LOGOFF to not fail to zero session IDs when issued to BRSERVER.
This is to fix the problem where Windows reports active sessions where there is none, causing WSID's to be assigned incorrectly.

===br4.31ce===
Fixed the problem where NOWAIT was being ignored if OPTION 38 was on.

===Version 431d===
Removed DUPLICATE FLOWSTACK code. 
Revised ENDRUN processing of libraries .. set currentFileChain and currentScreenChain values during library PCB detachment. This fixed a problem detaching a NOFILES library. 
Lots of changes to run.cpp for flowstack processing and readability.

Changes from prior editions: 
*SQL and SYSERR fixes.
*Suppress error 867 on a radio button.
*Don't show LABELS, and BUTTONS in STATUS command when GUI is off.
*Removed an error trying to close an already closed window.

===Version 431d===
Removed DUPLICATE FLOWSTACK code. 
Revised ENDRUN processing of libraries .. set currentFileChain and CurrentScreenChain values during library PCB detachment. This fixed a problem detaching a NOFILES library. 
Lots of changes to run.cpp for flowstack processing and readability.

Changes from prior editions:
*SQL and SYSERR fixes.
*Suppress error 867 on a radio button.
*Don't show LABELS, and BUTTONS in STATUS command when GUI is off.
*Removed an error trying to close an already closed window.

Mismatched packets are ignored when:
*Ignore failure or keyboard return or we're terminating.
*Ignore failure is now on for cleanupNormalExits and closeWindowZero.
*When a flow stack error occurs, BR now returns error 9003.
*Current program name is stored on the client in a global when the status line is updated.

Corrected processing mismatched packets for CALL_FUNCTION_NULL_ACTION. 
Added transfer of current line number to client.

===Version 431e===
Revised remote.cpp ignoring of unmatched packets. 
Polished up the transfer of program name and line number to the client. 
Renamed clientOnly to ignoreFailureClientOnly 

Added error [[0738]] - SELECT should be a trailing attribute. 
This error occurs when SELECT is used as a leading attribute without the ^.

===Version 431f===
Added path to log message referencing brCrashDumpUploader. 
Added support for DEBUG INTERNAL COREDUMP_SERVER. 
Now we pass currentUserLineNumber to client in all models. 

===Version 431fb===
If an invalid trailing attribute is allowed via OPTION 38 BR was occasionally dumping. 
Keepalive timeouts are prevented when sitting in a message box. 

===Version 431fc===
Created and applied MINOR_IO_ERROR (valued at 3). This relates to log levels.

===Version 431fe===
Ignore mismatched packets on menu display. 
Suppress timeout during MSGBOX call. 
Fix 2D control header font colors. 
Removed V42 references. 
Fixed a problem re loading library modules RELEASE. 
Corrected logging before DLL loaded. 

===Version 431ff===
Revised PIC processing.

===Version 431fg===
Revised PIC, and DATE processing to test formatted field capacity when inserting characters. (FMT runs only in overtype mode so it isn't affected.) 
Statusline ROWCOL now defaults to off. 

===Version 4.31g===
Upgrade to VS 2010. 
Fixed problem with license verification only to first decimal point of version number. 
Change made to prevent looping during shutdown. 
Client changed to let the server determine whether or not to terminate. 
Graceful client shutdown. See build notes for details. 

===Version 431ga===
Removed UPGRADE code flag from source. 
Fixed date problem that was created by recent FMT and PIC revisions. 
KREC is updated during printing only when the PUSH level is zero. 
For HTTP client, the log data showing CURL information was extended. 
The HTTP client now does a GET if no printing occurs prior to a LINPUT. 
A display parameter was added to the fldedit function. This function is used
by FMT, PIC DATE and other field types to see if typing is done in excess of field capacity. 

===Version 4.31gc===
More detail is provided when a database connection attempt is unsuccessful. 
Corrected failures pertaining to deleting characters in non-currency PIC masks, especially with backspace. 
ENV$ and STATUS ENV search strings are now enhanced. See the wiki for details.
Internal documentation updated. 

===Version 4.31h===
Removed references to abort. Used CANCEL instead. 
Error 370 was dropping the program file during a REPLACE where OPTION 60 was on and the program contained 4.2+ statements. This is fixed. 
The XLATE system function was extended to support translation to and from UTF-8. 
Added error 438 "Input String not valid UTF-8 format." 
Removed system functions UPSI, LINEBUFFER, XPOS, CFIELDS$, and CHYRON$. 
Days(date("H:M:S"),"H:M:S") was producing a date with the first day of the current month. This was changed to the current day. 
RINPUT was positioning the cursor according to the previous Input. This was fixed. 
The Web Server support now does not tamper with binary data. It was converting to UTF-8. 
An internal pointer was adjusted to prevent crashes when the stack overflows. 
Default stack sizes were revised.
work_size = 500000, /* work stack size */
flow_size = 100, /* flow stack size */
rpn_size = 1000, /* rpn stack size */
for_size = 100; /* for-next stack */

[[Category:Release 4.3]]
[[Category:Release Notes]]

4340

2017-01-26T14:48:30Z

GomezL:

{{Error
|4340
|([[4.2]]+) An HTTP error has occurred / ([[4.16]]-) Novell error 140
|In BR! version [[4.20]], This error code was re-introduced to be used in conjunction with the [[SysErr]] and [[SysErr$]]. It indicates that an error occurred in the underlying operating system. Reference SysErr$ for a description of the actual error.

As of BR! version 4.16 This Novell error no longer exists.

|Use the SysErr & Syserr$ to troubleshoot the errors. The HTTP interface in Business Rules uses the CURL library, and these errors should be documented in the Curl Site.
}}
[[Category:Error Codes]]

DATABASE

2017-01-23T20:20:23Z

GomezL: /* ODBC-MANAGER */

In version 4.3 and higher [[CONFIG]] DATABASE may use one of 3 methods for connecting to SQL Sources:
*DSN
*CONNECTSTRING
*ODBC-MANAGER

===DSN===
Syntax:
CONFIG DATABASE <db-ref> DSN=<dsn-ref> [, USER= <department> | LOGIN_NAME | ? ] [, {PASSWORD= <dept-password> | BR_PASSWORD | ? } | PASSWORD=<encrypted-password> ]
The ? indicates prompt

Example:
EXECUTE 'CONFIG DATABASE CLS_Data DSN="MyData"'

===CONNECTSTRING (DSN Less)===
Syntax:
CONFIG DATABASE <db-ref> CONNECTSTRING="<Driver>={Microsoft Access Driver (*.mdb)} DBQ=C:\inetpub\wwwroot\BegASP\Chapter.14\Contact.mdb"

'''Sample Connection Strings:'''

Using a SQL Server /w SQL Login:
CONFIG database db-ref connectstring="DRIVER=SQL Server;SERVER=server;Initial Catalog=database;UID=username;PWD=password"

"db-ref" is the database reference.
"server" is the SQL Server [FQDN] or IP Address
"database" is the [SQL Server Database]
"username" is the [SQL Server User Name]
"password" is the [SQL Server Password]

Using a SQL Server /w Windows Authentication:
CONFIG database db-ref connectstring="DRIVER=SQL Server;Initial Catalog=database;Persist Security Info=True;MultipleBC_TableResultSets=True; Database=database;SERVER=server;Login Name=username;Password=BR_PASSWORD"

"db-ref" is the database reference.

"server" is the SQL Server [FQDN] or IP Address

"database" is the [SQL Server Database]

"username" is the [SQL Server User Name]

BR_PASSWORD will use the users Active Directory password to connect to the SQL Server.

"SQL Server" is one of several choices for SQL Server, another choice would be SQL Server Native Client 11.0

===ODBC-MANAGER===
Syntax:
CONFIG DATABASE <db-ref> ODBC-MANAGER

Using ODBC Manager as the parameter will allow the end user to select the desired data source.

The following is a sample program that will use the ODBC-MANAGER to identify the proper connection string.
* Note: This will not work in Client Server

00010 PRINT Newpage
00011 IF Env$("br_model")="CLIENT_SERVER" THEN PRINT "Warning, you cannot connect to ODBC-MANAGER in Client Server Mode"
00020 EXECUTE "Config Database Test_DB ODBC-MANAGER" ERROR CONNECT_ERROR
00030 PRINT "Connection String is:" !:
PRINT Env$("STATUS.DATABASE.[TEST_DB].CONNECTSTRING")
00099 STOP
00100 CONNECT_ERROR: !
00110 PRINT "Error Connecting - Err:";Err;" Line:";Line;" Syserr:";Syserr$

[[Category:All Parameters]]

DATABASE

2017-01-23T20:19:25Z

GomezL: /* ODBC-MANAGER */

In version 4.3 and higher [[CONFIG]] DATABASE may use one of 3 methods for connecting to SQL Sources:
*DSN
*CONNECTSTRING
*ODBC-MANAGER

===DSN===
Syntax:
CONFIG DATABASE <db-ref> DSN=<dsn-ref> [, USER= <department> | LOGIN_NAME | ? ] [, {PASSWORD= <dept-password> | BR_PASSWORD | ? } | PASSWORD=<encrypted-password> ]
The ? indicates prompt

Example:
EXECUTE 'CONFIG DATABASE CLS_Data DSN="MyData"'

===CONNECTSTRING (DSN Less)===
Syntax:
CONFIG DATABASE <db-ref> CONNECTSTRING="<Driver>={Microsoft Access Driver (*.mdb)} DBQ=C:\inetpub\wwwroot\BegASP\Chapter.14\Contact.mdb"

'''Sample Connection Strings:'''

Using a SQL Server /w SQL Login:
CONFIG database db-ref connectstring="DRIVER=SQL Server;SERVER=server;Initial Catalog=database;UID=username;PWD=password"

"db-ref" is the database reference.
"server" is the SQL Server [FQDN] or IP Address
"database" is the [SQL Server Database]
"username" is the [SQL Server User Name]
"password" is the [SQL Server Password]

Using a SQL Server /w Windows Authentication:
CONFIG database db-ref connectstring="DRIVER=SQL Server;Initial Catalog=database;Persist Security Info=True;MultipleBC_TableResultSets=True; Database=database;SERVER=server;Login Name=username;Password=BR_PASSWORD"

"db-ref" is the database reference.

"server" is the SQL Server [FQDN] or IP Address

"database" is the [SQL Server Database]

"username" is the [SQL Server User Name]

BR_PASSWORD will use the users Active Directory password to connect to the SQL Server.

"SQL Server" is one of several choices for SQL Server, another choice would be SQL Server Native Client 11.0

===ODBC-MANAGER===
Syntax:
CONFIG DATABASE <db-ref> ODBC-MANAGER

Using ODBC Manager as the parameter will allow the end user to select the desired data source.

The following is a sample program that will use the ODBC-MANAGER to identify the proper connection string.
* Note: This will not work in Client Server *

00010 PRINT Newpage
00011 IF Env$("br_model")="CLIENT_SERVER" THEN PRINT "Warning, you cannot connect to ODBC-MANAGER in Client Server Mode"
00020 EXECUTE "config database Test_DB ODBC-MANAGER" ERROR CONNECT_ERROR
00030 PRINT "Connection String is:" !:
PRINT Env$("STATUS.DATABASE.[TEST_DB].CONNECTSTRING")
00099 STOP
00100 CONNECT_ERROR: !
00110 PRINT "Error Connecting - Err:";Err;" Line:";Line;" Syserr:";Syserr$

[[Category:All Parameters]]

Encryption

2017-01-19T01:33:42Z

GomezL: /* Asymmetric Encryption */

(As of 4.30)

'''Encryption''' encompasses a number of different operations. These operations can be used independently or in combination to meet different needs. We use industry standard encryption available through OpenSSL. Three technologies are widely used for encrypting data. BR supports the first two listed below through its [[ENCRYPT]] and [[DECRYPT]] [[internal functions]].

==Overview of Two Encryption Methods==

1. '''Symmetric key ciphers''' – where the same key is used to encrypt and decrypt data. You can specify a key to encrypt some data and later use the same key to decrypt the data.

2. '''Hashing routines''' – one way routines that take data and convert it to a hash value. Sometimes these are thought of as checksums such as MD5 sum. Hash values are always the same length regardless of how big the hashed data is. A 10 gb file will have a hash result that is the same length as a 200 byte file. Hashing routines have a number of specific uses, including:
*Verify that data has not changed.
*Verifying that two files are the same.
*Validating passwords – this is based on the concept that if two values have the same hash value the values are equal. Using this technique improves security because it allows a server to store passwords in an unrecoverable format. Even the server software is unable to regenerate the original password. It is only capable of checking if the hash of a password matches the stored password hash.

==Symmetric Key Ciphers==
There are two encryption functions in the BR language, [[ENCRYPT$]] and [[DECRYPT$]].

ENCRYPT$(Data$ [,Key$ [,Encryption-type$ [,Initialization-vector$]]])
DECRYPT$(Data$ [,Key$ [,Encryption-type$ [,Initialization-vector$]]])

Data$ - The data to be encrypted

Key$ - The secret key to be used for encryption. If not specified this value will come from an OPTION 66 statement.

Encryption-type$ - The type of encryption to be done. If not specified, a common high strength encryption type will be employed. This is described in more detail below, but is generally only useful for interfacing with other typically non-BR programs.

Initialization-vector$ - This is an arcane part of encryption standards. It exists to prevent attackers from being able to tell whether the unencrypted data has changed. This is described in more detail below, but is general only needed when interfacing with other non-BR programs.

== Interfacing With Other Programs (encryption type and initialization vector)==
There are a number of different types of encryption that BR supports through OpenSSL: AES, BLOWFISH, DES, triple DES, RC4 and RC2. Most symmetric key ciphers are block ciphers meaning that they encrypt one block at a time. This means if you have a bit message, it is broken up into multiple blocks and each block is encrypted. The block size can be set as (128, 192, 256) bits. Some encryption types don't support all of these values so STATUS ENCRYPTION should be checked to see what encryption types are available in BR. Besides block size, there are also various schemes for blocking data. One might expect that using 256 bit blocking would simply take every 32 bytes and call it a block. This is not done though because there is a possibility that this would cause patterns in the encrypted data. To prevent this, there are various schemes known as codebooks which change the way data is blocked. Wikipedia explains this in more detail. If the encryption type is not specified AES:256:CBC:128 will be used. To be compatible with other programs the entire encryption type must be specified (cipher: key length: codebook: initialization vector length).

Initialization-vector – this is used to cause the same data encrypted with the same key to have a different encrypted result. This is significant because otherwise an attacker looking at data seeing the same encrypted result twice would know that the key and the unencrypted data have not changed. Regardless of whether or not you are concerned about this potential security issue, the standard encryption methods require this value so interfacing with other programs may require you to use it. It is a common practice to use a random number for this value and store the value at the beginning of (ahead of) the encrypted result. This is what BR does if this parameter is omitted.

As an example:
ENCRYPT$(“test”,“key”)
Produces a string containing “random number initialization vector”&”encrypted result”.

If the initialization vector is explicitly specified as in:
ENCRYPT$(“test”,“key”,“AES:256:CBC:128”,“RANDOM”)
the result would be simply “encrypted result”.

DECRYPT$ has the same arguments as ENCRYPT$ with the exception of the first parameter which is the encrypted data. DECRYPT$ expects to be used with the same key$, encryption-type$, and initialization-vector$ as was used to encrypt the data. As with ENCRYPT$, if key$ is not specified, the value from the OPTION statement will be used. If encryption-type$ is not specified, “AES:256:CBC:128” will be used. If the initialization vector is not specified, it will be assumed that the encrypted data starts with an initialization vector.

==Hashing Routines==
Three common forms of hashing are allowed in BR. They are MD5, SHA, and SHA-1. These are also provided through the ENCRYPT$ function specifying a null key$ value:

ENCRYPT$(data$, “”, “MD5”) ENCRYPT$(data$, “”, “SHA”) ENCRYPT$(data$, “”, “SHA-1”)

Hashing is also referred to as Message Digests or digests. This is what the MD in MD5 means. There is no way to restore data that has been hashed. Hashing is a one way function so DECRYPT$ will yield an error.

==Asymmetric Encryption==
Asymmetric key encryption is also known as public/private key encryption.

Public/private keys are created as a pair by a key generator. They are a pair, and it is not possible to have two public keys for the same private key or vice versa. With regard to public/private key pairs, what one key encrypts the other key can decrypt, and neither key can decrypt what it has encrypted. When a private key is used to encrypt data, the result is called a signature because everyone who has the public key can decrypt it.

This technique is used for:

Signing (using certificates) – A private key can be used to sign data. The result of such signing can be tested/validated with the corresponding public key.

Data encryption – A public key can be used to encrypt data. This data can then only be decrypted by the corresponding private key.

Hashes and signing are different but used together. Rather than signing a large block of data which would create a large signature, only the hash is signed to create much smaller fixed length signature data. When verifying a large block of signed data, the data is used to create a hash value and the hash value is compared to a decrypted signature.

Asymmetric encryption is not accessible through the BR ENCRYPT$, DECRYPT$ functions. However, it is used by our SSL client server connections and HTTPS. Certificates are most commonly used by SSL and HTTPS and are less useful for other application processes.

In the Client Server model the client knows the server’s public key and the server uses its private key to encrypt and decrypt. BRclient.exe connects to BRListener.exe by opening an SSL socket on the server using DHE_RSA-AES256-SHA Encryption. Handshaking is performed using a private key stored on the server within BRListener. Once authenticated, the socket is then passed to BRServer.exe for actual data processing.

Encryption is invoked by Business Rules HTTP support as follows:

CONFIG HTTPS PORT port-number [ LOG file-pathname ]
CONFIG OPTION 66 private-key-file-encryption-password
OPEN #400: “HTTP=SERVER”, DISPLAY, OUTIN

The BRSERVER executable directory must contain two files:

https-private.pem
https-cert.pem

These files are made by the following commands under Linux, MAC and cygwin for Windows: openssl req -new -x509 -out httpserver.pem -days 10000

(this will prompt for the OPTION 66 password)

mv privkey.pem https-private.pem
mv httpserver.pem https-cert.pem

This port specific service can then be accessed with browsers. When the specified port is accessed through a browser, BR establishes an HTTPS connection rather than an HTTP connection.

==Signing and Certificate Processing Industry Standards==
The purpose of certificates is to verify the authenticity of unencrypted data.

Certain companies are authorized by the government to act as a Certificate Authority (CA). These companies (e.g. Verisign) issue electronic certificates which can be used to issue second level certificates. Certificates can have expiration dates and the line of authority extends from a CA to any number of levels (but a chain is only as strong as its weakest link). Certificates contain a list of signatures (described below) that trace back to a CA as follows:

When a company needs to obtain a certificate from a CA, it prepares its own certificate and sends it to the CA for signature. Creating a certificate requires the pre-production of a private and public key pair. The certificate text properly identifies the signing authority, the owner of the certificate, and the owner’s public key. The signing authority externally verifies the identity of the owner before signing it. The CA provides the signature and the CA’s own public key for validating it.

Browsers know the CA identities and their public keys. A browser can verify a CA signed cert by hashing it, decrypting the signature with the known public key and matching the decrypted signature against the hash total.

Any company that is issued a (self-prepared authority signed) certificate by a CA can sign second level certificates issued to third parties. A second level cert contains the parent (CA issued) certificate, and includes the public keys of the issuer and the recipient. The signature is essentially the encrypted hash total of ‘itself plus all of its ancestors’. Additional levels each contain the chain of certificates leading from a CA issued cert to itself. By including public keys along with the identities of the owners, certificates become tools for validating the signatures of their owners. When signed data (with an encrypted hash total) is sent to clients the signatures insure that the data has not been altered along the way.

Ostensibly, a certificate cannot be counterfeited because it requires the signature of its parent which can only be produced with its parent’s private key. By providing both public keys ( signer and recipient ) in all certs along with signatures, a non-forgeable or alterable chain is established.

====Example:====
CA public key – known to browser
certificate 1 (signed by CA – contains owner’s public key)
certificate 2 (signed by second level - includes certificate 1 - contains owner’s public key)
final certificate (signed by third level - includes certificate 2 - contains owner’s public key)

A browser would find the CA information in the certificate and check to see if it is in the browser’s internal list. If not, it fails. Then it verifies that certificate 1 (which ends up being part of the final certificate) has been signed by the CA. After that it checks certificate 2 and verifies that it has been signed by the owner of certificate 1. Finally it checks the final certificate and verifies that it has been signed by the owner of certificate 2.

To assure the line authority of any certificate, the public keys are associated with signers, not with documents.

<noinclude>
[[Category:Definitions]]
</noinclude>

SQL

2017-01-16T19:40:10Z

GomezL: /* SQL Date Format Functions */

SQL manages data via a relational data management system. As of 4.3, BR includes several special ways of working together with SQL.

====CONFIG DATABASE db-ref ODBC-MANAGER====
CONFIG [[DATABASE]] db-ref ODBC-MANAGER will invoke the ODBC Manager to define or identify a file DSN. Once this is done you can issue the command [[STATUS]] DATABASE –P to see the connect string that the ODBC Manager used to make the connection. Thereafter you can use that connect string to establish the connection to the database as follows:

CONFIG DATABASE db-ref CONNECTSTRING="Driver={Microsoft Access Driver (*.mdb)}DBQ=C:\inetpub\wwwroot\BegASP\Chapter.14\Contact.mdb"
- or -
CONFIG DATABASE db-ref DSN=’dsn-ref ‘

;Additional Optional Parameters:

[, USER= department | LOGIN_NAME | ? ]
[, {PASSWORD= dept-password | PASSWORDD=encrypted-passwd | BR_PASSWORD | ? ]

Where '''?''' indicates prompt and '''BR_PASSWORD''' indicates the password used during client login. If running the standard model (not client-server) then this is equivalent to "?". '''encrypted-passwd''' is the DB password encrypted with the key stated in OPTION 66.

'''CONFIG DATABASE MAX_COLUMN_WIDTH nnnn'''
Some database column types are variable length. SQL requires advanced buffer allocation. This would unnecessarily tax the system if not restricted. This statement sets a maximum width for all columns. Memory is allocated to the minimum of (this amount or the column width). "nnnn" is the maximum column width. The default is 2000 characters.

''''CONFIG DATABASE CLEAR { db-ref | ALL }'''
This will close the specified database or all open databases.

'''Sample Connection Strings:'''

Using a SQL Server /w SQL Login:
CONFIG database db-ref connectstring="DRIVER=SQL Server;SERVER=server;Initial Catalog=database;UID=username;PWD=password"
db-ref is the database reference.
server is the SQL Server [FQDN] or IP Address
database is the [SQL Server Database]
username is the [SQL Server User Name]
password is the [SQL Server Password]

Using a SQL Server /w Windows Authentication:
CONFIG database db-ref connectstring="DRIVER=SQL Server;Initial Catalog=database;Persist Security Info=True;MultipleBC_TableResultSets=True; Database=database;SERVER=server;Login Name=username;Password=BR_PASSWORD"
db-ref is the database reference.
server is the SQL Server [FQDN] or IP Address
database is the [SQL Server Database]
username is the [SQL Server User Name]
Note that BR_PASSWORD will use the users Active Directory password to connect to the SQL Server.
Note that "SQL Server" is one of several choices for SQL Server, another choice would be SQL Server Native Client 11.0

====OPEN statements====

OPEN #20: "DATABASE= db-ref", SQL "sql-statement", OUTIN
- or -
OPEN #20: "DATABASE= db-ref, Name= filename" , SQL, OUTIN
Where filename refers to a DISPLAY file containing a SQL statement that gets executed when a WRITE statement is processed.

Example:
OPEN #20: "DATABASE=MyData",SQL "SELECT FILENO,BALANCE from MASTER WHERE FILENO=?",OUTIN

====Sequence of Operations====
#Begin processing with a WRITE statement.
#If the WRITE contains an IO list of values then it is used to populate the SQL before it is executed. In this process IO list values replace question marks positionally from left to right. These question marks only work with SQL arguments that refer to stored data. Question marks cannot be specified where SQL keywords or table column names appear.
#Resulting SQL may or may not produce a result set. If it does, the result set may be processed like a BR file opened RELATIVE. Some operations that use file positioning may be slow since the whole result set may not be in memory immediately. Simple sequential access should be fairly quick.
#Once SQL has been populated by an IOlist, it may be reused with the same values by issuing a WRITE with no IOlist.
#READ IOlist variable associations are positional with each READ accessing one row of values.

===SQL Date Format Functions===

A$=SQL_DATE$(BR-date-string,"format-mask") ! format date for storage
B$=BR_DATE$(SQL-date-string,"format-mask") ! unpack DB date value

* Note: SQL DATETIME fields are "Packed for Storage", but "DATE" fields are returned as a CCYY-MM-DD string in a SQL Query. DATE returns "BLANK" for "Empty or Null Date"

===SQL Table Interrogation===

'''ENV$(STATUS)''' has been extended to interrogate database connections and ODBC data sources. A program called ENVDB.BRS (listed below) has been written to demonstrate how this extension works and to show how to setup linkage to a database or ODBC data source. Run the program as is to bring up the Microsoft ODBC manager. Then select a data source and look at the output from the program. This will also show you how to get and use connect strings. In this example lines 1900 and 2000 accomplish the same open as line 1800 in my environment.

Try it on your Windows workstation. As long as you have one or more ODBC drivers supported you can use it without having to install a database. You can even use it to interrogate Excel files because Microsoft provides an ODBC driver for that.

A sample program to demonstrate database interrogation entry is:
01000 ! Replace Envdb
01100 dim DATABASES$(1)*100
01200 dim DATABASE$*100
01300 dim TABLES$(1)*100
01400 dim TABLE$*100
01500 dim COLUMNS$(1)*100
01600 dim COLUMN$*100
01700 dim C$*100,FLD1$*40,FLD2$*40,FLD3$*40,FLD4$*40
01800 Execute "CONFIG database testdb odbc-manager"
01900 ! Execute "CONFIG database testdb DSN='Accounts Payable'"
02000 ! Execute "CONFIG database testdb connectstring=""DSN=Excel Files;DBQ=L:\orders\Beneficial PORCEL.xls;DefaultDir=L:\orders;DriverId=1046;MaxBufferSize=2048"""
02100 open #1: "name=envdb.txt,replace",display,output
02200 Dump_Table: ! ***** Dump Table Layout
02300 let OUTFD = 1
02400 let ENV$("status.database.LIST", MAT DATABASES$) !List of db's
02500 for DATABASE=1 to UDIM(DATABASES$) !For each connected database
02600 let DATABASE$=DATABASES$(DATABASE)
02700 let FNSHOW_DATABASE(DATABASE$, "status.database."&DATABASE$)
02800 next DATABASE
02900 end
03000 !
03100 def FNSHOW_DATABASE(DATABASE$*100, ST_PREFIX$*100)
03200 print #OUTFD: DATABASE$
03300 let OUT_PREFIX$=CHR$(9)
03400 print #OUTFD: OUT_PREFIX$&"DSN="&ENV$(ST_PREFIX$&".DSN")
03500 print #OUTFD: OUT_PREFIX$&"CONNECTSTRING="&ENV$(ST_PREFIX$&".CONNECTSTRING")
03600 print #OUTFD: OUT_PREFIX$&"Tables:"
03700 let ST_PREFIX$=ST_PREFIX$&".TABLES"
03800 let ENV$(ST_PREFIX$&".LIST", MAT TABLES$)
03900 for TABLE = 1 to UDIM(MAT TABLES$)
04000 let TABLE$=TABLES$(TABLE)
04100 let FNSHOW_TABLE(TABLE$,ST_PREFIX$&"."&TABLE$,OUT_PREFIX$&CHR$(9))
04200 next TABLE
04300 fnend
04400 !
04500 def FNSHOW_TABLE(TABLE$*100, ST_PREFIX$*100, OUT_PREFIX$)
04600 print #OUTFD: OUT_PREFIX$&TABLE$
04700 let OUT_PREFIX$=OUT_PREFIX$&CHR$(9)
04800 print #OUTFD: OUT_PREFIX$&"Table remarks="&ENV$(ST_PREFIX$&".REMARKS")
04900 print #OUTFD: OUT_PREFIX$&"Table type="&ENV$(ST_PREFIX$&".TYPE")
05000 print #OUTFD: OUT_PREFIX$&"Columns:"
05100 let ST_PREFIX$=ST_PREFIX$&".COLUMNS"
05200 let ENV$(ST_PREFIX$&".LIST", MAT COLUMNS$)
05300 for COLUMN = 1 to UDIM(MAT COLUMNS$)
05400 let COLUMN$=COLUMNS$(COLUMN)
05500 let FNSHOW_COLUMN(COLUMN$, ST_PREFIX$&"."&COLUMN$,OUT_PREFIX$&CHR$(9))
05600 next COLUMN
05700 fnend
05800 !
05900 def FNSHOW_COLUMN(COLUMN$*100, ST_PREFIX$*100, OUT_PREFIX$)
06000 print #OUTFD: OUT_PREFIX$&COLUMN$
06100 let OUT_PREFIX$=OUT_PREFIX$&CHR$(9)
06200 print #OUTFD: OUT_PREFIX$&"Column type="&ENV$(ST_PREFIX$&".TYPE")
06300 print #OUTFD: OUT_PREFIX$&"Column length="&ENV$(ST_PREFIX$&".LENGTH")
06400 print #OUTFD: OUT_PREFIX$&"Column decimals="&ENV$(ST_PREFIX$&".DECIMALS")
06500 fnend

===Other===
For more information about '''SQL''' or '''Structured Query Language''' see [[Wikipedia:SQL]].

<noinclude>
[[Category:Terminology]]
[[Category:SQL]]
</noinclude>

4.30

2017-01-16T19:40:01Z

GomezL: /* SQL Date Format Functions */

Status: [[Beta]]

The prior versions were [[4.1]] and [[4.2]].

As Of 08/30/2012

==MISCELLANEOUS ENHANCEMENTS==

“ON error-type IGNORE” now ignores the error instead of going to an Ignore label. This is effective for both ON statements and individual statement error exits. This could change the way your programs work if your Ignore statements do more than CONTINUE.

The general purpose ERROR exit implies SOFOW truncation. So statements that are governed by ERROR IGNORE also do SOFLOW truncation as needed.

For client / server configurations:
SPOOLPATH @: client-pathname
Sets the remote spool path on the client. In addition to regular spool files, this is where PDF files are created. SPOOLPATH can be set concurrently for both client and server by specifying two SPOOLPATH statements. The @: indicates remote.

The client-pathname has some unique characteristics:
Paths are assumed to be OS pathnames relative to the CLIENT_CURRENT_DIR folder, or the startup directory if CLIENT_CURRENT_DIR is not specified.
If a full pathname is specified it must begin with a colon. ( e.g. @::X:\path ) Otherwise it will be preceded with the path to the client current working directory.
Specifying a relative remote pathname is not compatible with CLIENT_CURRENT_DIR SYNC.
The status of SPOOLPATH and REMOTESPOOLPATH settings are displayed in response to the STATUS SUBSTITUTE command.

CHR$(6) is a field separator that displays as a space but causes the immediately preceding data to be right justified. This applies to both Native Windows Printing and PRINT FIELDS.

MAT2STR, STR2MAT changes to trim outside of quotes, but not inside of quotes and to always quote MAT2STR when quotes are present.

STATUS USERS will display the WSID and name of each user logged in on the network.
The SQL statement SHOW USERS responds with the same information for ODBC users.

BRERR$ is a new system function that display the description of BR ERR value.
BRERR$(error-code) returns the description of that code.
Examples-
When ERR returns 4270, BRERR$ will return “end of file”.
BRERR$(0875) returns “unrecognized data after field specification”

For making it easier to configure ODBC with BRconfig.sys and to setup common configuration files for multiple platforms we have added:
@LINUX
@WINDOWS
@MAC
@ODBC

For example, this could be important for DRIVE statements:
@LINUX DRIVE C:,/unix/path,.,\
@WINDOWS DRIVE C:,\\server\path,.,\

Programs compiled with older versions of BR (3.3 – 3.8) can be listed accurately.

=== GRID AND LIST CHANGES===

Arrays are automatically resized when receiving data from 2D INPUT operations. This also applies to grouped arrays. Automatic resizing only applies to one dimensional arrays and does not occur when INPUTing into two dimensional arrays.

e.g. INPUT FIELDS "row,col,LIST rows/cols, ROW, ALL" : ( MAT Array1$,
MAT Array2$, MAT Array3, MAT Array4, MAT Array5$ )
Where all arrays are one dimensional and may have the incorrect number of elements.

==== Three New Read Types====
Notes-
Auto Resizing applies
Selection Type must be ALL

The original 2D INPUT read types are:
CNT - The number of cells specified.
SUB - Read the Cell Subscript Values.
CELL - Read each cell specified.
ROWCNT - The number of rows specified.
ROWSUB - The subscripts of the specified rows.
ROW - Read all cells in each specified row.

HEADERS – The original PRINT FIELDS HEADER values.
e.g. INPUT FIELDS "row,col,LIST rows/cols, HEADERS,,NOWAIT" :
(MAT HEADINGS$,MAT WIDTHS, MAT FORMS$)

COLCNT - The number of columns established by the header arrays.
e.g. INPUT FIELDS "row,col,LIST rows/cols, COLCNT, ALL" : numeric-variable

These are for generalized library routines to inspect passed controls.

SORT_ORDER - Provides a value of zero for each unsorted column and gives
the ascending sequence of column sorts that have occurred. If a column has
been reversed (double sorted) it's value will be negative.

e.g. INPUT FIELDS "row,col,LIST rows/cols, SORT_ORDER, ALL" : numeric-array
Given the following history of sorting a four column GRID:
column 1 (descending most rescent)
column 2 (ascending first sorted)
column 3 (not sorted)
column 4 (sorted ascending)

SORT_ORDER would return-
array(1) -> -1
array(2) -> 3
array(3) -> 0
array(4) -> 2

=== Restoring a User Sorted 2D Control===

The syntax for sorting an array is currently:

PRINT FIELDS "nn,nn,GRID 10/40,SORT": { column number }

This has been extended to allow a numeric array of instead of a scalar. If an array is given, it is assumed to be in the same format that SORT_ORDER returns. The new format is:

PRINT FIELDS "nn,nn,GRID 10/40,SORT": { column-number | numeric-array }

Where the numeric-array has one element for each column left to right. BR will resort the columns in the requested order.

The numeric array values indicating the order of column sorting to be performed do not need to exactly match the standard format. e.g Fractions are allowed, the values can fall within any range, and there does not need to be trailing zero elements for unsorted columns.

=== A new Read Qualifier is available.===
[[Displayed_Order]] introduced

===Masked 2D Display===

LIST and GRID support the MASK operation-

PRINT FIELDS "row,col,LIST rows/cols,MASK" : mask_array

This restricts the rows (for both LIST and GRID) previously displayed to those corresponding to a “true” value in mask_array. A true value is represented in a umeric array as a value greater than zero. Negative values are not allowed in mask arrays. A string mask array may also be used with “T” and “F” values. The MASK stays in effect until 1) a new MASK is specified or 2) the contents of the control are changed with PRINT ( =, +, - see Output Operations in New Console.DOC).

INPUT FIELDS "row,col,LIST rows/cols,MASK [,NOWAIT]" : mask_array
This reads the display mask setting for a 2D control.

The mask array affects only the user presentation.. not the result set. Use RANGE processing or the CHG selection type to selectively read from a 2D control.

== New Search Field Type: Filter ==

See [[Filter]]
== New Config: Filter_Delimiters ==

See [[Filter_Delimiters]]

== FIELDS CHARACTER BY CHARACTER KEYBOARD CONTROL==

[[^KeyStroke and ^DataChg]] introduced.

== RANGE SELECTION TYPE==

Valid current selection types are:
SEL - Read one or more selected items.
SELONE - Select only one item.
ALL - Read all items in the control (except headings).
CUR - Current cell or row number.
CHG - All cells or rows who’s values have been changed by the operator.

BR now supports the following additional selection types:
RANGE - Specifies which portion of a 2D control is to be input.
CELL_RANGE – A special type of output range.

=== RANGE Input===

In the following examples BR will redimension the receiving arrays as needed:

INPUT FIELDS "row, col, LIST rows/cols, CELL, RANGE" : start, end, MAT Data$

This reads the specified range of cells. BR redimensions MAT Data$ as needed. Note that CELL may now be used with LIST. Previously, LISTs were only addressable by row.

INPUT FIELDS "row, col, LIST rows/cols, ROW, RANGE" :
(start:=7), (end:=11), ( MAT Array1$, MAT Array2, MAT Array3$ )

This reads the cells in rows 7 through 11. The receiving arrays are redimensioned as appropriate.

INPUT FIELDS "row, col, GRID rows/cols, ROW, RANGE" :
MAT start, MAT end, ( MAT Data1$, MAT Data2$, MAT Data3 )
This reads one or more ranges of rows.

A more detailed example of this is:
100 -- create and populate a LIST control --
........
200 MAT START(3) : MAT END(3)
210 READ MAT START, MAT END
220 DATA 7,21,33
230 DATA 11,21,38
240 INPUT FIELDS "row, col, LIST rows/cols, ROW, RANGE" : MAT START,
MAT END, ( MAT Array1$, MAT Array2, MAT Array3$ )

This reads 12 rows of data ( row 7-11, row 21 and rows 33-38 ).

=== RANGE Output===

By default, RANGE output refers to rows. The special keyword CELL_RANGE is used to denote the specification of cell ranges. Additionally, the use of scalars versus arrays for start and end values determines important characteristics of the output process.

4c) Using Scalars For Range Specification

PRINT FIELDS "7, 8, GRID 10/75, RANGE": start, end, MAT Data$

This replaces the values in rows numbered 'start' through 'end' with the data in MAT Data$. The size of MAT Data$ must be a multiple of the number of columns in the GRID or an error is generated.

PRINT FIELDS "7, 8, LIST 10/75, RANGE": start, end, (MAT NAME$,
MAT CITY$, MAT AGE, MAT WEIGHT)

This replaces the values in ROWs numbered 'start' through 'end' with the data from MATs NAME$, CITY$, AGE and WEIGHT. The data arrays must all be dimensioned the same.

=== Row Insertion and Deletion===

The number of rows being output do not need to match the number of rows being replaced. To delete a range of rows, output one or more grouped arrays with zero elements.

Examples- Using the following statement various scenarios are described.

PRINT FIELDS "7,8,LIST 10/75, RANGE": start, end, (MAT NAME$,
MAT CITY$, MAT AGE, MAT WEIGHT)

Start=7, end=11, and the arrays have been DIMed to nine elements
Result- Nine rows replace five, and the total content of the control is
expanded by 4 rows.

Start=7, end=11, and the arrays are DIMed to zero elements
Result- Five rows are deleted, and the total size of the control is
reduced by 5 rows.

Start=7, end=0 (anything less than 7), and the arrays are DIMed to
support three rows
Result- Three rows are inserted ahead of row seven and the total content
of the control is expanded by three rows

Start=5000, end={any value}, the control only has 482 rows, and the source
arrays are DIMed to support eleven rows
Result- Eleven rows are appended to the end of the control and become
rows 483 through 493.

=== Outputting Ranges of Cells===

Ranges of cells may be output in conjunction with the CELL_RANGE keyword.

PRINT FIELDS "7,8,LIST 10/75, CELL_RANGE": start, end, (MAT NAME$,
MAT CITY$, MAT AGE, MAT WEIGHT)
- or -

PRINT FIELDS "7,8,GRID 10/75, CELL_RANGE": start, end, MAT Data$

In this case, start and end specify cells instead of rows. If insertion or deletion is indicated by dimensioning the data arrays to greater or fewer elements than are being replaced, then the data must be a multiple of the number of columns. Insertion and deletion is only valid in terms
of rows, even when cell subscripts are used to specify ranges. In such cases, if the cell subscripts are not on row boundaries, an error is generated.

PRINT FIELDS "7,8,GRID 10/75, CELL_RANGE": start, start, Data$
In this example, the value in one cell is replaced with the content of a scalar.

=== Using Arrays For RANGE Specification===

If the start and end specifications are arrays, denoting multiple ranges, there must be a one to one correspondence between the number of rows specified and those in the data. This method implies replacement only and insertion or deletion is not allowed.

The data flow that this feature was designed to support is one where the user is presented with a LIST or GRID where multiple rows have been either selected or changed before returning control to the program and the program is responding by updating something on those rows.

The program begins by presenting a 2D control to the user and reading the the control with type ROWSUB or SUB. Type SUB only works for GRIDs where all colmns have the same data type. Of course the subscripts are read into a numeric array which BR redimensions as appropriate. Then the program reads the changed or selected data with NOWAIT. (This resets the CHG flags in the control.) The program then changes either row (ROWSUB) or cell (SUB)
data and outputs the results using the subscript array as both the start and end specification. Other scenarios are possible but this is the primary intended use.

An example of this is:
100 -- create and populate a GRID --
........
200 INPUT FIELDS "row,col,GRID rows/cols,ROWSUB,CHG": MAT Rowsubs
(Reading subscripts does not reset the CHG flags in the control.)
210 INPUT FIELDS "row,col,GRID rows/cols,ROW,CHG,NOWAIT": ( MAT Data1$,
MAT Data2, MAT Data3$ )
BR redimensions the receiving arrays as needed.
(Reading the data also resets the CHG flags in the control.)

220 -- process the changed rows now present in the data arrays --
........
300 PRINT FIELDS "row,col,GRID rows/cols,RANGE": MAT Rowsubs,
MAT Rowsubs, ( MAT Data1$, MAT Data2, MAT Data3$ )

This outputs the updated rows.

== FINE GRAIN FIELD POSITIONING==
ROW/COL and ROWS/COLS in FIELDS operations may be expressed as decimal fractions.

== LOGGING ENHANCEMENTS==
The debug versions of BR now expect you to use a LOGGING configuration statement. This enables BR to post exit messages during unexpected terminations.

A system function called DEBUG_STR( message-level, string-value ) will, depending on LOG LEVEL, send data to the LOGGING file as well as to the MyEditBR debugger if it is attached, or optionally to the command console if the debugger is not attached and GUI is ON. This lets you freely put trace related informational statements into your code without affecting normal processing.

The LOGGING configuration statement now has two additional optional parameters:

LOGGING loglevel, logfile [ ,DEBUG_LOG_LEVEL=nn ] [ ,+CONSOLE ]

Note- Logfile is a native OS filename. Second and subsequent occurrences of the LOGGING statement may omit loglevel and the log filename.

DEBUG_LOG_LEVEL specifies the log level for debugging log messages Independently of the standard log level. If not specified the Debug_Log_Level is set to the standard log level.

+CONSOLE applies only when GUI is ON and specifies that all logging messages also go to the console and the console is to be left visible when not attached to MyEditBR. ( Console logging output is suppressed when GUI is OFF. )

Message Levels are compared with Log Levels during the filtering process. The Logging Level is meant to specify the level of detail to be logged, with greater detail logged at higher log levels.

The following types of messages are written to the LOGGING file:

Config error messages based on their assigned level of importance.

DEBUG_STR() messages where message-level is equal to or less than the DEBUG_LOG_LEVEL.

Log levels 0, 1, 2 and 3-
System generated warning messages such as OS failures and abnormal exits.
Log level 5 or above-
User Logon data, including any logon attempts.
Log level 6 or above-
Starting a BR program, exiting.
Log level 8 or above-
Commands such as COPY plus shell calls with parameters.
PDF printing events.
Log level 11 or above-
Any PRINT output that goes to the console is also logged (GUI ON only).
Log level 12 or above-
TRACE, and DISPLAY messages.
Log level 13 or above-
Lots of what the system is doing now messages.

Any DEBUG_STR() calls with a level >10 are deemed to be message level 10.

Logging was added to PDF creation. Logging of minor events that happen during the printing process are logged at log level 8. Errors are logged at a lower level. Logging was also improved with respect to loading older versions of pdflib.
Note- As a diagnostic, the following command is quite useful:
DIR >PDF:/READER

ODBC Logging was substantially increased.

Log Level Indication is given in Log Messages:
(6) - 08/25/2011 11:33:53
Setting logging to log file logfile.txt log level 10.
(6) - 08/25/2011 11:33:53
The BRConfig.sys file is C:\Users\dan\programs\cygwin\home\dan\br-wx\br\winbuild\dllbuild\output\brconfig.sys
The (6) here is the log level.

== CSV AND XML PARSING ENHANCEMENTS==
The string to mat and mat to string functions have been extended to ease parsing of CSV and XML data.

STR2MAT( str$, MAT zzz$ [, [MAT] Sep$ [, flags$]] )
Where Sep$ may be an array and flag$ is in the format:
[ quote-type ] [ :LTRM ] | [ :TRIM ] | [ :RTRM ]
Where quote-type can be Q, QUOTES, ('), or ("), case insensitive. Q and QUOTES denote standard BR quote processing. The trim flags denote post processing of extracted elements and the leading colon is only present when quote-type is specified.
When Sep$ is an array, then any or all of the specified values are deemed to represent a single separator with the qualification that any one separator, cannot occur more than once in a string of adjacent separators. To restate this, when elements of a Sep$ array occur adjacent to each other within the source string, they are grouped as a separator substring.
Sep$ elements cannot occur more than once in a separator substring. When they do, it denotes the specification of a null element. e.g. two successive commas or two successive occurrences of CR+LF both denote null elements. Essentially when Sep$ elements are 'consumed' by their recognition within the source string, then they cannot be re-recognized without inserting a null element into the output array.
=== Quote Processing ===
Quotation marks suppress the recognition of separators in accordance with the following rules.
Standard BR Quote Processing
When examining str$ left to right, the first character (and the first character after each separator) is checked to see if is either (') or ("). If it is either of those then it activates quotation processing which suppresses the recognition of separators until quotation processing is deactivated. The first character thus becomes the governing quote type until quotation processing is deactivated.

The string is copied until it ends or until an odd number of successive occurrences of the governing quote type is encountered. During this processing, two adjacent occurrences of the governing quote character denote an embedded occurrence of the quote character.
Examples
"abc,def" -> abc,def where the comma is not recognized as a separator and is part of the data
abc"def -> abc"def naturally embedded quotes may occur anywhere within a string after the first character
"abc"def" -> abcdef" quotation processing is deactivated by the center quote mark
"abcdef" -> abcdef normal data
"abc'def" -> abc'def the single quote is treated like any other character while double quotes govern
'abc"def' -> abc"def double quotes are treated like any other character while single quotes govern
"abc""def" -> abc"def pairs of governing quotes denote a single embedded quote
"abc"""def" -> abc"def" the third successive occurrence deactivates quote processing which began with the first quote

MAT2STR( MAT zzz$, str$ [, sep$ [, flags$]] )
Where flag$ is in the format:
[ quote-type ] [ :LTRM ] | [ :TRIM ] | [ :RTRM ]
Where quote-type can be Q, QUOTES, ('), or ("), case insensitive. Quote-type denotes that each element should be enclosed in quotation marks. The trim flags denote pre-processing of array elements and the leading colon is only present when quote-type is specified.
If Q or QUOTES is specified then BR automatically determines which quote type to apply as follows:
First the element is unpacked. That is, if it is contained in quotes, the quotes are stripped and embedded pairs are singled. Next the element is scanned left to right for either type of quote character ( single or double ). If a quote character is encountered the element is enclosed in the alternate quote type and embedded occurrences of that quote type are doubled. If no quote character is encountered then double quotes are applied.
Examples
Quote Type is Q or QUOTES
abcdef -> "abcdef"
abc'def -> "abc'def"
abc"def -> 'abc"def'
abc""def -> ‘abc""def’ embedded quotes are left intact when quotes are not active
'abcdef -> "'abcdef"

Quote Type is ' ( quote type single )
abcdef -> 'abcdef'
'abcdef -> '''abcdef' single quotes get doubled when embedded in single quotes
"abcdef -> '"abcdef' leading double quote is treated normally

Quote type double mirrors quote type single.
MAT2STR and STR2MAT trim outside of quotes but not inside of quotes. Also MAT2STR always adds quotes when quotes are present in the data.
When using MAT2STR on a 2 dimensional array, the first delimiter is used for individual elements and the second delimiter at the end of each row. This principle also applies to three to seven dimensions.
Example
Given the following two dimensional array zzz$ containing the values-
1 2
3 4

The following statements-
10 Sep$(1)=","
20 Sep$(2)=hex$("0D0A") ! CRLF
30 MAT2STR( MAT zzz$, str$, MAT Sep$ )
40 PRINT str$

Will produce-
1,2
3,4

=== CSV Parsing Example===
Parsing CSV data files is now quite easy, the following code snippet demonstrates how to open a CSV/Tab File, read in the fields from the header, and then loop through the records.
01000 dim CSV_LINE$*999,CSV_FILE$*256, CSV_DELIM$*1, CSV_HEADER$*999,
CSV_FIELDS$(1)*40, CSV_DATA$(1)*60
01020 form C," "
01040 let CSV_FILE$="Sample_File.tab" : let TAB$=CHR$(9)
01060 open #(CSV_HANDLE:=10): "name="&CSV_FILE$&", shr", display,input
01080 linput #CSV_HANDLE: CSV_HEADER$
01100 let CSV_DELIM$=TAB$
01120 if POS(CSV_HEADER$,TAB$) <= 0 then
01140 let CSV_DELIM$=","
01160 end if
01180 let STR2MAT(CSV_HEADER$, MAT CSV_FIELDS$, CSV_DELIM$, "QUOTES:TRIM")
01200 print using 1020: MAT CSV_FIELDS$
01220 do
01240 linput #CSV_HANDLE: CSV_LINE$ eof Exit_Csv
01260 let STR2MAT(CSV_LINE$,MAT CSV_DATA$,CSV_DELIM$,"Q:trim")
01280 print using 1020: MAT CSV_DATA$
01300 loop
01320 Exit_Csv: !

You might wish to copy any CSV file to Sample_File.tab and run this program to view the content.

=== XML Parsing Examples===

STR2MAT may also be used to Parse XML data.
This is a bit more complex than parsing CSV files, but remains a powerful tool.
The following example will parse XML$ into "MAT XML_LINE$"

10 DIM XML$*999999,XML_LINE$(1)*32000
20 XML$="<XML><NODE><ITEM>ITEM VALUE</ITEM></NODE></XML>"
100 LET Str2mat(XML$,Mat XML_LINE$,">","TRIM")

This makes the parsing of XML a bit more convenient. The following XML sample shows how the function will parse the data

Input:
<XML><NODE><ITEM>ITEM VALUE</ITEM></NODE></XML>

Output:
<XML
<NODE
<ITEM
ITEM VALUE</ITEM
</NODE
</XML

While the above technique is useful, a more complete and useful technique can be performed if the Node names are known. You may use an array of SEP$ values to parse the data. Take the following example:

100 dim XML$*999999,XML_LINE$(1)*32000,SEP$(4)*32
110 let XML$="<XML><NODE><ITEM>ITEM VALUE</ITEM><ITEM2>ITEM2 VALUE</ITEM2></NODE></XML>"
120 read MAT SEP$
130 data </XML>,</NODE>,</ITEM>,</ITEM2>
140 let STR2MAT(XML$,MAT XML_LINE$,MAT SEP$,"TRIM")
150 print MAT XML_LINE$

This program would return the following results:

<XML><NODE><ITEM>ITEM VALUE
<ITEM2>ITEM2 VALUE

Notice that "Nested Nodes" are listed before the initial data, this may be used to identify the node.

== NEW DLL STRUCTURE OF BUSINESS RULES!==

As of Release 4.3 Business Rules! has been restructured into the following modules:
[[brserver.exe]] – The BR Server module accessed by Client-Server configurations. Brserver.exe also operates as what is now viewed as the Standard Model. If it is invoked by brlistener, then it act as brserver. If it is simply executed, it acts as brcombined. However, when operating as the standard model, it needs to have brclient.dll in the same directory as brserver.
[[brclient.exe]] – The program that the user accesses in Client-Server configurations
[[brclient.dll]] – The client processing program that correlates with the brserver edition.
[[npbrclient.dll]] - The standard (non-IE) browser plugin dll
[[iebrclient.dll]] – Internet Explorer plugin dll

Client installation is done by placing brclient.exe and brclient.dll on the client system and referencing brclient.exe in an icon. Server installation is done by placing brserver.exe and brclient.dll on the server and referencing brserver.exe in the brlistener.conf file. Exe files may be renamed as desired. The name of the released brclient.dll modules will be lengthy and must not be changed because BR relies on the DLL names for version identification.

You will need one of the following possible configurations:
* Workstation Standard Model
* Server executable
* Workstation Client dll
* Linux Terminal Support
* Server executable
* Linux Client dll ( .so )
* Client Server Model
* On Client Machine-
* Client executable
* Workstation Client dll
* On Server
* Server executable
* Workstation Client dll
* BR Listener installed
[ Linux Client dll for Linux terminal access ]

The 32 and 64 bit versions of servers and clients can be intermixed. However dlls must be the in same bit class as the modules that call them. Put your BR bmp files ( drawsunk.bmp, startup.bmp etc. ) in the BR server executable directory.

Updates will pertain to Processor DLLs while the user interfaces will remain as installed. Client DLLs will be automatically uploaded when corresponding server DLLs are accessed in the event they are not already present on the client.

The client can be accessed from within a browser by initiating it with HTML which can specify an embedded window or a separate independent window. In all cases opening a window with PARENT=NONE creates a separate window.

=== BR Adjunctive Files===

The BR executable is now considered to be where the BR server actually resides, irrespective of Drive statements and current working directories.

The following files are located in the BR executable directory by default:
BR server executable
BRconfig.sys
BRserial.dat
BRserver.dat
WBcmd.wbh - BR help files
Server Dlls
Client Dlls for uploading as needed
System Image files – linedraw, etc. - typically BMPs
===) Exceptions===

If [[WBcmd.wbh]] doesn't exist in the BR executable directory then BR looks for it in the initial directory specified by the first drive statement. ( deprecated – will be eliminated at some point) ONQPATH currently defaults to this initial path as well. ( this will remain )

If the BRconfig file is not present in the BR executable directory then BR looks for it in the current working directory at the time of BR invokation.

The SPOOLPATH :OS-fullpath configuration statement specifies where print spool files are temporarily stored during printing. SPOOLPATH defaults to a spool directory that runs off of the BR root of the first drive statement. If no such spool directory exists and SPOOLPATH is not specified then BR creates one.
e.g. DRIVE J:, C:\BR, x, \MYAPP would result in spool files being placed in:
C:\BR\SPOOL\

SPOOLPATH @::client-OS-fullpath specifies where on the client spool files are to be placed.
e.g. SPOOLPATH @::C:\BR\SPOOL -or whatever other full path is desired-

The @: tells BR that this path is on the client. The second colon says the path is independent of drive specifications.

WORKPATH defaults to the BR root of the first drive statement:
e.g. C:\BR\

BRconfig.sys INCLUDE statements are relative to the location of the file containing the INCLUDE statement ( the parent ). CONFIG command INCLUDE statements are relative to the current directory at the time the command is issued.

=== Licensing Restrictions===

As of [[4.20H]], [[brserial]] files must be specific to the first decimal position of the [[release]] of BR that is being used. ( e.g. 4.2x versus 4.3x )

To accommodate more than one brserial level, BR first looks for its own suffix ( 42 or 43 ) before looking for a dat file. From now on it is most useful to name your brserial files either BRSERIAL.42 or BRSERIAL.43, etc.

== CLIENT SERVER RECONNECT Configuration Statement==

CLIENT_SERVER RECONNECT_AFTER=20 RECONNECT_TIME=120

BR sends idle packets between the client and the server every 2 seconds. This statement specifies that after 20 seconds of not receiving such packets BR will attempt to reconnect. This reconnect process can last up to a maximum of 120 seconds, after which BR will issue a “lost connection” error and begin processing in unattended mode.

You can change the above period lengths with the above CONFIG statement.

When BR runs unattended, it normally terminates processing if the program attempts to wait for keyboard input. However, after a lost connection error, if a library program attempts to wait for keyboard input the library function is terminated, the calling statement receives control, and the lost connection error is issued again. This supports error trapping in the calling program so an orderly shutdown can be performed.

== AUTOIT SUPPORT==

[[AutoIt]] is a free keyboard simulation program with very powerful automating capabilities. It can be used to access windows, read data from spreadsheets, write to display files and enter data in screens. There is a separate Window Information utility that comes with Autoit which displays what Autoit sees when windows are active. This has produced ambiguous information in the past.

R99C999 (BR row & col) now appears in the text field of BR labels.

Individual BR input fields may be referenced in Autoit as EditNN where NN is the INPUT FIELDS subscript (CURFLD) of the field.

== ENVIRONMENT INTERROGATION==

ENV$("STATUS [ .sub-keyword ] ... " [, mat config$ [, search-arg] ...] )

ENV$ returns a string or, in the event MAT CONFIG$ is provided, ENV$ redimensions and loads it. For a list of valid keywords issue a STATUS ENV command. If an array is specified, it may be followed by one or more case insensitive substrings which are regarded as restricting search arguments.

e.g. ENV$("SERVER_PLATFORM") returns “WINDOWS”

The following program displays all STATUS information that contains the word “file”:

00100 dim CONFIG$(1)*100
00120 let ENV$("STATUS",MAT CONFIG$,"file")
00140 print MAT CONFIG$

The above program produces the following output:

CHAINDFLT - Look for object files with source first.
EDITOR C:\PROGRAM FILES\MILLS ENTERPRISE\MYEDITBR\MYEDITBR.EXE
FILENAMES LOWER_CASE
OPTION 23 is OFF - prevent data conversion errors from moving file position
OPTION 25 is ON - make FILE$(0) be CON: if in windows
OPTION 26 is OFF - suppress creation of .BAK files
OPTION 29 is ON - save programs as .WB files
OPTION 33 is 64 - locking position for large file support
OPTION 49 is OFF - use relative path for spool file
OPTION 51 is OFF - recover deleted records for all files
SPOOLCMD prt.bat [SPOOLFILE] [COPIES] [PRINTER]
Server File: :c:\wbserver.dat
BR Config File: :C:\ADS\SYS\br.d\brconfig.sys
Executable File: :C:\ADS\SYS\br.d\
brserver-430beta+q-Win32-DebugEfence-2011-03-20.exe
Serial File: :C:\ADS\SYS\br.d\brserial.dat
Workfile path: :c:\ads
Open File # 0 :CON:

If I just want the options with the word file then I would use:

00100 dim CONFIG$(1)*100
00120 let ENV$("STATUS.CONFIG.OPTION",MAT CONFIG$,"file")
00140 print MAT CONFIG$

Which produces:
OPTION 23 is OFF - prevent data conversion errors from moving file position
OPTION 25 is ON - make FILE$(0) be CON: if in windows
OPTION 26 is OFF - suppress creation of .BAK files
OPTION 29 is ON - save programs as .WB files
OPTION 33 is 64 - locking position for large file support
OPTION 49 is OFF - use relative path for spool file
OPTION 51 is OFF - recover deleted records for all files

Note that while keywords are case insensitive, they must be correctly specified, whereas search arguments are more “friendly”. For a complete list of valid keywords, issue the command:

STATUS ENV -p

Some of the new keywords supported are:
*ENV$("CLIENT_PLATFORM") is "WINDOWS"
*ENV$("CLIENT_PLATFORM.BR_BUILD_TYPE") is "DebugEfence"
*ENV$("CLIENT_PLATFORM.BR_BUILD_DATE") is "2011-05-12"
*ENV$("CLIENT_PLATFORM.BR_BITS") is "32"
*ENV$("CLIENT_PLATFORM.OS_BITS") is "64"
*ENV$("CLIENT_PLATFORM.OS_VERSION_NAME") is "Windows 7"
*ENV$("CLIENT_PLATFORM.OS_VERSION_NUMBER") is "6.1"
*ENV$("SERVER_PLATFORM") is "LINUX"
*ENV$("SERVER_PLATFORM.BR_BUILD_TYPE") is "DebugEfence"
*ENV$("SERVER_PLATFORM.BR_BUILD_DATE") is "2011-05-13"
*ENV$("SERVER_PLATFORM.BR_BITS") is "64"
*ENV$("SERVER_PLATFORM.OS_BITS") is ""
*ENV$("SERVER_PLATFORM.OS_VERSION_NAME") is "#36-Ubuntu SMP Thu Jun 3 20:38:33 UTC 2010"
*ENV$("SERVER_PLATFORM.OS_VERSION_NUMBER") is "2.6.32-22-server"
*BR_MODEL “CLIENT/SERVER” or “COMBINED”

== NEW WORLD SQL SUPPORT==

CONFIG DATABASE db-ref DSN=dsn-ref [, USER= department | LOGIN_NAME | ? ]
[, {PASSWORD= dept-password | BR_PASSWORD | ?} | PASSWORDD=encrypted-passwd ]
? indicates prompt
BR_PASSWORD indicates the password used during client login. If running the standard model ( not client-server ) then this is equivalent to “?”.
encrypted-passwd is the DB password encrypted with the key stated in OPTION 66.
- or -
CONFIG DATABASE db-ref CONNECTSTRING="Driver={Microsoft Access Driver (*.mdb)}
e.g. DBQ=C:\inetpub\wwwroot\BegASP\Chapter.14\Contact.mdb"
- or -
CONFIG DATABASE ODBC-MANAGER
This will invoke the ODBC Manager to define or identify a file DSN.

OPEN #20: "DATABASE= db-ref" , SQL "sql-statement", OUTIN
- or -
OPEN #20: "DATABASE= db-ref, Name= filename" , SQL, OUTIN
- filename refers to a DISPLAY file containing an SQL statement
that gets executed when a WRITE statement is processed -

===Sequence of Operations===

1. Begin processing with a WRITE statement.
2. If the WRITE contains an IO list of values then it is used to populate the 'filename' SQL before it is executed. In this process IO list values replace question marks in the original SQL, positionally left to right. These question marks only work with SQL arguments that refer to stored data. Question marks cannot be specified where SQL keywords or table column names appear.
3. This may or may not produce a result set. If it does, the result set may be processed like a BR file opened RELATIVE. Some operations that use file positioning may be slow since the whole result set may not be in memory immediately. Simple sequential access should be fairly quick.
4. Once SQL has been populated by an IOlist, it may be reused with the same values by issuing a WRITE with no IOlist.
5. READ IOlist variable associations are positional with each READ accessing one row of values.

=== SQL Date Format Functions===

A$ = SQL_DATE$(BR-date-string,"format-mask") ! format date for storage
B$ = BR_DATE$( SQL-date-string,"format-mask") ! unpack DB date value

* Note: SQL DATETIME fields are "Packed for Storage", but "DATE" fields are returned as a CCYY-MM-DD string in a SQL Query. DATE returns "BLANK" for "Empty or Null Date"

=== SQL Table Interrogation===

“ENV$ (STATUS)” has been extended to interrogate database connections and ODBC data sources. A program called ENVDB.BRS has been written to demonstrate how this extension works and to show how to setup linkage to a database or ODBC data source. Run the program as is to bring up the Microsoft ODBC manager. Then select a data source and look at the output from the program. This will also show you how to get and use connect strings. In this example lines 1900 and 2000 accomplish the same open as line 1800 in my environment.

Try it on your Windows workstation. As long as you have one or more ODBC drivers supported you can use it without having to install a database. You can even use it to interrogate Excel files because Microsoft provides an ODBC driver for that.

A sample program to demonstrate database interrogation entry is:

01000 ! Replace Envdb
01020 dim DATABASES$(1)*100
01040 dim DATABASE$*100
01060 dim TABLES$(1)*100
01080 dim TABLE$*100
01100 dim COLUMNS$(1)*100
01120 dim COLUMN$*100
01140 dim C$*100,FLD1$*40,FLD2$*40,FLD3$*40,FLD4$*40
01160 execute "CONFIG database testdb odbc-manager"
01180 ! Execute "CONFIG database testdb DSN='Accounts Payable'"
01220 ! Execute "CONFIG database testdb connectstring=""DSN=Excel Files;DBQ=L:\orders\Beneficial - A-PORCEL.xls;DefaultDir=L:\orders;DriverId=1046;MaxBufferSize=2048"""
01230 ! ***** Open Output File
01240 open #1: "name=envdb.txt,replace",display,output
01420 Dump_Table: ! ***** Dump Table Layout
01440 let OUTFD = 1
01460 let ENV$("status.database.LIST", MAT DATABASES$) !List of db's
01480 for DATABASE=1 to UDIM(DATABASES$) !For each connected database
01500 let DATABASE$=DATABASES$(DATABASE)
01520 let FNSHOW_DATABASE(DATABASE$, "status.database."&DATABASE$)
01540 next DATABASE
01560 end
01580 !
01600 def FNSHOW_DATABASE(DATABASE$*100, ST_PREFIX$*100)
01620 print #OUTFD: DATABASE$
01640 let OUT_PREFIX$=CHR$(9)
01660 print #OUTFD: OUT_PREFIX$&"DSN="&ENV$(ST_PREFIX$&".DSN")
01680 print #OUTFD: OUT_PREFIX$&"CONNECTSTRING="&ENV$(ST_PREFIX$&".CONNECTSTRING")
01700 print #OUTFD: OUT_PREFIX$&"Tables:"
01720 let ST_PREFIX$=ST_PREFIX$&".TABLES"
01740 let ENV$(ST_PREFIX$&".LIST", MAT TABLES$)
01760 for TABLE = 1 to UDIM(MAT TABLES$)
01780 let TABLE$=TABLES$(TABLE)
01800 let FNSHOW_TABLE(TABLE$, ST_PREFIX$&"."&TABLE$,OUT_PREFIX$&CHR$(9))
01820 next TABLE
01840 fnend
01860 !
01880 def FNSHOW_TABLE(TABLE$*100, ST_PREFIX$*100, OUT_PREFIX$)
01900 print #OUTFD: OUT_PREFIX$&TABLE$
01920 let OUT_PREFIX$=OUT_PREFIX$&CHR$(9)
01940 print #OUTFD: OUT_PREFIX$&"Table remarks="&ENV$(ST_PREFIX$&".REMARKS")
01960 print #OUTFD: OUT_PREFIX$&"Table type="&ENV$(ST_PREFIX$&".TYPE")
01980 print #OUTFD: OUT_PREFIX$&"Columns:"
02000 let ST_PREFIX$=ST_PREFIX$&".COLUMNS"
02020 let ENV$(ST_PREFIX$&".LIST", MAT COLUMNS$)
02040 for COLUMN = 1 to UDIM(MAT COLUMNS$)
02060 let COLUMN$=COLUMNS$(COLUMN)
02080 let FNSHOW_COLUMN(COLUMN$, ST_PREFIX$&"."&COLUMN$,OUT_PREFIX$&CHR$(9))
02100 next COLUMN
02120 fnend
02140 !
02160 def FNSHOW_COLUMN(COLUMN$*100, ST_PREFIX$*100, OUT_PREFIX$)
02180 print #OUTFD: OUT_PREFIX$&COLUMN$
02200 let OUT_PREFIX$=OUT_PREFIX$&CHR$(9)
02220 print #OUTFD: OUT_PREFIX$&"Column type="&ENV$(ST_PREFIX$&".TYPE")
02240 print #OUTFD: OUT_PREFIX$&"Column length="&ENV$(ST_PREFIX$&".LENGTH")
02260 print #OUTFD: OUT_PREFIX$&"Column decimals="&ENV$(ST_PREFIX$&".DECIMALS")
02280 fnend

== BR DATA ENCRYPTION==

Encryption encompasses a number of different operations. These operations can be used independently or in combination to meet different needs. We use industry standard encryption available through OpenSSL. Three technologies are widely used for encrypting data. BR supports the first two listed below through its ENCRYPT and DECRYPT functions.

===Overview===

1. Symmetric key ciphers – where the same key is used to encrypt and decrypt data. You can specify a key to encrypt some data and later use the same key to decrypt the data.

2. Hashing routines – one way routines that take data and convert it to a hash value. Sometimes these are thought of as checksums such as MD5 sum. Hash values are always the same length regardless of how big the hashed data is. A 10 gb file will have a hash result that is the same length as a 200 byte file. Hashing routines have a number of specific uses.

1. Verify that data has not changed.

2. Verifying that two files are the same.

3. Validating passwords – this is based on the concept that if two values have the same hash value the values are equal. Using this technique improves security because it allows a server to store passwords in an unrecoverable format. Even the server software is unable to regenerate the original password. It is only capable of checking if the hash of a password matches the stored password hash.

===Symmetric Key Ciphers===

There are two encryption functions in the BR language, ENCRYPT$ and DECRYPT$.

ENCRYPT$(Data$ [,Key$ [,Encryption-type$, [,Initialization-vector$]]])
DECRYPT$(Data$ [,Key$ [,Encryption-type$, [,Initialization-vector$]]])

Data$ - The data to be encrypted

Key$ - The secret key to be used for encryption. If not specified this value will come from an OPTION 66 statement.

Encryption-type$ - The type of encryption to be done. If not specified, a common high strength encryption type will be employed. This is described in more detail below, but is generally only useful for interfacing with other typically non-BR programs.

Initialization-vector$ - This is an arcane part of encryption standards. It exists to prevent attackers from being able to tell whether the unencrypted data has changed. This is described in more detail below, but is general only needed when interfacing with other non-BR programs.

=== Interfacing With Other Programs (encryption type and initialization vector)===

There are a number of different types of encryption that BR supports through OpenSSL: AES, BLOWFISH, DES, triple DES, RC4 and RC2. Most symmetric key ciphers are block ciphers meaning that they encrypt one block at a time. This means if you have a bit message, it is broken up into multiple blocks and each block is encrypted. The block size can be set as (128, 192, 256) bits. Some encryption types don't support all of these values so STATUS ENCRYPTION should be checked to see what encryption types are available in BR. Besides block size, there are also various schemes for blocking data. One might expect that using 256 bit blocking would simply take every 32 bytes and call it a block. This is not done though because there is a possibility that this would cause patterns in the encrypted data. To prevent this, there are various schemes known as codebooks which change the way data is blocked. Wikipedia explains this in more detail. If the encryption type is not specified AES:256:CBC:128 will be used. To be compatible with other programs the entire encryption type must be specified (cipher: key length: codebook: invitialization vector length).

Initialization-vector – this is used to cause the same data encrypted with the same key to have a different encrypted result. This is significant because otherwise an attacker looking at data seeing the same encrypted result twice would know that the key and the unencrypted data have not changed. Regardless of whether or not you are concerned about this potential security issue, the standard encryption methods require this value so interfacing with other programs may require you to use it. It is a common practice to use a random number for this value and store the value at the beginning of (ahead of) the encrypted result. This is what BR does if this parameter is omitted.

As an example:
ENCRYPT$(“test”, “key”)
Produces a string containing “random number initialization vector”&”encrypted result”.

If the initialization vector is explicitly specified as in:
ENCRYPT$(“test”, “key”, “AES:256:CBC:128”, “RANDOM”)
the result would be simply “encrypted result”.

DECRYPT$ has the same arguments as ENCRYPT$ with the exception of the first parameter which is the encrypted data. DECRYPT$ expects to be used with the same key$, encryption-type$, and initialization-vector$ as was used to encrypt the data. As with ENCRYPT$, if key$ is not specified, the value from the OPTION statement will be used. If encryption-type$ is not specified, “AES:256:CBC:128” will be used. If the initialization vector is not specified, it will be assumed that the encrypted data starts with an initialization vector.

=== Hashing Routines===

Three common forms of hashing are allowed in BR. They are MD5, SHA, and SHA-1. These are also provided through the ENCRYPT$ function specifying a null key$ value:

ENCRYPT$(data$, “”, “MD5”)
ENCRYPT$(data$, “”, “SHA”)
ENCRYPT$(data$, “”, “SHA-1”)

Hashing is also referred to as Message Digests or digests. This is what the MD in MD5 means. There is no way to restore data that has been hashed. Hashing is a one way function so DECRYPT$ will yield an error.

=== Asymmetric Encryption===

Asymmetric key encryption is also known as public/private key encryption.

Public/private keys are created as a pair by a key generator. They are a pair, and it is not possible to have two public keys for the same private key or vice versa. With regard to public/private key pairs, what one key encrypts the other key can decrypt, and neither key can decrypt what it has encrypted. When a private key is used to encrypt data, the result is called a signature because everyone who has the public key can decrypt it.

This technique is used for:

Signing (using certificates) – A private key can be used to sign data. The result of such signing can be tested/validated with the corresponding public key.

Data encryption – A public key can be used to encrypt data. This data can then only be decrypted by the corresponding private key.

Hashes and signing are different but used together. Rather than signing a large block of data which would create a large signature, only the hash is signed to create much smaller fixed length signature data. When verifying a large block of signed data, the data is used to create a hash value and the hash value is compared to a decrypted signature.

Asymmetric encryption is not accessible through the BR ENCRYPT$, DECRYPT$ functions. However, it is used by our SSL client server connections and HTTPS. Certificates are most commonly used by SSL and HTTPS and are less useful for other application processes. In the Client Server model the client knows the server’s public key and the server uses its private key to encrypt and decrypt.

Encryption is invoked by Business Rules HTTP support as follows:

CONFIG HTTPS PORT port-number [ LOG file-pathname ]
CONFIG OPTION 66 private-key-file-encryption-password
OPEN #400: “HTTP=SERVER”, DISPLAY, OUTIN

The BRSERVER executable directory must contain two files:
* https-private.pem
* https-cert.pem

These files are made by the following commands under Linux, MAC and cygwin for Windows:
openssl req -new -x509 -out httpserver.pem -days 10000

( this will prompt for the OPTION 66 password )

mv privkey.pem https-private.pem
mv httpserver.pem https-cert.pem

This port specific service can then be accessed with browsers. When the specified port is accessed through a browser, BR establishes an HTTPS connection rather than an HTTP connection.

=== Signing and Certificate Processing Industry Standards===

Certain companies are authorized by the government to act as a Certificate Authority ( CA ). These companies ( e.g. Verisign ) issue electronic certificates which can be used to issue second level certificates. Certificates can have expiration dates and the line of authority extends from a CA to any number of levels (but a chain is only as strong as its weakest link). Certificates contain a list of signatures (described below) that trace back to a CA as follows:

When a company needs to obtain a certificate from a CA, it prepares its own certificate and sends it to the CA for signature. The CA provides the signature and the CA’s own public key for validating it. The text in such certificates will identify the signing authority ( CA ) and the recipient of the certificate. It also contains the public key of both the signer and the recipient.

Browsers know the CA identities and their public keys. A browser can verify a CA issued cert by hashing it, decrypting the signature with the known public key and matching the decrypted signature against the hash total.

Any company that is issued a certificate by a CA can sign second level certificates issued to third parties. A second level cert contains the parent (CA issued) certificate, and includes the public keys of the issuer and the recipient. The signature is essentially the encrypted hash total of ‘itself plus all of its ancestors’. Additional levels each contain the chain of certificates leading from a CA issued cert to itself.

Ostensibly, a certificate cannot be counterfeited because it requires the signature of its parent which can only be produced with its parent’s private key. By providing both public keys ( signer and recipient ) in all certs along with signatures, a non-forgeable or alterable chain is established.

Example:
CA public key – known to browser
certificate 1 (signed by CA)
certificate 2 (signed by second level - includes certificate 1)
final certificate (signed by third level - includes certificate 2)

A browser would find the CA information in the certificate and check to see if it is in the browser’s internal list. If not it fails. Then it verifies that certificate 1 (which ends up being part of the final certificate) has been signed by the CA. After that it checks certificate 2 and verifies that it has been signed with certificate 1. Finally it checks the final certificate and verifies that it has been signed with certificate 2.

To assure the line authority of any certificate, the public keys are associated with signers, not with documents.

== ODBC VERSION 4.3==

Improved installation routines:
Easy to use
Compatible with Windows Vista/7
Compatible with 64 Bit Machines (both 32 and 64 bit drivers).
Easily create DNS entries from the CONTEXT using a BR program called CREATE_INI.BR. (You will need to tailor the resulting INI file to the target setting.)
Installation on a client can be done from a command line avoiding the need for human interaction at the client.

Support for 64 bit Record Locking (No 2GB Limit!).
Implemented Dynamic (on the fly) Indexes.
The ODBC splash screen has been removed.

ODBC Logging:
*Set Logging to level 6 or greater.
*LOGGING 6, C:\ODBC-LOG.TXT
*Log file will provide helpful information to analyze queries.
*Actual SQL processed by Driver (As opposed to the SQL typed in MS-Access or MS-Excel)
*Indexes used by the Query. (To help determine the "BEST Query" for performance).

More Robust:
*Improved Date Handling (Sort/Filter, etc).
*Improved Joins leverage &/or create indexes for performance.
*Improved Group By queries
*Improved "Like" filters.
*Improved Multiple Filters in a single query

=== ODBC Licensing And Security===

Licenses will be issued based on number of workstations or number of BR WSIDs.

The price per user for licensing based on the number of BR WSIDs is one half of the price based on the number of ODBC workstations.

The maximum license fee for ODBC is $4900.

====Enforcement====
If the ODBC license is based on the number of BR users, then the BRSERIAL.DAT file always specifies 999 users.

We assign a random number to each machine that uses the ODBC driver and another random number to each user of ODBC. These numbers are stored along with the date, encrypted in a table in the server and client registries. Each time a session is started, the client is checked for pre-existing control numbers and if they exist then the numbers are used for the session (along with the current date). If a client reports a pre-existing number less than 14 days old that is not in the server table, then an alarm is signaled. This indicates tampering with the server table.

When a control number pair is about to be added to the server table and the table is full then it is searched for an entry more than 14 days old for replacement. If no such entry exists, then a “maximum users exceeded” error message is presented.

When a computer is replaced, this can leave an unusable entry in the server table for up to 14 days. If this occurs, then the user can run a program on the server that writes an encrypted header with the current date to the server table indicating that the table has been cleared in a licensed manner. After this has been run, all entries in the table will be available for reuse. Clients that have pre-existing control numbers will not generate the tamper error when the license file is cleared in this manner unless the client last used date is greater than the encrypted header date. This program requires a password which is an encrypted form of the current date plus the serial number. Only the dealer has the password producing program so only the dealer can obtain the current day’s password.

When a client machine has more than two ODBC user entries, the entries greater than
one are counted as separate workstations. e.g. 1 or 2 ->1, 3->2, 4->3, etc.

=== New Procedure for Utilizing MS Access ODBC Middleware ===

A procedure has been established for greatly expanding the SQL capabilities of the BR ODBC driver by routing ODBC requests through MS Access. Using this technique one can create reusable queries that combine several tables. This procedure is described in the installation guide.

== PRINT FONT STRETCHING==

When we developed the PDF printing facility we encountered a problem getting PDF to print exactly like NWP and PCL. This was partly because early in NWP development we stretched the fixed width fonts vertically for maximum legibility. So in version 4.2 we adopted a default font that was more like PCL that we could print in both NWP and PDF.

However, we eventually returned to the older stretched fonts because of their superior legibility. This issue affects only fixed width fonts. This stretching can be disabled with OPTION 68.

We are now using Courier New as the default font. pdflib4-Win32.dll adds support for this stretching to our PDF capabilities.

Relative Font Heights ( height to width ratios ):
Native Courier New 1.6 - available in PCL -
Native Letter Gothic 2.0 - available in PCL -
Stretched Fonts 2.6 - NWP and PDF only -

The 1.6, 2.0, 2.6 are ratios. For Courier New the 1.6 means that the font is 1.6 times as high as it is wide. PCL measures all fixed width fonts in width and calculates the height based on these ratios. So for Courier New a 10 CPI font would be 1.6 * (1 / 10)(CPI) * 72 (points per inch) = 11.52 points. Actually the ratio for Courier New appears to be 1.66666666. This would mean that 1.66666666 * (1/10) * 72 = 12 points.

== EXTENDED DATE / TIME FUNCTIONS==

Date numeric variables can now represent time of day in the fractional space (to the right of the decimal point). The DAYS and DATE masks have been extended as follows:

H#.## or H denotes hours [ with fractions ].
M#.### or M#.# denotes minutes.
S#.####, S or S# denotes seconds.

M, to the right of H always denotes minutes, so H:M:S is sufficient.
Either AM or PM, to the right of H denotes AM / PM output.
The absence of AM and PM denote military hours (0 – 23).
The maximum significant digits that can be represented in a numeric variable are 15. So if century, year, month and day are stored as a 5 digit day of century, then internally up to ten digits to the right of the decimal are available for time of day.

Extended Date Mask Examples:
DATE( “Month dd, ccyy at H#.## hours”) -> September 12, 2011 at 14.58 hours
DATE( “mm/dd/yy at H:M AM”) -> 09/15/11 at 2:35 PM
DATE( “mon dd cy at H#:M# PM”) -> Sep 15 2011 at 02:35 PM

Example of using DATE$ to get time to 9 decimal places:
Date$("H#:M#:S#.#########") -> 14:06:22.968419347

When storing date/time combinations on disk, you should allow for all of the significant digits that your date mask supports on each side of the decimal point. A “BH 4” form supports nine significant digits, which is suitable for day of century plus a four digit fraction. To exceed that you can use either PD 6, PD 7, PD 8 or D 8 (double floating point) to store these values on disk. DATE() only works with day-of-century values along with an optional time fraction.

== NEW DATE MASK INPUT PROCESSING==

DATE(mask) can now be used as an INPUT FIELDS specification.

10 INPUT FIELDS “row, col, DATE(mask) ,UH” : date-var

Special keyboard processing:
Punctuation (commas, colons, slashes, semicolons, and dashes) is skipped during entry similar to PIC.
Insert and delete are supported within subfields that are delineated by punctuation.
Copy includes punctuation.
Cut is Copy with redisplay of zero date.
Paste causes BR to translate the date to DAYS format and then display the date. Excel and OpenOffice Calc application formats are supported.
If a string is pasted, it is first converted to DAYS using the provided mask.
If a zero DAYS value is displayed then Month, M3, Day and D3 mask positions contain dashes.

A date picker has been added.

A new configuration statement is provided to control the when the date picker appears:

DATE [ALWAYS] [INVALID] [NEVER]

Additionally, the leading attribute ^DATE_PICKER is available.

INVALID ( the default mode ) presents the date picker whenever the days value of the expressed date is zero.

ALWAYS and ^DATE_PICKER show the picker whenever the cursor is in the field until a date is selected from the picker. Leaving the field and reentering it actives the picker again.

When in the date picker the following keys are active:
Shift- PgUp/PgDn – Go to the previous/next month
Ctrl- PgUp/PgDn – Go to the previous/next year

A sample program to demonstrate date entry is:
01000 ! Rep Date_Input
01020 ! Demonstrate The New Date() Input Format
01040 ! Skip Punctuation (Commas, Colons, Slashes, Semicolons, And Dashes)
01060 ! Insert And Delete Within Subfields That Are Delineated By Punctuation
01080 ! Continue To Support Cut And Paste Including Punctuation
01100 !
01120 rinput fields "5,10,DATE(mm/dd/yy) ;6,10,c": DATE_VAR
01140 print fields "8,10,date(Month DD, CCYY)": DATE_VAR
01160 !
01180 rinput fields "12,10,date(month dd, ccyy)": DATE_VAR
01200 if NOT DATE_VAR then goto 1180
01220 print fields "15,10,date(yy/mm/dd)": DATE_VAR
01240 print fields "18,10,N 6": DATE_VAR !Show days format

== NEW TEXT FIELD FORMAT==

10 (R)INPUT FIELDS “row, col, TEXT rows/cols[/capacity], leading-attr, …”:

This format is similar to the C/V/G format with the ^ENTER_LF attribute except:
No trailing space padding or trimming occurs.
Rows and columns are specified.
Field capacity or newlines can cause a vertical scrollbar to appear.

Supported leading attributes are ^ENTER_LF (the default), ^ENTER_CRLF and ^NOWRAP.
The TEXT keyword will imply ^ENTER_LF unless ^ENTER_CRLF is specified.

^ENTER_LF (the default) causes the ENTER key to add LF characters to the data and to go to a new line left justified. The cursor will retrace the data when backspace or left-arrow is keyed, meaning the on-screen LF characters are represented by moving the cursor, instead of allowing it to rest on invisible LF characters.

^ENTER_CRLF may be specified in lieu of ^ENTER_LF. When that is the case, carriage returns entered are represented in the data as carriage-return-linefeed (CRLF) character pairs. ^NOWRAP may be specified to suppress word wrapping. When ^NOWRAP is active, data is entered on the current line until ENTER is keyed to go to the next line. Both horizontal and vertical scroll bars appear as needed.

Tabs are entered into the text. Shift-tab is ignored.

Home, End and the arrow keys all operate relative to the current line as opposed to operating on the text box as a whole.

Depressing the Control key causes the following keys to operate in the normal string entry mode:

*Enter – Returns control to the BR program
*Tab – Goes to the next control
*Shift-Tab – Goes to the prior control
*Home – Goes to the beginning of data or the first field
*End – Goes to the end of data or the last field
*Left-Arrow/Up-Arrow – Goes to the prior control
*Right-Arrow/Down-Arrow – Goes to the next control

* [[CurPos]] introduced.

A sample program to demonstrate TEXT entry is:
01000 ! Rep Text
01020 ! Test New Text Fiueld Type
01040 dim TEXT$*300, TEXT$(1)*80
01060 print NEWPAGE
01080 rinput fields "3,10,text 4/40/300,uh": TEXT$
01100 print fields "10,10,c": TEXT$
01120 print TEXT$
01140 let STR2MAT(TEXT$, MAT TEXT$, CHR$(10))
1160 rint MAT TEXT$

== INPUT ACROSS MULTIPLE WINDOWS==

10 (R)INPUT FIELDS #121: “10, 10, C 20, UH; 10, 12, PIC(##/##/##), UH;#124,
10, 10, C 30, UH”: aaa$, bbb$, ccc$

This will input the first two fields on window #121 and the third field on window #124. The ‘#window-number,’ prefix may appear in any row, col FIELDS specification and it overrides the window number that follows the PRINT/INPUT/RINPUT keyword.

== CONFIG CONSOLE CHANGES==

[[Console]] [[BRConfig.sys]] specification introduced.

== BR IN A BROWSER==

We have made it easy to setup BR in a Browser once you have Client Server working.
Point your browser at ads.net/plugin for a demonstration. Located in that directory is a file called index.html which is also on the FTP site in the BETA release browser-plugin directory. Modify this file to setup your own web page.

This HTML file demonstrates activation of BR client server in a browser. It first checks to see if the plugin is installed and if not it installs it. If needed, it updates the plugin from the ads.net site. It then initiates a connection to the server just like the BR client does. See the HTML file for further instructions, including how to confine BR to a window on the launch page if desired.

A new OPTION 70 is provided which will default to being ON in the Browser version. OPTION 70 will do the same thing as 54 (exit if BR enters command console mode), but it will be configurable to:
OPTION 70 OFF ! This can be set programmatically
OPTION 70 ON ! Same as OPTION 54 – the default for browsers
OPTION 70 RELAXED ! Mild security – enables some support

RELAXED mode is intended to allow some debugging but still provide some security. This means disabling commands such as COPY, DIR, etc., CONFIG commands, and preventing changes from being made to BR programs. However, the security can be defeated because all of these activities can be performed by programs or procedures. Use ON (the default) for high security.

== NEW AND CHANGED ERROR CODES==
* [[0000]] Successful completion no error
* [[0050]] Writing to BTREE2 file failed
* [[0059]] DEPRECATED ERROR: attempt to rewrite over key
* [[0063]] DEPRECATED ERROR: network locking error
* [[0417]] MSG string it too long
* [[0419]] Invalid MSG special char specification
* [[0436]] Bad flags for MAT2STR or STR2MAT
* [[0620]] DEPRECATED ERROR: duplicate OPEN for standard printer output
* [[0641]] DEPRECATED ERROR: missing protection device
* [[0635]] Error using SSL socket
* [[0717]] Error deleting record from BTREE2 file
* [[0727]] DEPRECATED ERROR: FORM variable not referenced
* [[0807]] Border characters can no longer be specified
* [[0814]] Bad or missing trailing attribute
* [[0818]] DEPRECATED ERROR: number too large for PIC format
* [[0865]] DEPRECATED ERROR: invalid attribute combination
* [[0887]] Sort column is not valid
* [[0930]] INPUT FIELDS "...RANGE" bad range variables
* [[0931]] Invalid insert or delete change with range
* [[0940]] Value does not match boolean format
* [[0941]] NULL boolean value used where allow null is false
* [[0945]] The length of the date format is excessively long
* [[1008]] Invalid keyword in shell interpreter
* [[1033]] Scalar variable in an array group
* [[2022]] The given encryption method does not exist
* [[2024]] The encryption method is only valid one way
* [[2026]] Missing encryption key
* [[2030]] Failed processing encryption
* [[2070]] DEPRECATED ERROR: not enough memory
* [[2080]] DEPRECATED ERROR: insufficient dimensioned storage
* [[2090]] DEPRECATED ERROR: not enough compilation storage
* [[2100]] Too many active procedures
* [[2101]] Illegal line number
* [[2102]] GO attempted without running program
* [[2103]] Illegal PROC parameter
* [[2104]] No active lines to run
* [[2108]] Program is active
* [[2109]] No program in memory to SAVE or REPLACE
* [[2111]] Missing lines for a program in object code
* [[2116]] Cannot SAVE during LOAD or MERGE
* [[2120]] DEPRECATED ERROR: not enough compilation storage
* [[2130]] Program changed since LOAD at another workstation
* [[3031]] DEPRECATED ERROR: 0 bytes available on disk

* [[4002]] SQL create statement failed
* [[4003]] SQL free statement failed
* [[4004]] SQL prepare failed
* [[4005]] SQL clear old results failed
* [[4006]] SQL execute direct failed
* [[4007]] WRITE to SQL with incorrect number of data elements
* [[4008]] SQL describe result set columns failed
* [[4009]] SQL bind result set columns failed
* [[4010]] SQL fetch row failed
* [[4011]] SQL bind parameter failure
* [[4012]] Prepared SQL execution failure
* [[4014]] Error converting time stamp to string value or back

* [[4114]] DEPRECATED ERROR: invalid disk or disk drive reference
* [[4115]] The specified database has not been opened
* [[4120]] Invalid Y2K data found in an index field
* [[4121]] DEPRECATED ERROR: invalid use of key file
* [[4123]] Corrupted BTREE index
* [[4128]] DEPRECATED ERROR: invalid file name
* [[4135]] DEPRECATED ERROR: volume ID invalid
* [[4137]] DEPRECATED ERROR: not enough storage space to create file
* [[4138]] Can't rename between client and server
* [[4140]] DEPRECATED ERROR: shared memory problem
* [[4141]] DEPRECATED ERROR: shared memory problem
* [[4142]] DEPRECATED ERROR: too many opened file names
* [[4143]] DEPRECATED ERROR: out of shared memory
* [[4144]] DEPRECATED ERROR: network semaphore error
* [[4145]] Time out while waiting for input from user or ASYNC file I/O
* [[4147]] A file has been opened too many times at the share level
* [[4149]] Different version of BR running with locking
* [[4159]] DEPRECATED ERROR: volume not on line
* [[4160]] Out of internal file handles
* [[4174]] Attempted file reservation on non-local file
* [[4175]] Multiple wbserver files detected
* [[4177]] DEPRECATED ERROR: windows shell call without command
* [[4179]] Failed to lock in progress on wbserver.dat
* [[4180]] Bad drive statement
* [[4185]] Setting the directory failed on the client side
* [[4194]] REWRITE check for null bytes failed
* [[4195]] READ check for null bytes failed
* [[4196]] WRITE check for null bytes failed

* [[4200]] DEPRECATED ERROR: DOS/Windows/Novell error 0
* [[4201]] DEPRECATED ERROR: DOS/Windows/Novell error 1
* [[4202]] DEPRECATED ERROR: DOS/Windows/Novell error 2
* [[4203]] Path does not exist or is not a directory
* [[4204]] Too many file handles open on the system level
* [[4205]] Access is denied
* [[4206]] Invalid file descriptor
* [[4207]] DEPRECATED ERROR: DOS/Windows/Novell error 7
* [[4208]] DEPRECATED ERROR: DOS/Windows/Novell error 8
* [[4209]] DEPRECATED ERROR: DOS/Windows/Novell error 9
* [[4210]] DEPRECATED ERROR: DOS/Windows/Novell error 10
* [[4211]] DEPRECATED ERROR: DOS/Windows/Novell error 11
* [[4212]] DEPRECATED ERROR: DOS/Windows/Novell error 12
* [[4213]] DEPRECATED ERROR: DOS/Windows/Novell error 13
* [[4214]] DEPRECATED ERROR: DOS/Windows/Novell error 14
* [[4215]] Invalid drive reference
* [[4216]] Cannot remove directory
* [[4217]] DEPRECATED ERROR: DOS/Windows/Novell error 17
* [[4218]] DEPRECATED ERROR: DOS/Windows/Novell error 18
* [[4219]] I/O error on write protected floppy
* [[4220]] DEPRECATED ERROR: DOS/Windows/Novell error 20
* [[4221]] DEPRECATED ERROR: DOS/Windows/Novell error 21
* [[4222]] DEPRECATED ERROR: DOS/Windows/Novell error 22
* [[4223]] DEPRECATED ERROR: DOS/Windows/Novell error 23
* [[4224]] File is too large for locking mode
* [[4225]] DEPRECATED ERROR: DOS/Windows/Novell error 25
* [[4226]] DEPRECATED ERROR: DOS/Windows/Novell error 26
* [[4227]] DEPRECATED ERROR: DOS/Windows/Novell error 27
* [[4228]] DEPRECATED ERROR: DOS/Windows/Novell error 28
* [[4229]] DEPRECATED ERROR: DOS/Windows/Novell error 29
* [[4230]] DEPRECATED ERROR: DOS/Windows/Novell error 30
* [[4231]] DEPRECATED ERROR: DOS/Windows/Novell error 31
* [[4232]] DEPRECATED ERROR: DOS/Windows/Novell error 32
* [[4233]] DEPRECATED ERROR: DOS/Windows/Novell error 33
* [[4234]] DEPRECATED ERROR: DOS/Windows/Novell error 34
* [[4235]] DEPRECATED ERROR: DOS/Windows/Novell error 35
* [[4236]] DEPRECATED ERROR: DOS/Windows/Novell error 36
* [[4237]] DEPRECATED ERROR: DOS/Windows/Novell error 37
* [[4238]] DEPRECATED ERROR: DOS/Windows/Novell error 38
* [[4239]] Disk is full
* [[4240]] DEPRECATED ERROR: DOS/Windows/Novell error 40
* [[4241]] DEPRECATED ERROR: DOS/Windows/Novell error 41
* [[4242]] DEPRECATED ERROR: DOS/Windows/Novell error 42
* [[4243]] DEPRECATED ERROR: DOS/Windows/Novell error 43
* [[4244]] DEPRECATED ERROR: DOS/Windows/Novell error 44
* [[4245]] DEPRECATED ERROR: DOS/Windows/Novell error 45
* [[4246]] DEPRECATED ERROR: DOS/Windows/Novell error 46
* [[4247]] DEPRECATED ERROR: DOS/Windows/Novell error 47
* [[4248]] DEPRECATED ERROR: DOS/Windows/Novell error 48
* [[4249]] DEPRECATED ERROR: DOS/Windows/Novell error 49
* [[4250]] DEPRECATED ERROR: DOS/Windows/Novell error 50
* [[4251]] DEPRECATED ERROR: DOS/Windows/Novell error 51
* [[4252]] DEPRECATED ERROR: DOS/Windows/Novell error 52
* [[4253]] DEPRECATED ERROR: DOS/Windows/Novell error 53
* [[4254]] DEPRECATED ERROR: DOS/Windows/Novell error 54
* [[4255]] DEPRECATED ERROR: DOS/Windows/Novell error 55
* [[4256]] DEPRECATED ERROR: DOS/Windows/Novell error 56
* [[4257]] DEPRECATED ERROR: DOS/Windows/Novell error 57
* [[4258]] DEPRECATED ERROR: DOS/Windows/Novell error 58
* [[4259]] DEPRECATED ERROR: DOS/Windows/Novell error 59
* [[4260]] DEPRECATED ERROR: DOS/Windows/Novell error 60
* [[4261]] Printer queue full
* [[4262]] DEPRECATED ERROR: DOS/Windows/Novell error 62
* [[4263]] DEPRECATED ERROR: DOS/Windows/Novell error 63
* [[4264]] DEPRECATED ERROR: DOS/Windows/Novell error 64
* [[4265]] DEPRECATED ERROR: DOS/Windows/Novell error 65
* [[4266]] DEPRECATED ERROR: DOS/Windows/Novell error 66
* [[4267]] DEPRECATED ERROR: DOS/Windows/Novell error 67
* [[4268]] DEPRECATED ERROR: DOS/Windows/Novell error 68
* [[4269]] DEPRECATED ERROR: DOS/Windows/Novell error 69
* [[4270]] End of file
* [[4271]] Incomplete record
* [[4272]] Key not found
* [[4273]] Help keyword or topic not found
* [[4274]] DEPRECATED ERROR: DOS/Windows/Novell error 74
* [[4275]] DEPRECATED ERROR: DOS/Windows/Novell error 75
* [[4276]] Lock does not exist
* [[4277]] DEPRECATED ERROR: DOS/Windows/Novell error 77
* [[4278]] DEPRECATED ERROR: DOS/Windows/Novell error 78
* [[4279]] DEPRECATED ERROR: DOS/Windows/Novell error 79
* [[4280]] DEPRECATED ERROR: DOS/Windows/Novell error 80
* [[4281]] DEPRECATED ERROR: DOS/Windows/Novell error 81
* [[4282]] Data does not match LINK=
* [[4283]] Updating previous/next link failed
* [[4284]] DEPRECATED ERROR: DOS/Windows/Novell error 84
* [[4285]] DEPRECATED ERROR: DOS/Windows/Novell error 85
* [[4286]] DEPRECATED ERROR: DOS/Windows/Novell error 86
* [[4287]] DEPRECATED ERROR: DOS/Windows/Novell error 87
* [[4288]] DEPRECATED ERROR: DOS/Windows/Novell error 88
* [[4289]] DEPRECATED ERROR: DOS/Windows/Novell error 89
* [[4290]] DEPRECATED ERROR: DOS/Windows/Novell error 90
* [[4291]] DEPRECATED ERROR: DOS/Windows/Novell error 91
* [[4292]] DEPRECATED ERROR: DOS/Windows/Novell error 92
* [[4293]] DEPRECATED ERROR: DOS/Windows/Novell error 93
* [[4294]] DEPRECATED ERROR: DOS/Windows/Novell error 94
* [[4295]] DEPRECATED ERROR: DOS/Windows/Novell error 95
* [[4296]] DEPRECATED ERROR: DOS/Windows/Novell error 96
* [[4297]] DEPRECATED ERROR: DOS/Windows/Novell error 97
* [[4298]] DEPRECATED ERROR: DOS/Windows/Novell error 98
* [[4299]] Cannot copy or rename file to itself

* [[4300]] Shell call return value
* [[4301]] DEPRECATED ERROR: DOS/Windows/Novell error 101
* [[4302]] DEPRECATED ERROR: DOS/Windows/Novell error 102
* [[4303]] DEPRECATED ERROR: DOS/Windows/Novell error 103
* [[4304]] DEPRECATED ERROR: DOS/Windows/Novell error 104
* [[4305]] DEPRECATED ERROR: DOS/Windows/Novell error 105
* [[4306]] DEPRECATED ERROR: DOS/Windows/Novell error 106
* [[4307]] DEPRECATED ERROR: DOS/Windows/Novell error 107
* [[4308]] DEPRECATED ERROR: DOS/Windows/Novell error 108
* [[4309]] DEPRECATED ERROR: DOS/Windows/Novell error 109
* [[4310]] DEPRECATED ERROR: DOS/Windows/Novell error 110
* [[4311]] DEPRECATED ERROR: DOS/Windows/Novell error 111
* [[4312]] DEPRECATED ERROR: DOS/Windows/Novell error 112
* [[4313]] DEPRECATED ERROR: DOS/Windows/Novell error 113
* [[4314]] DEPRECATED ERROR: DOS/Windows/Novell error 114
* [[4315]] DEPRECATED ERROR: DOS/Windows/Novell error 115
* [[4316]] DEPRECATED ERROR: DOS/Windows/Novell error 116
* [[4317]] DEPRECATED ERROR: DOS/Windows/Novell error 117
* [[4318]] DEPRECATED ERROR: DOS/Windows/Novell error 118
* [[4319]] DEPRECATED ERROR: DOS/Windows/Novell error 119
* [[4320]] Unknown system error see SYSERR function
* [[4321]] DEPRECATED ERROR: DOS/Windows/Novell error 121
* [[4322]] DEPRECATED ERROR: DOS/Windows/Novell error 122
* [[4323]] DEPRECATED ERROR: DOS/Windows/Novell error 123
* [[4324]] DEPRECATED ERROR: DOS/Windows/Novell error 124
* [[4325]] DEPRECATED ERROR: DOS/Windows/Novell error 125
* [[4326]] DEPRECATED ERROR: DOS/Windows/Novell error 126
* [[4327]] DEPRECATED ERROR: DOS/Windows/Novell error 127
* [[4328]] DEPRECATED ERROR: DOS/Windows/Novell error 128
* [[4329]] DEPRECATED ERROR: DOS/Windows/Novell error 129
* [[4330]] DEPRECATED ERROR: DOS/Windows/Novell error 130
* [[4331]] DEPRECATED ERROR: DOS/Windows/Novell error 131
* [[4332]] DEPRECATED ERROR: DOS/Windows/Novell error 132
* [[4333]] DEPRECATED ERROR: DOS/Windows/Novell error 133
* [[4334]] DEPRECATED ERROR: DOS/Windows/Novell error 134
* [[4335]] DEPRECATED ERROR: DOS/Windows/Novell error 135
* [[4336]] DEPRECATED ERROR: DOS/Windows/Novell error 136
* [[4337]] DEPRECATED ERROR: DOS/Windows/Novell error 137
* [[4338]] DEPRECATED ERROR: DOS/Windows/Novell error 138
* [[4339]] DEPRECATED ERROR: DOS/Windows/Novell error 139
* [[4340]] Unknown curl error - use -e to return OS error
* [[4341]] DEPRECATED ERROR: DOS/Windows/Novell error 141
* [[4342]] DEPRECATED ERROR: DOS/Windows/Novell error 142
* [[4343]] DEPRECATED ERROR: DOS/Windows/Novell error 143
* [[4344]] DEPRECATED ERROR: DOS/Windows/Novell error 144
* [[4345]] DEPRECATED ERROR: DOS/Windows/Novell error 145
* [[4346]] DEPRECATED ERROR: DOS/Windows/Novell error 146
* [[4347]] DEPRECATED ERROR: DOS/Windows/Novell error 147
* [[4348]] DEPRECATED ERROR: DOS/Windows/Novell error 148
* [[4349]] DEPRECATED ERROR: DOS/Windows/Novell error 149
* [[4350]] DEPRECATED ERROR: DOS/Windows/Novell error 150
* [[4351]] DEPRECATED ERROR: DOS/Windows/Novell error 151
* [[4352]] DEPRECATED ERROR: DOS/Windows/Novell error 152
* [[4353]] DEPRECATED ERROR: DOS/Windows/Novell error 153
* [[4354]] DEPRECATED ERROR: DOS/Windows/Novell error 154
* [[4355]] DEPRECATED ERROR: DOS/Windows/Novell error 155
* [[4356]] DEPRECATED ERROR: DOS/Windows/Novell error 156
* [[4357]] DEPRECATED ERROR: DOS/Windows/Novell error 157
* [[4358]] DEPRECATED ERROR: DOS/Windows/Novell error 158
* [[4359]] DEPRECATED ERROR: DOS/Windows/Novell error 159
* [[4360]] DEPRECATED ERROR: DOS/Windows/Novell error 160
* [[4361]] DEPRECATED ERROR: DOS/Windows/Novell error 161
* [[4362]] DEPRECATED ERROR: DOS/Windows/Novell error 162
* [[4363]] DEPRECATED ERROR: DOS/Windows/Novell error 163
* [[4364]] DEPRECATED ERROR: DOS/Windows/Novell error 164
* [[4365]] DEPRECATED ERROR: DOS/Windows/Novell error 165
* [[4366]] DEPRECATED ERROR: DOS/Windows/Novell error 166
* [[4367]] DEPRECATED ERROR: DOS/Windows/Novell error 167
* [[4368]] DEPRECATED ERROR: DOS/Windows/Novell error 168
* [[4369]] DEPRECATED ERROR: DOS/Windows/Novell error 169
* [[4370]] DEPRECATED ERROR: DOS/Windows/Novell error 170
* [[4371]] DEPRECATED ERROR: DOS/Windows/Novell error 171
* [[4372]] DEPRECATED ERROR: DOS/Windows/Novell error 172
* [[4373]] DEPRECATED ERROR: DOS/Windows/Novell error 173
* [[4374]] DEPRECATED ERROR: DOS/Windows/Novell error 174
* [[4375]] DEPRECATED ERROR: DOS/Windows/Novell error 175
* [[4376]] DEPRECATED ERROR: DOS/Windows/Novell error 176
* [[4377]] DEPRECATED ERROR: DOS/Windows/Novell error 177
* [[4378]] DEPRECATED ERROR: DOS/Windows/Novell error 178
* [[4379]] DEPRECATED ERROR: DOS/Windows/Novell error 179
* [[4380]] DEPRECATED ERROR: DOS/Windows/Novell error 180
* [[4381]] DEPRECATED ERROR: DOS/Windows/Novell error 181
* [[4382]] DEPRECATED ERROR: DOS/Windows/Novell error 182
* [[4383]] DEPRECATED ERROR: DOS/Windows/Novell error 183
* [[4384]] DEPRECATED ERROR: DOS/Windows/Novell error 184
* [[4385]] DEPRECATED ERROR: DOS/Windows/Novell error 185
* [[4386]] DEPRECATED ERROR: DOS/Windows/Novell error 186
* [[4387]] DEPRECATED ERROR: DOS/Windows/Novell error 187
* [[4388]] DEPRECATED ERROR: DOS/Windows/Novell error 188
* [[4389]] DEPRECATED ERROR: DOS/Windows/Novell error 189
* [[4390]] DEPRECATED ERROR: DOS/Windows/Novell error 190
* [[4391]] DEPRECATED ERROR: DOS/Windows/Novell error 191
* [[4392]] DEPRECATED ERROR: DOS/Windows/Novell error 192
* [[4393]] DEPRECATED ERROR: DOS/Windows/Novell error 193
* [[4394]] DEPRECATED ERROR: DOS/Windows/Novell error 194
* [[4395]] DEPRECATED ERROR: DOS/Windows/Novell error 195
* [[4396]] DEPRECATED ERROR: DOS/Windows/Novell error 196
* [[4397]] DEPRECATED ERROR: DOS/Windows/Novell error 197
* [[4398]] DEPRECATED ERROR: DOS/Windows/Novell error 198
* [[4399]] File name is not a UNC path

* [[4501]] OS function failure
* [[4513]] Bad data on OS function
* [[4514]] No memory on OS function
* [[4521]] Device not ready
* [[4522]] Bad system command
* [[4526]] Not a dos disk
* [[4591]] A shell call timed out
* [[4596]] Process signaled
* [[4597]] Process stopped
* [[4598]] Process was terminated in an unknown manner
* [[4614]] Invalid standard handle
* [[4616]] PDF library initialization failed
* [[4618]] An error that aborts further reconnect attempts has occurred
* [[4620]] Client server connection failure
* [[4890]] Temporary index creation failure

* [[6201]] Spooling error while executing lp or lpr
* [[6213]] Unknown windows printing error
* [[6214]] Printing windlg find resource error
* [[6215]] Printing windlg initialization error
* [[6216]] Printing windlg load resource error
* [[6217]] Printing windlg load string failure
* [[6218]] Printing windlg lock resource failure
* [[6219]] Printing windlg no memory
* [[6220]] Printing windlg failed to lock memory
* [[6221]] Printing windlg no hisntance
* [[6222]] Printing windlg no hook
* [[6223]] Printing windlg no template
* [[6224]] Printing windlg struct size
* [[6225]] Printing windlg create IC failure
* [[6226]] Printing windlg default different
* [[6227]] Printing windlg drag and drop mismatch
* [[6228]] Printing windlg print dev mode failure
* [[6229]] Printing windlg error initializing printer
* [[6230]] Printing windlg error loading driver
* [[6231]] Printing windlg no default printer
* [[6232]] Printing windlg no devices
* [[6233]] Printing windlg parse failure
* [[6234]] Printing windlg printer not found
* [[6235]] Printing windlg return default failure
* [[6236]] Printing windlg setup failure
* [[6240]] Failed opening printer DC
* [[6242]] Invalid parametrized substitution format
* [[6243]] Parameter count does not match using parametrized substitutions
* [[6244]] Parametrized substitution result is too long
* [[6245]] Unsupported escape sequence for printing
* [[6246]] Passthrough printing error
* [[6247]] Invalid NWP color specification
* [[6248]] Invalid NWP picture specification or the image is not found
* [[6250]] Invalid PDF import specification
* [[6252]] Print PDF requires either READER or an output file name
* [[6254]] Creating a new PDF document failed
* [[6255]] Adding a page to a PDF document failed
* [[6256]] Ending a PDF document failed
* [[6257]] Adding an image to a PDF document failed
* [[6270]] Spooling error
* [[6272]] Bad initializer for PJL mode
* [[7600]] Invalid or missing key start position
* [[7601]] Invalid key length
* [[7602]] Bad key
* [[7603]] Duplicate keys found
* [[7604]] Missing parameters for INDEX
* [[7605]] Invalid index parameter
* [[7606]] INDEX records in does not match records out
* [[7607]] Not enough memory for INDEX
* [[7609]] Attempt to INDEX a file that is not an internal file
* [[7610]] Invalid INDEX file name
* [[7611]] INDEX file already exists
* [[7612]] Invalid INDEX work path
* [[7636]] INDEX interrupted by user
* [[7699]] Bad internal record size for INDEX
* [[7801]] Invalid sort keyword
* [[7804]] Syntax error in SORT - FILE specification
* [[7805]] Syntax error in SORT - RECORD specification
* [[7806]] Syntax error in SORT - ALTS specification
* [[7807]] Syntax error in SORT - MASK specification
* [[7809]] Syntax error in SORT - SUM specification
* [[7810]] Attempt to SORT a file that is not an internal file
* [[7811]] Not enough memory for SORT
* [[7812]] Invalid SORT output file type
* [[7821]] ALTS value is too large
* [[7823]] Missing MASK specification
* [[7825]] Too many RECORD statements
* [[7828]] SORT specifications out of order
* [[7829]] RECORD specification too long or too many RECORD specifications
* [[7830]] RECORD lower limit is greater than upper limit
* [[7831]] Output file record length is too short
* [[7832]] Output file not empty
* [[7853]] SORT control file not found
* [[8001]] DEPRECATED ERROR: number too long
* [[8002]] Window too small for input
* [[9000]] Out of memmory
* [[9001]] work stack is full
* [[9002]] RPN stack is full
* [[9003]] Flow stack is full
* [[9004]] FOR/NEXT stack is full
* [[9005]] RPN stack is empty
* [[9006]] Too many nested IF, FOR/NEXT or DO/LOOP structures
* [[9100]] DEPRECATED ERROR: compiler error
* [[9111]] Code byte count is incorrect
* [[9112]] Source byte count is incorrect
* [[9201]] Invalid access for opening a file
* [[9203]] Invalid create for opening a file
* [[9301]] Invalid number of RPN entries
* [[9302]] Function error
* [[9303]] Invalid function
* [[9304]] User defined function error
* [[9305]] User defined function error
* [[9306]] User defined function stacking error
* [[9307]] No editor defined or invalid ON error statement
* [[9308]] Utility open file channel is not open
* [[9309]] Corrupt .BR/.WB program file encountered
* [[9310]] Variable index outside of variable table
* [[9400]] DEPRECATED ERROR: output file corrupted
* [[9401]] BTREE verification failed
* [[9502]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9503]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9504]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9505]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9506]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9507]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9508]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9985]] DEPRECATED ERROR: work file missing
* [[9987]] No source exists for the given file
* [[9988]] DEPRECATED ERROR: source line greater than 800 bytes
* [[9990]] This version was made without HTTP support
* [[9992]] DEF statement compiler error
* [[9994]] Line reference indicates library, but no libraries active
* [[9995]] DEPRECATED ERROR: RPN stack failure
* [[9996]] Library program not found or internal line not found
* [[9997]] Unbalanced parenthesis or flow stack error
* [[9998]] Corrupt DIM source

[[Category:Needs Help]]

[[Category:Release 4.3]]
[[Category:Release Notes]]

4.3

2017-01-16T19:39:50Z

GomezL: /* Open SQL */

The prior version was [[4.2]]

Note that the information release notes have been incorporated into the relevant wiki pages, but are left here in their original form.

==Grid and List Changes==

Arrays are automatically resized when receiving data from 2D INPUT operations. This also applies to grouped arrays. Automatic resizing only applies to one dimensional arrays and does not occur when INPUTing into two dimensional arrays.

Example where all arrays are one dimensional and may have the incorrect number of elements:
INPUT FIELDS "row,col,LIST rows/cols, ROW, ALL" : (MAT Array1$, MAT Array2$, MAT Array3, MAT Array4, MAT Array5$)

===Three New Read Types===
Notes:
Auto Resizing applies

Selection Type must be ALL

The original 2D INPUT read types are:
CNT - The number of cells specified.
SUB - Read the Cell Subscript Values.
CELL - Read each cell specified.
ROWCNT - The number of rows specified.
ROWSUB - The subscripts of the specified rows.
ROW - Read all cells in each specified row.

HEADERS – The original PRINT FIELDS HEADER values.
e.g. INPUT FIELDS "row,col,LIST rows/cols, HEADERS" : (MAT HEADINGS$,MAT WIDTHS, MAT FORMS$)

COLCNT - The number of columns established by the header arrays.
e.g. INPUT FIELDS "row,col,LIST rows/cols, COLCNT, ALL" : numeric-variable

These are for generalized library routines to inspect passed controls.

SORT_ORDER - Provides a value of zero for each unsorted column and gives the ascending sequence of column sorts that have occurred. If a column has been reversed (double sorted) it's value will be negative.

e.g. INPUT FIELDS "row,col,LIST rows/cols, SORT_ORDER, ALL" : numeric-array
Given the following history of sorting a four column GRID:
• column 1 (descending most recent)
• column 2 (ascending first sorted)
• column 3 (not sorted)
• column 4 (sorted ascending)

SORT_ORDER would return-
array(1) -> -1
array(2) -> 3
array(3) -> 0
array(4) -> 2

===Restoring a User Sorted 2D Control===

The syntax for sorting an array is currently:

PRINT FIELDS "nn,nn,GRID 10/40,SORT": { column number }

This has been extended to allow a numeric array of instead of a scalar.
If an array is given, it is assumed to be in the same format that SORT_ORDER
returns. The new format is:

PRINT FIELDS "nn,nn,GRID 10/40,SORT": { column-number | numeric-array }

Where the numeric-array has one element for each column left to right. BR will resort the columns in the requested order.

The numeric array values indicating the order of column sorting to be performed
do not need to exactly match the standard format. e.g Fractions are
allowed, the values can fall within any range, and there does not need to
be trailing zero elements for unsorted columns.

A new Read Qualifier is available.
DISPLAYED_ORDER - indicates that the read operation is to not restore the data into it's original order before returning the results to the program.
e.g. INPUT FIELDS "row,col,LIST rows/cols, ROWSUB, ALL, DISPLAYED_ORDER, NOWAIT": numeric-array
This reads the original row subscripts for all rows - in their present order. This qualifier works only with the ALL selection type. It may be used in conjunction with other qualifiers such as FKEY.

===Range Selection Type===

Valid current selection types are:
SEL - Read one or more selected items.
SELONE - Select only one item.
ALL - Read all items in the control (except headings).
CUR - Current cell or row number.
CHG - All cells or rows who’s values have been changed by the operator.

BR now supports the following additional selection types:
RANGE - Specifies which portion of a 2D control is to be input.
CELL_RANGE – A special type of output range.

====Range Input====

In the folowing examples BR will redimension the receiving arrays as needed:

INPUT FIELDS "row,col,LIST rows/cols, CELL, RANGE" :
start, end, MAT Data$
This reads the specified range of cells. BR redimensions MAT Data$ as needed. Note that CELL may now be used with LIST. Previously, LISTs were only addressable by row.

INPUT FIELDS "row,col,LIST rows/cols, ROW, RANGE" :
(start:=7), (end:=11), ( MAT Array1$, MAT Array2, MAT Array3$ )
This reads the cells in rows 7 through 11. The recieving arrays are
redimensioned as appropriate.

INPUT FIELDS "row,col,GRID rows/cols, ROW, RANGE" :
MAT start, MAT end, ( MAT Data1$, MAT Data2$, MAT Data3 )
This reads one or more ranges of rows.

A more detailed example of this is:
100 -- create and populate a LIST control --
........
200 MAT START(3) : MAT END(3)
210 READ MAT START, MAT END
220 DATA 7,21,33
230 DATA 11,21,38
240 INPUT FIELDS "row,col,LIST rows/cols, ROW, RANGE" : MAT START,
MAT END, ( MAT Array1$, MAT Array2, MAT Array3$ )
This reads 12 rows of data ( row 7-11, row 21 and rows 33-38 ).

====Range Output====

By default, RANGE output refers to rows. The special keyword CELL_RANGE
is used to denote the specification of cell ranges. Additionally,
the use of scalars versus arrays for start and end values determines
important characteristics of the output process.

Using Scalars For Range Specification

PRINT FIELDS "7,8,GRID 10/75, RANGE": start, end, MAT Data$

This replaces the values in rows numbered 'start' through 'end'
with the data in MAT Data$. The size of MAT Data$ must be a multiple
of the number of columns in the GRID or an error is generated.

PRINT FIELDS "7,8,LIST 10/75, RANGE": start, end, (MAT NAME$,
MAT CITY$, MAT AGE, MAT WEIGHT)

This replaces the values in ROWs numbered 'start' through 'end'
with the data from MATs NAME$, CITY$, AGE and WEIGHT. The data arrays
must all be dimensioned the same.

====Insertion and Deletion====

The number of rows being output do not need to match the number of rows
being replaced. To delete a range of rows, output one or more grouped arrays with zero elements.

Examples- Using the following statement various scenarios are described.

PRINT FIELDS "7,8,LIST 10/75, RANGE": start, end, (MAT NAME$,
MAT CITY$, MAT AGE, MAT WEIGHT)

start=7, end=11, and the arrays have been DIMed to nine elements
Result- Nine rows replace five, and the total content of the control is
expanded by 4 rows.

start=7, end=11, and the arrays are DIMed to zero elements
Result- Five rows are deleted, and the total size of the control is
reduced by 5 rows.

start=7, end=0 (anything less than 7), and the arrays are DIMed to
support three rows
Result- Three rows are inserted ahead of row seven and the total content
of the control is expanded by three rows

start=5000, end={any value}, the control only has 482 rows, and the source
arrays are DIMed to support eleven rows
Result- Eleven rows are appended to the end of the control and become
rows 483 through 493.

====Outputting Ranges of Cells====

Ranges of cells may be output in conjunction with the CELL_RANGE keyword.

PRINT FIELDS "7,8,LIST 10/75, CELL_RANGE": start, end, (MAT NAME$,
MAT CITY$, MAT AGE, MAT WEIGHT)
- or -

PRINT FIELDS "7,8,GRID 10/75, CELL_RANGE": start, end, MAT Data$

In this case, start and end specify cells instead of rows. If insertion or deletion is indicated by dimensioning the data arrays to greater or fewer elements than are being replaced, then the data must be a multiple of the number of columns. Insertion and deletion is only valid in terms
of rows, even when cell subscripts are used to specify ranges. In such cases, if the cell subscripts are not on row boundaries, an error is generated.

PRINT FIELDS "7,8,GRID 10/75, CELL_RANGE": start, start, Data$

In this example, the value in one cell is replaced with the content of
a scalar.

====Using Arrays For Range Specification====

If the start and end specifications are arrays, denoting multiple ranges, there must be a one to one correspondence between the number of rows specified and those in the data. This method implies replacement only and insertion or deletion is not allowed.

The data flow that this feature was designed to support is one where the user is presented with a LIST or GRID where multiple rows have been either selected or changed before returning control to the program and the program is responding by updating something on those rows.

The program begins by presenting a 2D control to the user and reading the the control with type ROWSUB or SUB. Type SUB only works for GRIDs where all colmns have the same data type. Of course the subscripts are read into a numeric array which BR redimensions as appropriate. Then the program reads the changed or selected data with NOWAIT. (This resets the CHG flags in the control.) The program then changes either row (ROWSUB) or cell (SUB)
data and outputs the results using the subscript array as both the start and end specification. Other scenarios are possible but this is the primary intended use.

An example of this is:
100 -- create and populate a GRID --
........
200 INPUT FIELDS "row,col,GRID rows/cols,ROWSUB,CHG": MAT Rowsubs
(Reading subscripts does not reset the CHG flags in the control.)
210 INPUT FIELDS "row,col,GRID rows/cols,ROW,CHG,NOWAIT": ( MAT Data1$,
MAT Data2, MAT Data3$ )
BR redimensions the receiving arrays as needed.
(Reading the data also resets the CHG flags in the control.)

220 -- process the changed rows now present in the data arrays --
........
300 PRINT FIELDS "row,col,GRID rows/cols,RANGE": MAT Rowsubs,
MAT Rowsubs, ( MAT Data1$, MAT Data2, MAT Data3$ )

This outputs the updated rows.

==Logging Enahncements==

See [[Logging]] for details.

==Fine Grain Field Positioning==
ROW/COL and ROWS/COLS in FIELDS operations may be expressed as
decimal fractions.

==CSV and XML Parsing Enhancements==

See [[Str2Mat]] for details.

==New DLL Structure of Business Rules!==

As of Release 4.3 Business Rules! is restructured into the following modules:

Client and Server User Interface Modules
*[[brserver.exe]] – The BR Server module accessed by Client-Server configurations
*[[brcombined.exe]] – What is now viewed as the Standard Model
*[[brclient.exe]] – The program that the user accesses in Client-Server configurations
*[[plbrclient.dll]] - The standard (non-IE) browser plugin dll
*[[iebrclient.dll]] – Internet Explorer plugin dll

Processor DLLs – Stored in the AppData\Local directory for each user and on each server.
*[[brserverdll]]-(version,platform,etc info).dll
*[[brclientdll]]-(version,platform,etc info).dll

Updates will pertain to Processor DLLs while the user interfaces will remain as installed. Client DLLs will be automatically uploaded when corresponding server DLLs are accessed in the event they are not already present on the client.

The client can be accesed from within a browser by initiating it with [[HTML]] which can specify an embedded window or a separate independent window. In all cases opening a window with [[PARENT=NONE]] creates a separate window.

Each user will have a copy of either brcombined.exe or brclient.exe, but there are no licensing concerns because clients are not licenced. Only BR Servers are licensed.

==Client Server Reconnect Configuration Statement==

CLIENT_SERVER RECONNECT_AFTER=20 ERROR_AFTER=180 EXIT_AFTER=300

The client will attempt to reconnect to the server after RECONNECT_AFTER seconds (default is 20 seconds).

ERROR_AFTER generates a BR error and awaits for reconnection (default is 120 seconds).

EXIT_AFTER generates a BR error and continues in unattended mode ( no client IO allowed - exit at next keyboard wait ). This is the normal exit from an unrecoverable disconnect (default is 240 seconds).

If both ERROR_AFTER and EXIT_AFTER are specified, EXIT_AFTER will terminate an ERROR_AFTER wait.

When a client is attempting to reconnect, it displays the session number it is using. The normal client login window will contain a check box that facilitates the entry of a reconnection session number. This allows reconnection from another workstation.

==Autoit Support==

Right now [[Autoit]] has trouble reading BR window content. We will correct that and see what other features we can provide to ease the integration of Autoit with BR, including possibly supporting Autoit DLL linkage.

==ODBC Version 4.3==

[[ODBC]] version 4.3 released.

==SQL Support==

BR will use a single SQL server module to perform all SQL database access. This ‘engine’ will communicate with multiple BR sessions via TCP/IP. Normally the engine resides in the same directory as BR, but may reside elsewhere on the network.

===New World SQL Support===
==Config Database==

CONFIG DATABASE may use one of 3 methods for connecting to SQL Sources
*DSN
*CONNECTSTRING
*ODBC-MANAGER

===DSN===
CONFIG DATABASE db-ref DSN=dsn-ref [, USER= department | LOGIN_NAME | ? ] [, {PASSWORD= dept-password | BR_PASSWORD | ?} | PASSWORDD=encrypted-passwd ]
? indicates prompt

Example: EXECUTE 'CONFIG DATABASE CLS_Data DSN="MyData"'

===CONNECTSTRING (DSN Less)===
CONFIG DATABASE db-ref CONNECTSTRING="Driver={Microsoft Access Driver (*.mdb)} DBQ=C:\inetpub\wwwroot\BegASP\Chapter.14\Contact.mdb"

'''Sample Connection Strings:'''

Using a SQL Server /w SQL Login:
CONFIG database db-ref connectstring="DRIVER=SQL Server;SERVER=server;Initial Catalog=database;UID=username;PWD=password"
db-ref is the database reference.
server is the SQL Server [FQDN] or IP Address
database is the [SQL Server Database]
username is the [SQL Server User Name]
password is the [SQL Server Password]

Using a SQL Server /w Windows Authentication:
CONFIG database db-ref connectstring="DRIVER=SQL Server;Initial Catalog=database;Persist Security Info=True;MultipleBC_TableResultSets=True; Database=database;SERVER=server;Login Name=username;Password=BR_PASSWORD"
db-ref is the database reference.
server is the SQL Server [FQDN] or IP Address
database is the [SQL Server Database]
username is the [SQL Server User Name]
Note that BR_PASSWORD will use the users Active Directory password to connect to the SQL Server.
Note that "SQL Server" is one of several choices for SQL Server, another choice would be SQL Server Native Client 11.0

===ODBC-MANAGER===
CONFIG DATABASE db-ref ODBC-MANAGER

Using ODBC Manager as the parameter will allow the end use to select the desired datasouce.

==Open SQL==
OPEN #20: "DATABASE= db-ref" , SQL "sql-statement", OUTIN

Example: OPEN #20: "DATABASE=MyData",SQL "SELECT FILENO,BALANCE from MASTER WHERE FILENO=?",OUTIN
- or -

OPEN #20: "DATABASE= db-ref, Name= filename" , SQL, OUTIN
- filename refers to a DISPLAY file containing an SQL statement
that gets executed when a WRITE statement is processed -

Begin processing with a WRITE statement.
If the WRITE conatins an IO list of values then it is used to populate the
'filename' SQL before it is executed.
This may or may not produce a result set. If it does, the result set may be
processed like a BR file opened RELATIVE. Some operations that use file
positioning may be slow since the whole result set may not be in memory
immediately. Simple sequential access should be fairly quick.
Once SQL has been populated by an IOlist, it may be reused with the same values
by issuing a WRITE with no IOlist.
READ IOlist variable associations are positional with each READ accessing one
row of values.

New System Functions
A$ = SQL_DATE("date-value" [,"value-format"]) ! format date for storage
B$ = BR_DATE(vtring-var$ [,"format"]) ! upack DB date value

* Note: SQL DATETIME fields are "Packed for Storage", but "DATE" fields are returned as a CCYY-MM-DD string in a SQL Query. DATE returns "BLANK" for "Empty or Null Date"

=== (Future) Legacy SQL Support===

!!! This feature is a planned addition, and is not implemented yet!!!

If a file that is opened INTERNAL is really a DISPLAY file which has as the
first four characters "#SQL" then the file will be regarded as an SQL Reference
file which must be in the following format:

#SQL
DATABASE= -DB ref-
CONTEXT= dictionary-path

The file may then be processed as an INDEXED or RELATIVE BR file.
If Indexing is specified, the Index file is used to identify the key elements
to be used by BR for record selection. Split keys are broken into multiple
values by field length.

When a READ or WRITE is issued, BR transfers data between variables in memory
and data in the DB using its own internally generated SQL control statements.
It uses the ODBC dictionary (CONTEXT) to translate BR FORM statement field
positions and formats to dictionary field names. These names are then used to
access the database during READ and WRITE operations.

==Other Developments==

[[Gary Hoff]] may get into the development cycle for some BR [[4.4]] features that will move BR into the world of mobile computing.

[[Category:Needs Help]]

[[Category:Release 4.3]]
[[Category:Release Notes]]

Client Server Reconnect

2017-01-16T17:59:20Z

GomezL: Added Troubleshooting

This Client Server Reconnect Configuration Statement can be used in versions 4.3 and higher.

CLIENT_SERVER RECONNECT_AFTER=20 RECONNECT_TIME=300

The client will attempt to reconnect to the server after RECONNECT_AFTER seconds (default is 20 seconds).

RECONNECT_TIME= specifies the maximum time to be spent attempting to reconnect (default is 120 seconds) before aborting the session.

When a client is attempting to reconnect, it displays the session number it is using. The normal client login window will contain a check box that facilitates the entry of a reconnection session number. This allows reconnection from another workstation.

[[Troubleshooting]]

Sometimes client server will disconnect when executing a particularly long/slow command. In these situations, setting this command to higher values may help. Setting both values to 999 seems to work in most cases.

Caution should be used when setting this value as the workstation will appear to "Lock up" while it is waiting, and if the server actually fails, the client will wait until the time limit has been reached.

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

4.30

2016-06-11T18:10:33Z

GomezL: /* EXTENDED DATE / TIME FUNCTIONS */

Status: [[Beta]]

The prior versions were [[4.1]] and [[4.2]].

As Of 08/30/2012

==MISCELLANEOUS ENHANCEMENTS==

“ON error-type IGNORE” now ignores the error instead of going to an Ignore label. This is effective for both ON statements and individual statement error exits. This could change the way your programs work if your Ignore statements do more than CONTINUE.

The general purpose ERROR exit implies SOFOW truncation. So statements that are governed by ERROR IGNORE also do SOFLOW truncation as needed.

For client / server configurations:
SPOOLPATH @: client-pathname
Sets the remote spool path on the client. In addition to regular spool files, this is where PDF files are created. SPOOLPATH can be set concurrently for both client and server by specifying two SPOOLPATH statements. The @: indicates remote.

The client-pathname has some unique characteristics:
Paths are assumed to be OS pathnames relative to the CLIENT_CURRENT_DIR folder, or the startup directory if CLIENT_CURRENT_DIR is not specified.
If a full pathname is specified it must begin with a colon. ( e.g. @::X:\path ) Otherwise it will be preceded with the path to the client current working directory.
Specifying a relative remote pathname is not compatible with CLIENT_CURRENT_DIR SYNC.
The status of SPOOLPATH and REMOTESPOOLPATH settings are displayed in response to the STATUS SUBSTITUTE command.

CHR$(6) is a field separator that displays as a space but causes the immediately preceding data to be right justified. This applies to both Native Windows Printing and PRINT FIELDS.

MAT2STR, STR2MAT changes to trim outside of quotes, but not inside of quotes and to always quote MAT2STR when quotes are present.

STATUS USERS will display the WSID and name of each user logged in on the network.
The SQL statement SHOW USERS responds with the same information for ODBC users.

BRERR$ is a new system function that display the description of BR ERR value.
BRERR$(error-code) returns the description of that code.
Examples-
When ERR returns 4270, BRERR$ will return “end of file”.
BRERR$(0875) returns “unrecognized data after field specification”

For making it easier to configure ODBC with BRconfig.sys and to setup common configuration files for multiple platforms we have added:
@LINUX
@WINDOWS
@MAC
@ODBC

For example, this could be important for DRIVE statements:
@LINUX DRIVE C:,/unix/path,.,\
@WINDOWS DRIVE C:,\\server\path,.,\

Programs compiled with older versions of BR (3.3 – 3.8) can be listed accurately.

=== GRID AND LIST CHANGES===

Arrays are automatically resized when receiving data from 2D INPUT operations. This also applies to grouped arrays. Automatic resizing only applies to one dimensional arrays and does not occur when INPUTing into two dimensional arrays.

e.g. INPUT FIELDS "row,col,LIST rows/cols, ROW, ALL" : ( MAT Array1$,
MAT Array2$, MAT Array3, MAT Array4, MAT Array5$ )
Where all arrays are one dimensional and may have the incorrect number of elements.

==== Three New Read Types====
Notes-
Auto Resizing applies
Selection Type must be ALL

The original 2D INPUT read types are:
CNT - The number of cells specified.
SUB - Read the Cell Subscript Values.
CELL - Read each cell specified.
ROWCNT - The number of rows specified.
ROWSUB - The subscripts of the specified rows.
ROW - Read all cells in each specified row.

HEADERS – The original PRINT FIELDS HEADER values.
e.g. INPUT FIELDS "row,col,LIST rows/cols, HEADERS,,NOWAIT" :
(MAT HEADINGS$,MAT WIDTHS, MAT FORMS$)

COLCNT - The number of columns established by the header arrays.
e.g. INPUT FIELDS "row,col,LIST rows/cols, COLCNT, ALL" : numeric-variable

These are for generalized library routines to inspect passed controls.

SORT_ORDER - Provides a value of zero for each unsorted column and gives
the ascending sequence of column sorts that have occurred. If a column has
been reversed (double sorted) it's value will be negative.

e.g. INPUT FIELDS "row,col,LIST rows/cols, SORT_ORDER, ALL" : numeric-array
Given the following history of sorting a four column GRID:
column 1 (descending most rescent)
column 2 (ascending first sorted)
column 3 (not sorted)
column 4 (sorted ascending)

SORT_ORDER would return-
array(1) -> -1
array(2) -> 3
array(3) -> 0
array(4) -> 2

=== Restoring a User Sorted 2D Control===

The syntax for sorting an array is currently:

PRINT FIELDS "nn,nn,GRID 10/40,SORT": { column number }

This has been extended to allow a numeric array of instead of a scalar. If an array is given, it is assumed to be in the same format that SORT_ORDER returns. The new format is:

PRINT FIELDS "nn,nn,GRID 10/40,SORT": { column-number | numeric-array }

Where the numeric-array has one element for each column left to right. BR will resort the columns in the requested order.

The numeric array values indicating the order of column sorting to be performed do not need to exactly match the standard format. e.g Fractions are allowed, the values can fall within any range, and there does not need to be trailing zero elements for unsorted columns.

=== A new Read Qualifier is available.===
[[Displayed_Order]] introduced

===Masked 2D Display===

LIST and GRID support the MASK operation-

PRINT FIELDS "row,col,LIST rows/cols,MASK" : mask_array

This restricts the rows (for both LIST and GRID) previously displayed to those corresponding to a “true” value in mask_array. A true value is represented in a umeric array as a value greater than zero. Negative values are not allowed in mask arrays. A string mask array may also be used with “T” and “F” values. The MASK stays in effect until 1) a new MASK is specified or 2) the contents of the control are changed with PRINT ( =, +, - see Output Operations in New Console.DOC).

INPUT FIELDS "row,col,LIST rows/cols,MASK [,NOWAIT]" : mask_array
This reads the display mask setting for a 2D control.

The mask array affects only the user presentation.. not the result set. Use RANGE processing or the CHG selection type to selectively read from a 2D control.

== New Search Field Type: Filter ==

See [[Filter]]
== New Config: Filter_Delimiters ==

See [[Filter_Delimiters]]

== FIELDS CHARACTER BY CHARACTER KEYBOARD CONTROL==

[[^KeyStroke and ^DataChg]] introduced.

== RANGE SELECTION TYPE==

Valid current selection types are:
SEL - Read one or more selected items.
SELONE - Select only one item.
ALL - Read all items in the control (except headings).
CUR - Current cell or row number.
CHG - All cells or rows who’s values have been changed by the operator.

BR now supports the following additional selection types:
RANGE - Specifies which portion of a 2D control is to be input.
CELL_RANGE – A special type of output range.

=== RANGE Input===

In the following examples BR will redimension the receiving arrays as needed:

INPUT FIELDS "row, col, LIST rows/cols, CELL, RANGE" : start, end, MAT Data$

This reads the specified range of cells. BR redimensions MAT Data$ as needed. Note that CELL may now be used with LIST. Previously, LISTs were only addressable by row.

INPUT FIELDS "row, col, LIST rows/cols, ROW, RANGE" :
(start:=7), (end:=11), ( MAT Array1$, MAT Array2, MAT Array3$ )

This reads the cells in rows 7 through 11. The receiving arrays are redimensioned as appropriate.

INPUT FIELDS "row, col, GRID rows/cols, ROW, RANGE" :
MAT start, MAT end, ( MAT Data1$, MAT Data2$, MAT Data3 )
This reads one or more ranges of rows.

A more detailed example of this is:
100 -- create and populate a LIST control --
........
200 MAT START(3) : MAT END(3)
210 READ MAT START, MAT END
220 DATA 7,21,33
230 DATA 11,21,38
240 INPUT FIELDS "row, col, LIST rows/cols, ROW, RANGE" : MAT START,
MAT END, ( MAT Array1$, MAT Array2, MAT Array3$ )

This reads 12 rows of data ( row 7-11, row 21 and rows 33-38 ).

=== RANGE Output===

By default, RANGE output refers to rows. The special keyword CELL_RANGE is used to denote the specification of cell ranges. Additionally, the use of scalars versus arrays for start and end values determines important characteristics of the output process.

4c) Using Scalars For Range Specification

PRINT FIELDS "7, 8, GRID 10/75, RANGE": start, end, MAT Data$

This replaces the values in rows numbered 'start' through 'end' with the data in MAT Data$. The size of MAT Data$ must be a multiple of the number of columns in the GRID or an error is generated.

PRINT FIELDS "7, 8, LIST 10/75, RANGE": start, end, (MAT NAME$,
MAT CITY$, MAT AGE, MAT WEIGHT)

This replaces the values in ROWs numbered 'start' through 'end' with the data from MATs NAME$, CITY$, AGE and WEIGHT. The data arrays must all be dimensioned the same.

=== Row Insertion and Deletion===

The number of rows being output do not need to match the number of rows being replaced. To delete a range of rows, output one or more grouped arrays with zero elements.

Examples- Using the following statement various scenarios are described.

PRINT FIELDS "7,8,LIST 10/75, RANGE": start, end, (MAT NAME$,
MAT CITY$, MAT AGE, MAT WEIGHT)

Start=7, end=11, and the arrays have been DIMed to nine elements
Result- Nine rows replace five, and the total content of the control is
expanded by 4 rows.

Start=7, end=11, and the arrays are DIMed to zero elements
Result- Five rows are deleted, and the total size of the control is
reduced by 5 rows.

Start=7, end=0 (anything less than 7), and the arrays are DIMed to
support three rows
Result- Three rows are inserted ahead of row seven and the total content
of the control is expanded by three rows

Start=5000, end={any value}, the control only has 482 rows, and the source
arrays are DIMed to support eleven rows
Result- Eleven rows are appended to the end of the control and become
rows 483 through 493.

=== Outputting Ranges of Cells===

Ranges of cells may be output in conjunction with the CELL_RANGE keyword.

PRINT FIELDS "7,8,LIST 10/75, CELL_RANGE": start, end, (MAT NAME$,
MAT CITY$, MAT AGE, MAT WEIGHT)
- or -

PRINT FIELDS "7,8,GRID 10/75, CELL_RANGE": start, end, MAT Data$

In this case, start and end specify cells instead of rows. If insertion or deletion is indicated by dimensioning the data arrays to greater or fewer elements than are being replaced, then the data must be a multiple of the number of columns. Insertion and deletion is only valid in terms
of rows, even when cell subscripts are used to specify ranges. In such cases, if the cell subscripts are not on row boundaries, an error is generated.

PRINT FIELDS "7,8,GRID 10/75, CELL_RANGE": start, start, Data$
In this example, the value in one cell is replaced with the content of a scalar.

=== Using Arrays For RANGE Specification===

If the start and end specifications are arrays, denoting multiple ranges, there must be a one to one correspondence between the number of rows specified and those in the data. This method implies replacement only and insertion or deletion is not allowed.

The data flow that this feature was designed to support is one where the user is presented with a LIST or GRID where multiple rows have been either selected or changed before returning control to the program and the program is responding by updating something on those rows.

The program begins by presenting a 2D control to the user and reading the the control with type ROWSUB or SUB. Type SUB only works for GRIDs where all colmns have the same data type. Of course the subscripts are read into a numeric array which BR redimensions as appropriate. Then the program reads the changed or selected data with NOWAIT. (This resets the CHG flags in the control.) The program then changes either row (ROWSUB) or cell (SUB)
data and outputs the results using the subscript array as both the start and end specification. Other scenarios are possible but this is the primary intended use.

An example of this is:
100 -- create and populate a GRID --
........
200 INPUT FIELDS "row,col,GRID rows/cols,ROWSUB,CHG": MAT Rowsubs
(Reading subscripts does not reset the CHG flags in the control.)
210 INPUT FIELDS "row,col,GRID rows/cols,ROW,CHG,NOWAIT": ( MAT Data1$,
MAT Data2, MAT Data3$ )
BR redimensions the receiving arrays as needed.
(Reading the data also resets the CHG flags in the control.)

220 -- process the changed rows now present in the data arrays --
........
300 PRINT FIELDS "row,col,GRID rows/cols,RANGE": MAT Rowsubs,
MAT Rowsubs, ( MAT Data1$, MAT Data2, MAT Data3$ )

This outputs the updated rows.

== FINE GRAIN FIELD POSITIONING==
ROW/COL and ROWS/COLS in FIELDS operations may be expressed as decimal fractions.

== LOGGING ENHANCEMENTS==
The debug versions of BR now expect you to use a LOGGING configuration statement. This enables BR to post exit messages during unexpected terminations.

A system function called DEBUG_STR( message-level, string-value ) will, depending on LOG LEVEL, send data to the LOGGING file as well as to the MyEditBR debugger if it is attached, or optionally to the command console if the debugger is not attached and GUI is ON. This lets you freely put trace related informational statements into your code without affecting normal processing.

The LOGGING configuration statement now has two additional optional parameters:

LOGGING loglevel, logfile [ ,DEBUG_LOG_LEVEL=nn ] [ ,+CONSOLE ]

Note- Logfile is a native OS filename. Second and subsequent occurrences of the LOGGING statement may omit loglevel and the log filename.

DEBUG_LOG_LEVEL specifies the log level for debugging log messages Independently of the standard log level. If not specified the Debug_Log_Level is set to the standard log level.

+CONSOLE applies only when GUI is ON and specifies that all logging messages also go to the console and the console is to be left visible when not attached to MyEditBR. ( Console logging output is suppressed when GUI is OFF. )

Message Levels are compared with Log Levels during the filtering process. The Logging Level is meant to specify the level of detail to be logged, with greater detail logged at higher log levels.

The following types of messages are written to the LOGGING file:

Config error messages based on their assigned level of importance.

DEBUG_STR() messages where message-level is equal to or less than the DEBUG_LOG_LEVEL.

Log levels 0, 1, 2 and 3-
System generated warning messages such as OS failures and abnormal exits.
Log level 5 or above-
User Logon data, including any logon attempts.
Log level 6 or above-
Starting a BR program, exiting.
Log level 8 or above-
Commands such as COPY plus shell calls with parameters.
PDF printing events.
Log level 11 or above-
Any PRINT output that goes to the console is also logged (GUI ON only).
Log level 12 or above-
TRACE, and DISPLAY messages.
Log level 13 or above-
Lots of what the system is doing now messages.

Any DEBUG_STR() calls with a level >10 are deemed to be message level 10.

Logging was added to PDF creation. Logging of minor events that happen during the printing process are logged at log level 8. Errors are logged at a lower level. Logging was also improved with respect to loading older versions of pdflib.
Note- As a diagnostic, the following command is quite useful:
DIR >PDF:/READER

ODBC Logging was substantially increased.

Log Level Indication is given in Log Messages:
(6) - 08/25/2011 11:33:53
Setting logging to log file logfile.txt log level 10.
(6) - 08/25/2011 11:33:53
The BRConfig.sys file is C:\Users\dan\programs\cygwin\home\dan\br-wx\br\winbuild\dllbuild\output\brconfig.sys
The (6) here is the log level.

== CSV AND XML PARSING ENHANCEMENTS==
The string to mat and mat to string functions have been extended to ease parsing of CSV and XML data.

STR2MAT( str$, MAT zzz$ [, [MAT] Sep$ [, flags$]] )
Where Sep$ may be an array and flag$ is in the format:
[ quote-type ] [ :LTRM ] | [ :TRIM ] | [ :RTRM ]
Where quote-type can be Q, QUOTES, ('), or ("), case insensitive. Q and QUOTES denote standard BR quote processing. The trim flags denote post processing of extracted elements and the leading colon is only present when quote-type is specified.
When Sep$ is an array, then any or all of the specified values are deemed to represent a single separator with the qualification that any one separator, cannot occur more than once in a string of adjacent separators. To restate this, when elements of a Sep$ array occur adjacent to each other within the source string, they are grouped as a separator substring.
Sep$ elements cannot occur more than once in a separator substring. When they do, it denotes the specification of a null element. e.g. two successive commas or two successive occurrences of CR+LF both denote null elements. Essentially when Sep$ elements are 'consumed' by their recognition within the source string, then they cannot be re-recognized without inserting a null element into the output array.
=== Quote Processing ===
Quotation marks suppress the recognition of separators in accordance with the following rules.
Standard BR Quote Processing
When examining str$ left to right, the first character (and the first character after each separator) is checked to see if is either (') or ("). If it is either of those then it activates quotation processing which suppresses the recognition of separators until quotation processing is deactivated. The first character thus becomes the governing quote type until quotation processing is deactivated.

The string is copied until it ends or until an odd number of successive occurrences of the governing quote type is encountered. During this processing, two adjacent occurrences of the governing quote character denote an embedded occurrence of the quote character.
Examples
"abc,def" -> abc,def where the comma is not recognized as a separator and is part of the data
abc"def -> abc"def naturally embedded quotes may occur anywhere within a string after the first character
"abc"def" -> abcdef" quotation processing is deactivated by the center quote mark
"abcdef" -> abcdef normal data
"abc'def" -> abc'def the single quote is treated like any other character while double quotes govern
'abc"def' -> abc"def double quotes are treated like any other character while single quotes govern
"abc""def" -> abc"def pairs of governing quotes denote a single embedded quote
"abc"""def" -> abc"def" the third successive occurrence deactivates quote processing which began with the first quote

MAT2STR( MAT zzz$, str$ [, sep$ [, flags$]] )
Where flag$ is in the format:
[ quote-type ] [ :LTRM ] | [ :TRIM ] | [ :RTRM ]
Where quote-type can be Q, QUOTES, ('), or ("), case insensitive. Quote-type denotes that each element should be enclosed in quotation marks. The trim flags denote pre-processing of array elements and the leading colon is only present when quote-type is specified.
If Q or QUOTES is specified then BR automatically determines which quote type to apply as follows:
First the element is unpacked. That is, if it is contained in quotes, the quotes are stripped and embedded pairs are singled. Next the element is scanned left to right for either type of quote character ( single or double ). If a quote character is encountered the element is enclosed in the alternate quote type and embedded occurrences of that quote type are doubled. If no quote character is encountered then double quotes are applied.
Examples
Quote Type is Q or QUOTES
abcdef -> "abcdef"
abc'def -> "abc'def"
abc"def -> 'abc"def'
abc""def -> ‘abc""def’ embedded quotes are left intact when quotes are not active
'abcdef -> "'abcdef"

Quote Type is ' ( quote type single )
abcdef -> 'abcdef'
'abcdef -> '''abcdef' single quotes get doubled when embedded in single quotes
"abcdef -> '"abcdef' leading double quote is treated normally

Quote type double mirrors quote type single.
MAT2STR and STR2MAT trim outside of quotes but not inside of quotes. Also MAT2STR always adds quotes when quotes are present in the data.
When using MAT2STR on a 2 dimensional array, the first delimiter is used for individual elements and the second delimiter at the end of each row. This principle also applies to three to seven dimensions.
Example
Given the following two dimensional array zzz$ containing the values-
1 2
3 4

The following statements-
10 Sep$(1)=","
20 Sep$(2)=hex$("0D0A") ! CRLF
30 MAT2STR( MAT zzz$, str$, MAT Sep$ )
40 PRINT str$

Will produce-
1,2
3,4

=== CSV Parsing Example===
Parsing CSV data files is now quite easy, the following code snippet demonstrates how to open a CSV/Tab File, read in the fields from the header, and then loop through the records.
01000 dim CSV_LINE$*999,CSV_FILE$*256, CSV_DELIM$*1, CSV_HEADER$*999,
CSV_FIELDS$(1)*40, CSV_DATA$(1)*60
01020 form C," "
01040 let CSV_FILE$="Sample_File.tab" : let TAB$=CHR$(9)
01060 open #(CSV_HANDLE:=10): "name="&CSV_FILE$&", shr", display,input
01080 linput #CSV_HANDLE: CSV_HEADER$
01100 let CSV_DELIM$=TAB$
01120 if POS(CSV_HEADER$,TAB$) <= 0 then
01140 let CSV_DELIM$=","
01160 end if
01180 let STR2MAT(CSV_HEADER$, MAT CSV_FIELDS$, CSV_DELIM$, "QUOTES:TRIM")
01200 print using 1020: MAT CSV_FIELDS$
01220 do
01240 linput #CSV_HANDLE: CSV_LINE$ eof Exit_Csv
01260 let STR2MAT(CSV_LINE$,MAT CSV_DATA$,CSV_DELIM$,"Q:trim")
01280 print using 1020: MAT CSV_DATA$
01300 loop
01320 Exit_Csv: !

You might wish to copy any CSV file to Sample_File.tab and run this program to view the content.

=== XML Parsing Examples===

STR2MAT may also be used to Parse XML data.
This is a bit more complex than parsing CSV files, but remains a powerful tool.
The following example will parse XML$ into "MAT XML_LINE$"

10 DIM XML$*999999,XML_LINE$(1)*32000
20 XML$="<XML><NODE><ITEM>ITEM VALUE</ITEM></NODE></XML>"
100 LET Str2mat(XML$,Mat XML_LINE$,">","TRIM")

This makes the parsing of XML a bit more convenient. The following XML sample shows how the function will parse the data

Input:
<XML><NODE><ITEM>ITEM VALUE</ITEM></NODE></XML>

Output:
<XML
<NODE
<ITEM
ITEM VALUE</ITEM
</NODE
</XML

While the above technique is useful, a more complete and useful technique can be performed if the Node names are known. You may use an array of SEP$ values to parse the data. Take the following example:

100 dim XML$*999999,XML_LINE$(1)*32000,SEP$(4)*32
110 let XML$="<XML><NODE><ITEM>ITEM VALUE</ITEM><ITEM2>ITEM2 VALUE</ITEM2></NODE></XML>"
120 read MAT SEP$
130 data </XML>,</NODE>,</ITEM>,</ITEM2>
140 let STR2MAT(XML$,MAT XML_LINE$,MAT SEP$,"TRIM")
150 print MAT XML_LINE$

This program would return the following results:

<XML><NODE><ITEM>ITEM VALUE
<ITEM2>ITEM2 VALUE

Notice that "Nested Nodes" are listed before the initial data, this may be used to identify the node.

== NEW DLL STRUCTURE OF BUSINESS RULES!==

As of Release 4.3 Business Rules! has been restructured into the following modules:
[[brserver.exe]] – The BR Server module accessed by Client-Server configurations. Brserver.exe also operates as what is now viewed as the Standard Model. If it is invoked by brlistener, then it act as brserver. If it is simply executed, it acts as brcombined. However, when operating as the standard model, it needs to have brclient.dll in the same directory as brserver.
[[brclient.exe]] – The program that the user accesses in Client-Server configurations
[[brclient.dll]] – The client processing program that correlates with the brserver edition.
[[npbrclient.dll]] - The standard (non-IE) browser plugin dll
[[iebrclient.dll]] – Internet Explorer plugin dll

Client installation is done by placing brclient.exe and brclient.dll on the client system and referencing brclient.exe in an icon. Server installation is done by placing brserver.exe and brclient.dll on the server and referencing brserver.exe in the brlistener.conf file. Exe files may be renamed as desired. The name of the released brclient.dll modules will be lengthy and must not be changed because BR relies on the DLL names for version identification.

You will need one of the following possible configurations:
* Workstation Standard Model
* Server executable
* Workstation Client dll
* Linux Terminal Support
* Server executable
* Linux Client dll ( .so )
* Client Server Model
* On Client Machine-
* Client executable
* Workstation Client dll
* On Server
* Server executable
* Workstation Client dll
* BR Listener installed
[ Linux Client dll for Linux terminal access ]

The 32 and 64 bit versions of servers and clients can be intermixed. However dlls must be the in same bit class as the modules that call them. Put your BR bmp files ( drawsunk.bmp, startup.bmp etc. ) in the BR server executable directory.

Updates will pertain to Processor DLLs while the user interfaces will remain as installed. Client DLLs will be automatically uploaded when corresponding server DLLs are accessed in the event they are not already present on the client.

The client can be accessed from within a browser by initiating it with HTML which can specify an embedded window or a separate independent window. In all cases opening a window with PARENT=NONE creates a separate window.

=== BR Adjunctive Files===

The BR executable is now considered to be where the BR server actually resides, irrespective of Drive statements and current working directories.

The following files are located in the BR executable directory by default:
BR server executable
BRconfig.sys
BRserial.dat
BRserver.dat
WBcmd.wbh - BR help files
Server Dlls
Client Dlls for uploading as needed
System Image files – linedraw, etc. - typically BMPs
===) Exceptions===

If [[WBcmd.wbh]] doesn't exist in the BR executable directory then BR looks for it in the initial directory specified by the first drive statement. ( deprecated – will be eliminated at some point) ONQPATH currently defaults to this initial path as well. ( this will remain )

If the BRconfig file is not present in the BR executable directory then BR looks for it in the current working directory at the time of BR invokation.

The SPOOLPATH :OS-fullpath configuration statement specifies where print spool files are temporarily stored during printing. SPOOLPATH defaults to a spool directory that runs off of the BR root of the first drive statement. If no such spool directory exists and SPOOLPATH is not specified then BR creates one.
e.g. DRIVE J:, C:\BR, x, \MYAPP would result in spool files being placed in:
C:\BR\SPOOL\

SPOOLPATH @::client-OS-fullpath specifies where on the client spool files are to be placed.
e.g. SPOOLPATH @::C:\BR\SPOOL -or whatever other full path is desired-

The @: tells BR that this path is on the client. The second colon says the path is independent of drive specifications.

WORKPATH defaults to the BR root of the first drive statement:
e.g. C:\BR\

BRconfig.sys INCLUDE statements are relative to the location of the file containing the INCLUDE statement ( the parent ). CONFIG command INCLUDE statements are relative to the current directory at the time the command is issued.

=== Licensing Restrictions===

As of [[4.20H]], [[brserial]] files must be specific to the first decimal position of the [[release]] of BR that is being used. ( e.g. 4.2x versus 4.3x )

To accommodate more than one brserial level, BR first looks for its own suffix ( 42 or 43 ) before looking for a dat file. From now on it is most useful to name your brserial files either BRSERIAL.42 or BRSERIAL.43, etc.

== CLIENT SERVER RECONNECT Configuration Statement==

CLIENT_SERVER RECONNECT_AFTER=20 RECONNECT_TIME=120

BR sends idle packets between the client and the server every 2 seconds. This statement specifies that after 20 seconds of not receiving such packets BR will attempt to reconnect. This reconnect process can last up to a maximum of 120 seconds, after which BR will issue a “lost connection” error and begin processing in unattended mode.

You can change the above period lengths with the above CONFIG statement.

When BR runs unattended, it normally terminates processing if the program attempts to wait for keyboard input. However, after a lost connection error, if a library program attempts to wait for keyboard input the library function is terminated, the calling statement receives control, and the lost connection error is issued again. This supports error trapping in the calling program so an orderly shutdown can be performed.

== AUTOIT SUPPORT==

[[AutoIt]] is a free keyboard simulation program with very powerful automating capabilities. It can be used to access windows, read data from spreadsheets, write to display files and enter data in screens. There is a separate Window Information utility that comes with Autoit which displays what Autoit sees when windows are active. This has produced ambiguous information in the past.

R99C999 (BR row & col) now appears in the text field of BR labels.

Individual BR input fields may be referenced in Autoit as EditNN where NN is the INPUT FIELDS subscript (CURFLD) of the field.

== ENVIRONMENT INTERROGATION==

ENV$("STATUS [ .sub-keyword ] ... " [, mat config$ [, search-arg] ...] )

ENV$ returns a string or, in the event MAT CONFIG$ is provided, ENV$ redimensions and loads it. For a list of valid keywords issue a STATUS ENV command. If an array is specified, it may be followed by one or more case insensitive substrings which are regarded as restricting search arguments.

e.g. ENV$("SERVER_PLATFORM") returns “WINDOWS”

The following program displays all STATUS information that contains the word “file”:

00100 dim CONFIG$(1)*100
00120 let ENV$("STATUS",MAT CONFIG$,"file")
00140 print MAT CONFIG$

The above program produces the following output:

CHAINDFLT - Look for object files with source first.
EDITOR C:\PROGRAM FILES\MILLS ENTERPRISE\MYEDITBR\MYEDITBR.EXE
FILENAMES LOWER_CASE
OPTION 23 is OFF - prevent data conversion errors from moving file position
OPTION 25 is ON - make FILE$(0) be CON: if in windows
OPTION 26 is OFF - suppress creation of .BAK files
OPTION 29 is ON - save programs as .WB files
OPTION 33 is 64 - locking position for large file support
OPTION 49 is OFF - use relative path for spool file
OPTION 51 is OFF - recover deleted records for all files
SPOOLCMD prt.bat [SPOOLFILE] [COPIES] [PRINTER]
Server File: :c:\wbserver.dat
BR Config File: :C:\ADS\SYS\br.d\brconfig.sys
Executable File: :C:\ADS\SYS\br.d\
brserver-430beta+q-Win32-DebugEfence-2011-03-20.exe
Serial File: :C:\ADS\SYS\br.d\brserial.dat
Workfile path: :c:\ads
Open File # 0 :CON:

If I just want the options with the word file then I would use:

00100 dim CONFIG$(1)*100
00120 let ENV$("STATUS.CONFIG.OPTION",MAT CONFIG$,"file")
00140 print MAT CONFIG$

Which produces:
OPTION 23 is OFF - prevent data conversion errors from moving file position
OPTION 25 is ON - make FILE$(0) be CON: if in windows
OPTION 26 is OFF - suppress creation of .BAK files
OPTION 29 is ON - save programs as .WB files
OPTION 33 is 64 - locking position for large file support
OPTION 49 is OFF - use relative path for spool file
OPTION 51 is OFF - recover deleted records for all files

Note that while keywords are case insensitive, they must be correctly specified, whereas search arguments are more “friendly”. For a complete list of valid keywords, issue the command:

STATUS ENV -p

Some of the new keywords supported are:
*ENV$("CLIENT_PLATFORM") is "WINDOWS"
*ENV$("CLIENT_PLATFORM.BR_BUILD_TYPE") is "DebugEfence"
*ENV$("CLIENT_PLATFORM.BR_BUILD_DATE") is "2011-05-12"
*ENV$("CLIENT_PLATFORM.BR_BITS") is "32"
*ENV$("CLIENT_PLATFORM.OS_BITS") is "64"
*ENV$("CLIENT_PLATFORM.OS_VERSION_NAME") is "Windows 7"
*ENV$("CLIENT_PLATFORM.OS_VERSION_NUMBER") is "6.1"
*ENV$("SERVER_PLATFORM") is "LINUX"
*ENV$("SERVER_PLATFORM.BR_BUILD_TYPE") is "DebugEfence"
*ENV$("SERVER_PLATFORM.BR_BUILD_DATE") is "2011-05-13"
*ENV$("SERVER_PLATFORM.BR_BITS") is "64"
*ENV$("SERVER_PLATFORM.OS_BITS") is ""
*ENV$("SERVER_PLATFORM.OS_VERSION_NAME") is "#36-Ubuntu SMP Thu Jun 3 20:38:33 UTC 2010"
*ENV$("SERVER_PLATFORM.OS_VERSION_NUMBER") is "2.6.32-22-server"
*BR_MODEL “CLIENT/SERVER” or “COMBINED”

== NEW WORLD SQL SUPPORT==

CONFIG DATABASE db-ref DSN=dsn-ref [, USER= department | LOGIN_NAME | ? ]
[, {PASSWORD= dept-password | BR_PASSWORD | ?} | PASSWORDD=encrypted-passwd ]
? indicates prompt
BR_PASSWORD indicates the password used during client login. If running the standard model ( not client-server ) then this is equivalent to “?”.
encrypted-passwd is the DB password encrypted with the key stated in OPTION 66.
- or -
CONFIG DATABASE db-ref CONNECTSTRING="Driver={Microsoft Access Driver (*.mdb)}
e.g. DBQ=C:\inetpub\wwwroot\BegASP\Chapter.14\Contact.mdb"
- or -
CONFIG DATABASE ODBC-MANAGER
This will invoke the ODBC Manager to define or identify a file DSN.

OPEN #20: "DATABASE= db-ref" , SQL "sql-statement", OUTIN
- or -
OPEN #20: "DATABASE= db-ref, Name= filename" , SQL, OUTIN
- filename refers to a DISPLAY file containing an SQL statement
that gets executed when a WRITE statement is processed -

===Sequence of Operations===

1. Begin processing with a WRITE statement.
2. If the WRITE contains an IO list of values then it is used to populate the 'filename' SQL before it is executed. In this process IO list values replace question marks in the original SQL, positionally left to right. These question marks only work with SQL arguments that refer to stored data. Question marks cannot be specified where SQL keywords or table column names appear.
3. This may or may not produce a result set. If it does, the result set may be processed like a BR file opened RELATIVE. Some operations that use file positioning may be slow since the whole result set may not be in memory immediately. Simple sequential access should be fairly quick.
4. Once SQL has been populated by an IOlist, it may be reused with the same values by issuing a WRITE with no IOlist.
5. READ IOlist variable associations are positional with each READ accessing one row of values.

=== SQL Date Format Functions===

A$ = SQL_DATE$(BR-date-string,"format-mask") ! format date for storage
B$ = BR_DATE$( SQL-date-string,"format-mask") ! unpack DB date value

=== SQL Table Interrogation===

“ENV$ (STATUS)” has been extended to interrogate database connections and ODBC data sources. A program called ENVDB.BRS has been written to demonstrate how this extension works and to show how to setup linkage to a database or ODBC data source. Run the program as is to bring up the Microsoft ODBC manager. Then select a data source and look at the output from the program. This will also show you how to get and use connect strings. In this example lines 1900 and 2000 accomplish the same open as line 1800 in my environment.

Try it on your Windows workstation. As long as you have one or more ODBC drivers supported you can use it without having to install a database. You can even use it to interrogate Excel files because Microsoft provides an ODBC driver for that.

A sample program to demonstrate database interrogation entry is:

01000 ! Replace Envdb
01020 dim DATABASES$(1)*100
01040 dim DATABASE$*100
01060 dim TABLES$(1)*100
01080 dim TABLE$*100
01100 dim COLUMNS$(1)*100
01120 dim COLUMN$*100
01140 dim C$*100,FLD1$*40,FLD2$*40,FLD3$*40,FLD4$*40
01160 execute "CONFIG database testdb odbc-manager"
01180 ! Execute "CONFIG database testdb DSN='Accounts Payable'"
01220 ! Execute "CONFIG database testdb connectstring=""DSN=Excel Files;DBQ=L:\orders\Beneficial - A-PORCEL.xls;DefaultDir=L:\orders;DriverId=1046;MaxBufferSize=2048"""
01230 ! ***** Open Output File
01240 open #1: "name=envdb.txt,replace",display,output
01420 Dump_Table: ! ***** Dump Table Layout
01440 let OUTFD = 1
01460 let ENV$("status.database.LIST", MAT DATABASES$) !List of db's
01480 for DATABASE=1 to UDIM(DATABASES$) !For each connected database
01500 let DATABASE$=DATABASES$(DATABASE)
01520 let FNSHOW_DATABASE(DATABASE$, "status.database."&DATABASE$)
01540 next DATABASE
01560 end
01580 !
01600 def FNSHOW_DATABASE(DATABASE$*100, ST_PREFIX$*100)
01620 print #OUTFD: DATABASE$
01640 let OUT_PREFIX$=CHR$(9)
01660 print #OUTFD: OUT_PREFIX$&"DSN="&ENV$(ST_PREFIX$&".DSN")
01680 print #OUTFD: OUT_PREFIX$&"CONNECTSTRING="&ENV$(ST_PREFIX$&".CONNECTSTRING")
01700 print #OUTFD: OUT_PREFIX$&"Tables:"
01720 let ST_PREFIX$=ST_PREFIX$&".TABLES"
01740 let ENV$(ST_PREFIX$&".LIST", MAT TABLES$)
01760 for TABLE = 1 to UDIM(MAT TABLES$)
01780 let TABLE$=TABLES$(TABLE)
01800 let FNSHOW_TABLE(TABLE$, ST_PREFIX$&"."&TABLE$,OUT_PREFIX$&CHR$(9))
01820 next TABLE
01840 fnend
01860 !
01880 def FNSHOW_TABLE(TABLE$*100, ST_PREFIX$*100, OUT_PREFIX$)
01900 print #OUTFD: OUT_PREFIX$&TABLE$
01920 let OUT_PREFIX$=OUT_PREFIX$&CHR$(9)
01940 print #OUTFD: OUT_PREFIX$&"Table remarks="&ENV$(ST_PREFIX$&".REMARKS")
01960 print #OUTFD: OUT_PREFIX$&"Table type="&ENV$(ST_PREFIX$&".TYPE")
01980 print #OUTFD: OUT_PREFIX$&"Columns:"
02000 let ST_PREFIX$=ST_PREFIX$&".COLUMNS"
02020 let ENV$(ST_PREFIX$&".LIST", MAT COLUMNS$)
02040 for COLUMN = 1 to UDIM(MAT COLUMNS$)
02060 let COLUMN$=COLUMNS$(COLUMN)
02080 let FNSHOW_COLUMN(COLUMN$, ST_PREFIX$&"."&COLUMN$,OUT_PREFIX$&CHR$(9))
02100 next COLUMN
02120 fnend
02140 !
02160 def FNSHOW_COLUMN(COLUMN$*100, ST_PREFIX$*100, OUT_PREFIX$)
02180 print #OUTFD: OUT_PREFIX$&COLUMN$
02200 let OUT_PREFIX$=OUT_PREFIX$&CHR$(9)
02220 print #OUTFD: OUT_PREFIX$&"Column type="&ENV$(ST_PREFIX$&".TYPE")
02240 print #OUTFD: OUT_PREFIX$&"Column length="&ENV$(ST_PREFIX$&".LENGTH")
02260 print #OUTFD: OUT_PREFIX$&"Column decimals="&ENV$(ST_PREFIX$&".DECIMALS")
02280 fnend

== BR DATA ENCRYPTION==

Encryption encompasses a number of different operations. These operations can be used independently or in combination to meet different needs. We use industry standard encryption available through OpenSSL. Three technologies are widely used for encrypting data. BR supports the first two listed below through its ENCRYPT and DECRYPT functions.

===Overview===

1. Symmetric key ciphers – where the same key is used to encrypt and decrypt data. You can specify a key to encrypt some data and later use the same key to decrypt the data.

2. Hashing routines – one way routines that take data and convert it to a hash value. Sometimes these are thought of as checksums such as MD5 sum. Hash values are always the same length regardless of how big the hashed data is. A 10 gb file will have a hash result that is the same length as a 200 byte file. Hashing routines have a number of specific uses.

1. Verify that data has not changed.

2. Verifying that two files are the same.

3. Validating passwords – this is based on the concept that if two values have the same hash value the values are equal. Using this technique improves security because it allows a server to store passwords in an unrecoverable format. Even the server software is unable to regenerate the original password. It is only capable of checking if the hash of a password matches the stored password hash.

===Symmetric Key Ciphers===

There are two encryption functions in the BR language, ENCRYPT$ and DECRYPT$.

ENCRYPT$(Data$ [,Key$ [,Encryption-type$, [,Initialization-vector$]]])
DECRYPT$(Data$ [,Key$ [,Encryption-type$, [,Initialization-vector$]]])

Data$ - The data to be encrypted

Key$ - The secret key to be used for encryption. If not specified this value will come from an OPTION 66 statement.

Encryption-type$ - The type of encryption to be done. If not specified, a common high strength encryption type will be employed. This is described in more detail below, but is generally only useful for interfacing with other typically non-BR programs.

Initialization-vector$ - This is an arcane part of encryption standards. It exists to prevent attackers from being able to tell whether the unencrypted data has changed. This is described in more detail below, but is general only needed when interfacing with other non-BR programs.

=== Interfacing With Other Programs (encryption type and initialization vector)===

There are a number of different types of encryption that BR supports through OpenSSL: AES, BLOWFISH, DES, triple DES, RC4 and RC2. Most symmetric key ciphers are block ciphers meaning that they encrypt one block at a time. This means if you have a bit message, it is broken up into multiple blocks and each block is encrypted. The block size can be set as (128, 192, 256) bits. Some encryption types don't support all of these values so STATUS ENCRYPTION should be checked to see what encryption types are available in BR. Besides block size, there are also various schemes for blocking data. One might expect that using 256 bit blocking would simply take every 32 bytes and call it a block. This is not done though because there is a possibility that this would cause patterns in the encrypted data. To prevent this, there are various schemes known as codebooks which change the way data is blocked. Wikipedia explains this in more detail. If the encryption type is not specified AES:256:CBC:128 will be used. To be compatible with other programs the entire encryption type must be specified (cipher: key length: codebook: invitialization vector length).

Initialization-vector – this is used to cause the same data encrypted with the same key to have a different encrypted result. This is significant because otherwise an attacker looking at data seeing the same encrypted result twice would know that the key and the unencrypted data have not changed. Regardless of whether or not you are concerned about this potential security issue, the standard encryption methods require this value so interfacing with other programs may require you to use it. It is a common practice to use a random number for this value and store the value at the beginning of (ahead of) the encrypted result. This is what BR does if this parameter is omitted.

As an example:
ENCRYPT$(“test”, “key”)
Produces a string containing “random number initialization vector”&”encrypted result”.

If the initialization vector is explicitly specified as in:
ENCRYPT$(“test”, “key”, “AES:256:CBC:128”, “RANDOM”)
the result would be simply “encrypted result”.

DECRYPT$ has the same arguments as ENCRYPT$ with the exception of the first parameter which is the encrypted data. DECRYPT$ expects to be used with the same key$, encryption-type$, and initialization-vector$ as was used to encrypt the data. As with ENCRYPT$, if key$ is not specified, the value from the OPTION statement will be used. If encryption-type$ is not specified, “AES:256:CBC:128” will be used. If the initialization vector is not specified, it will be assumed that the encrypted data starts with an initialization vector.

=== Hashing Routines===

Three common forms of hashing are allowed in BR. They are MD5, SHA, and SHA-1. These are also provided through the ENCRYPT$ function specifying a null key$ value:

ENCRYPT$(data$, “”, “MD5”)
ENCRYPT$(data$, “”, “SHA”)
ENCRYPT$(data$, “”, “SHA-1”)

Hashing is also referred to as Message Digests or digests. This is what the MD in MD5 means. There is no way to restore data that has been hashed. Hashing is a one way function so DECRYPT$ will yield an error.

=== Asymmetric Encryption===

Asymmetric key encryption is also known as public/private key encryption.

Public/private keys are created as a pair by a key generator. They are a pair, and it is not possible to have two public keys for the same private key or vice versa. With regard to public/private key pairs, what one key encrypts the other key can decrypt, and neither key can decrypt what it has encrypted. When a private key is used to encrypt data, the result is called a signature because everyone who has the public key can decrypt it.

This technique is used for:

Signing (using certificates) – A private key can be used to sign data. The result of such signing can be tested/validated with the corresponding public key.

Data encryption – A public key can be used to encrypt data. This data can then only be decrypted by the corresponding private key.

Hashes and signing are different but used together. Rather than signing a large block of data which would create a large signature, only the hash is signed to create much smaller fixed length signature data. When verifying a large block of signed data, the data is used to create a hash value and the hash value is compared to a decrypted signature.

Asymmetric encryption is not accessible through the BR ENCRYPT$, DECRYPT$ functions. However, it is used by our SSL client server connections and HTTPS. Certificates are most commonly used by SSL and HTTPS and are less useful for other application processes. In the Client Server model the client knows the server’s public key and the server uses its private key to encrypt and decrypt.

Encryption is invoked by Business Rules HTTP support as follows:

CONFIG HTTPS PORT port-number [ LOG file-pathname ]
CONFIG OPTION 66 private-key-file-encryption-password
OPEN #400: “HTTP=SERVER”, DISPLAY, OUTIN

The BRSERVER executable directory must contain two files:
* https-private.pem
* https-cert.pem

These files are made by the following commands under Linux, MAC and cygwin for Windows:
openssl req -new -x509 -out httpserver.pem -days 10000

( this will prompt for the OPTION 66 password )

mv privkey.pem https-private.pem
mv httpserver.pem https-cert.pem

This port specific service can then be accessed with browsers. When the specified port is accessed through a browser, BR establishes an HTTPS connection rather than an HTTP connection.

=== Signing and Certificate Processing Industry Standards===

Certain companies are authorized by the government to act as a Certificate Authority ( CA ). These companies ( e.g. Verisign ) issue electronic certificates which can be used to issue second level certificates. Certificates can have expiration dates and the line of authority extends from a CA to any number of levels (but a chain is only as strong as its weakest link). Certificates contain a list of signatures (described below) that trace back to a CA as follows:

When a company needs to obtain a certificate from a CA, it prepares its own certificate and sends it to the CA for signature. The CA provides the signature and the CA’s own public key for validating it. The text in such certificates will identify the signing authority ( CA ) and the recipient of the certificate. It also contains the public key of both the signer and the recipient.

Browsers know the CA identities and their public keys. A browser can verify a CA issued cert by hashing it, decrypting the signature with the known public key and matching the decrypted signature against the hash total.

Any company that is issued a certificate by a CA can sign second level certificates issued to third parties. A second level cert contains the parent (CA issued) certificate, and includes the public keys of the issuer and the recipient. The signature is essentially the encrypted hash total of ‘itself plus all of its ancestors’. Additional levels each contain the chain of certificates leading from a CA issued cert to itself.

Ostensibly, a certificate cannot be counterfeited because it requires the signature of its parent which can only be produced with its parent’s private key. By providing both public keys ( signer and recipient ) in all certs along with signatures, a non-forgeable or alterable chain is established.

Example:
CA public key – known to browser
certificate 1 (signed by CA)
certificate 2 (signed by second level - includes certificate 1)
final certificate (signed by third level - includes certificate 2)

A browser would find the CA information in the certificate and check to see if it is in the browser’s internal list. If not it fails. Then it verifies that certificate 1 (which ends up being part of the final certificate) has been signed by the CA. After that it checks certificate 2 and verifies that it has been signed with certificate 1. Finally it checks the final certificate and verifies that it has been signed with certificate 2.

To assure the line authority of any certificate, the public keys are associated with signers, not with documents.

== ODBC VERSION 4.3==

Improved installation routines:
Easy to use
Compatible with Windows Vista/7
Compatible with 64 Bit Machines (both 32 and 64 bit drivers).
Easily create DNS entries from the CONTEXT using a BR program called CREATE_INI.BR. (You will need to tailor the resulting INI file to the target setting.)
Installation on a client can be done from a command line avoiding the need for human interaction at the client.

Support for 64 bit Record Locking (No 2GB Limit!).
Implemented Dynamic (on the fly) Indexes.
The ODBC splash screen has been removed.

ODBC Logging:
*Set Logging to level 6 or greater.
*LOGGING 6, C:\ODBC-LOG.TXT
*Log file will provide helpful information to analyze queries.
*Actual SQL processed by Driver (As opposed to the SQL typed in MS-Access or MS-Excel)
*Indexes used by the Query. (To help determine the "BEST Query" for performance).

More Robust:
*Improved Date Handling (Sort/Filter, etc).
*Improved Joins leverage &/or create indexes for performance.
*Improved Group By queries
*Improved "Like" filters.
*Improved Multiple Filters in a single query

=== ODBC Licensing And Security===

Licenses will be issued based on number of workstations or number of BR WSIDs.

The price per user for licensing based on the number of BR WSIDs is one half of the price based on the number of ODBC workstations.

The maximum license fee for ODBC is $4900.

====Enforcement====
If the ODBC license is based on the number of BR users, then the BRSERIAL.DAT file always specifies 999 users.

We assign a random number to each machine that uses the ODBC driver and another random number to each user of ODBC. These numbers are stored along with the date, encrypted in a table in the server and client registries. Each time a session is started, the client is checked for pre-existing control numbers and if they exist then the numbers are used for the session (along with the current date). If a client reports a pre-existing number less than 14 days old that is not in the server table, then an alarm is signaled. This indicates tampering with the server table.

When a control number pair is about to be added to the server table and the table is full then it is searched for an entry more than 14 days old for replacement. If no such entry exists, then a “maximum users exceeded” error message is presented.

When a computer is replaced, this can leave an unusable entry in the server table for up to 14 days. If this occurs, then the user can run a program on the server that writes an encrypted header with the current date to the server table indicating that the table has been cleared in a licensed manner. After this has been run, all entries in the table will be available for reuse. Clients that have pre-existing control numbers will not generate the tamper error when the license file is cleared in this manner unless the client last used date is greater than the encrypted header date. This program requires a password which is an encrypted form of the current date plus the serial number. Only the dealer has the password producing program so only the dealer can obtain the current day’s password.

When a client machine has more than two ODBC user entries, the entries greater than
one are counted as separate workstations. e.g. 1 or 2 ->1, 3->2, 4->3, etc.

=== New Procedure for Utilizing MS Access ODBC Middleware ===

A procedure has been established for greatly expanding the SQL capabilities of the BR ODBC driver by routing ODBC requests through MS Access. Using this technique one can create reusable queries that combine several tables. This procedure is described in the installation guide.

== PRINT FONT STRETCHING==

When we developed the PDF printing facility we encountered a problem getting PDF to print exactly like NWP and PCL. This was partly because early in NWP development we stretched the fixed width fonts vertically for maximum legibility. So in version 4.2 we adopted a default font that was more like PCL that we could print in both NWP and PDF.

However, we eventually returned to the older stretched fonts because of their superior legibility. This issue affects only fixed width fonts. This stretching can be disabled with OPTION 68.

We are now using Courier New as the default font. pdflib4-Win32.dll adds support for this stretching to our PDF capabilities.

Relative Font Heights ( height to width ratios ):
Native Courier New 1.6 - available in PCL -
Native Letter Gothic 2.0 - available in PCL -
Stretched Fonts 2.6 - NWP and PDF only -

The 1.6, 2.0, 2.6 are ratios. For Courier New the 1.6 means that the font is 1.6 times as high as it is wide. PCL measures all fixed width fonts in width and calculates the height based on these ratios. So for Courier New a 10 CPI font would be 1.6 * (1 / 10)(CPI) * 72 (points per inch) = 11.52 points. Actually the ratio for Courier New appears to be 1.66666666. This would mean that 1.66666666 * (1/10) * 72 = 12 points.

== EXTENDED DATE / TIME FUNCTIONS==

Date numeric variables can now represent time of day in the fractional space (to the right of the decimal point). The DAYS and DATE masks have been extended as follows:

H#.## or H denotes hours [ with fractions ].
M#.### or M#.# denotes minutes.
S#.####, S or S# denotes seconds.

M, to the right of H always denotes minutes, so H:M:S is sufficient.
Either AM or PM, to the right of H denotes AM / PM output.
The absence of AM and PM denote military hours (0 – 23).
The maximum significant digits that can be represented in a numeric variable are 15. So if century, year, month and day are stored as a 5 digit day of century, then internally up to ten digits to the right of the decimal are available for time of day.

Extended Date Mask Examples:
DATE( “Month dd, ccyy at H#.## hours”) -> September 12, 2011 at 14.58 hours
DATE( “mm/dd/yy at H:M AM”) -> 09/15/11 at 2:35 PM
DATE( “mon dd cy at H#:M# PM”) -> Sep 15 2011 at 02:35 PM

Example of using DATE$ to get time to 9 decimal places:
Date$("H#:M#:S#.#########") -> 14:06:22.968419347

When storing date/time combinations on disk, you should allow for all of the significant digits that your date mask supports on each side of the decimal point. A “BH 4” form supports nine significant digits, which is suitable for day of century plus a four digit fraction. To exceed that you can use either PD 6, PD 7, PD 8 or D 8 (double floating point) to store these values on disk. DATE() only works with day-of-century values along with an optional time fraction.

== NEW DATE MASK INPUT PROCESSING==

DATE(mask) can now be used as an INPUT FIELDS specification.

10 INPUT FIELDS “row, col, DATE(mask) ,UH” : date-var

Special keyboard processing:
Punctuation (commas, colons, slashes, semicolons, and dashes) is skipped during entry similar to PIC.
Insert and delete are supported within subfields that are delineated by punctuation.
Copy includes punctuation.
Cut is Copy with redisplay of zero date.
Paste causes BR to translate the date to DAYS format and then display the date. Excel and OpenOffice Calc application formats are supported.
If a string is pasted, it is first converted to DAYS using the provided mask.
If a zero DAYS value is displayed then Month, M3, Day and D3 mask positions contain dashes.

A date picker has been added.

A new configuration statement is provided to control the when the date picker appears:

DATE [ALWAYS] [INVALID] [NEVER]

Additionally, the leading attribute ^DATE_PICKER is available.

INVALID ( the default mode ) presents the date picker whenever the days value of the expressed date is zero.

ALWAYS and ^DATE_PICKER show the picker whenever the cursor is in the field until a date is selected from the picker. Leaving the field and reentering it actives the picker again.

When in the date picker the following keys are active:
Shift- PgUp/PgDn – Go to the previous/next month
Ctrl- PgUp/PgDn – Go to the previous/next year

A sample program to demonstrate date entry is:
01000 ! Rep Date_Input
01020 ! Demonstrate The New Date() Input Format
01040 ! Skip Punctuation (Commas, Colons, Slashes, Semicolons, And Dashes)
01060 ! Insert And Delete Within Subfields That Are Delineated By Punctuation
01080 ! Continue To Support Cut And Paste Including Punctuation
01100 !
01120 rinput fields "5,10,DATE(mm/dd/yy) ;6,10,c": DATE_VAR
01140 print fields "8,10,date(Month DD, CCYY)": DATE_VAR
01160 !
01180 rinput fields "12,10,date(month dd, ccyy)": DATE_VAR
01200 if NOT DATE_VAR then goto 1180
01220 print fields "15,10,date(yy/mm/dd)": DATE_VAR
01240 print fields "18,10,N 6": DATE_VAR !Show days format

== NEW TEXT FIELD FORMAT==

10 (R)INPUT FIELDS “row, col, TEXT rows/cols[/capacity], leading-attr, …”:

This format is similar to the C/V/G format with the ^ENTER_LF attribute except:
No trailing space padding or trimming occurs.
Rows and columns are specified.
Field capacity or newlines can cause a vertical scrollbar to appear.

Supported leading attributes are ^ENTER_LF (the default), ^ENTER_CRLF and ^NOWRAP.
The TEXT keyword will imply ^ENTER_LF unless ^ENTER_CRLF is specified.

^ENTER_LF (the default) causes the ENTER key to add LF characters to the data and to go to a new line left justified. The cursor will retrace the data when backspace or left-arrow is keyed, meaning the on-screen LF characters are represented by moving the cursor, instead of allowing it to rest on invisible LF characters.

^ENTER_CRLF may be specified in lieu of ^ENTER_LF. When that is the case, carriage returns entered are represented in the data as carriage-return-linefeed (CRLF) character pairs. ^NOWRAP may be specified to suppress word wrapping. When ^NOWRAP is active, data is entered on the current line until ENTER is keyed to go to the next line. Both horizontal and vertical scroll bars appear as needed.

Tabs are entered into the text. Shift-tab is ignored.

Home, End and the arrow keys all operate relative to the current line as opposed to operating on the text box as a whole.

Depressing the Control key causes the following keys to operate in the normal string entry mode:

*Enter – Returns control to the BR program
*Tab – Goes to the next control
*Shift-Tab – Goes to the prior control
*Home – Goes to the beginning of data or the first field
*End – Goes to the end of data or the last field
*Left-Arrow/Up-Arrow – Goes to the prior control
*Right-Arrow/Down-Arrow – Goes to the next control

* [[CurPos]] introduced.

A sample program to demonstrate TEXT entry is:
01000 ! Rep Text
01020 ! Test New Text Fiueld Type
01040 dim TEXT$*300, TEXT$(1)*80
01060 print NEWPAGE
01080 rinput fields "3,10,text 4/40/300,uh": TEXT$
01100 print fields "10,10,c": TEXT$
01120 print TEXT$
01140 let STR2MAT(TEXT$, MAT TEXT$, CHR$(10))
1160 rint MAT TEXT$

== INPUT ACROSS MULTIPLE WINDOWS==

10 (R)INPUT FIELDS #121: “10, 10, C 20, UH; 10, 12, PIC(##/##/##), UH;#124,
10, 10, C 30, UH”: aaa$, bbb$, ccc$

This will input the first two fields on window #121 and the third field on window #124. The ‘#window-number,’ prefix may appear in any row, col FIELDS specification and it overrides the window number that follows the PRINT/INPUT/RINPUT keyword.

== CONFIG CONSOLE CHANGES==

[[Console]] [[BRConfig.sys]] specification introduced.

== BR IN A BROWSER==

We have made it easy to setup BR in a Browser once you have Client Server working.
Point your browser at ads.net/plugin for a demonstration. Located in that directory is a file called index.html which is also on the FTP site in the BETA release browser-plugin directory. Modify this file to setup your own web page.

This HTML file demonstrates activation of BR client server in a browser. It first checks to see if the plugin is installed and if not it installs it. If needed, it updates the plugin from the ads.net site. It then initiates a connection to the server just like the BR client does. See the HTML file for further instructions, including how to confine BR to a window on the launch page if desired.

A new OPTION 70 is provided which will default to being ON in the Browser version. OPTION 70 will do the same thing as 54 (exit if BR enters command console mode), but it will be configurable to:
OPTION 70 OFF ! This can be set programmatically
OPTION 70 ON ! Same as OPTION 54 – the default for browsers
OPTION 70 RELAXED ! Mild security – enables some support

RELAXED mode is intended to allow some debugging but still provide some security. This means disabling commands such as COPY, DIR, etc., CONFIG commands, and preventing changes from being made to BR programs. However, the security can be defeated because all of these activities can be performed by programs or procedures. Use ON (the default) for high security.

== NEW AND CHANGED ERROR CODES==
* [[0000]] Successful completion no error
* [[0050]] Writing to BTREE2 file failed
* [[0059]] DEPRECATED ERROR: attempt to rewrite over key
* [[0063]] DEPRECATED ERROR: network locking error
* [[0417]] MSG string it too long
* [[0419]] Invalid MSG special char specification
* [[0436]] Bad flags for MAT2STR or STR2MAT
* [[0620]] DEPRECATED ERROR: duplicate OPEN for standard printer output
* [[0641]] DEPRECATED ERROR: missing protection device
* [[0635]] Error using SSL socket
* [[0717]] Error deleting record from BTREE2 file
* [[0727]] DEPRECATED ERROR: FORM variable not referenced
* [[0807]] Border characters can no longer be specified
* [[0814]] Bad or missing trailing attribute
* [[0818]] DEPRECATED ERROR: number too large for PIC format
* [[0865]] DEPRECATED ERROR: invalid attribute combination
* [[0887]] Sort column is not valid
* [[0930]] INPUT FIELDS "...RANGE" bad range variables
* [[0931]] Invalid insert or delete change with range
* [[0940]] Value does not match boolean format
* [[0941]] NULL boolean value used where allow null is false
* [[0945]] The length of the date format is excessively long
* [[1008]] Invalid keyword in shell interpreter
* [[1033]] Scalar variable in an array group
* [[2022]] The given encryption method does not exist
* [[2024]] The encryption method is only valid one way
* [[2026]] Missing encryption key
* [[2030]] Failed processing encryption
* [[2070]] DEPRECATED ERROR: not enough memory
* [[2080]] DEPRECATED ERROR: insufficient dimensioned storage
* [[2090]] DEPRECATED ERROR: not enough compilation storage
* [[2100]] Too many active procedures
* [[2101]] Illegal line number
* [[2102]] GO attempted without running program
* [[2103]] Illegal PROC parameter
* [[2104]] No active lines to run
* [[2108]] Program is active
* [[2109]] No program in memory to SAVE or REPLACE
* [[2111]] Missing lines for a program in object code
* [[2116]] Cannot SAVE during LOAD or MERGE
* [[2120]] DEPRECATED ERROR: not enough compilation storage
* [[2130]] Program changed since LOAD at another workstation
* [[3031]] DEPRECATED ERROR: 0 bytes available on disk

* [[4002]] SQL create statement failed
* [[4003]] SQL free statement failed
* [[4004]] SQL prepare failed
* [[4005]] SQL clear old results failed
* [[4006]] SQL execute direct failed
* [[4007]] WRITE to SQL with incorrect number of data elements
* [[4008]] SQL describe result set columns failed
* [[4009]] SQL bind result set columns failed
* [[4010]] SQL fetch row failed
* [[4011]] SQL bind parameter failure
* [[4012]] Prepared SQL execution failure
* [[4014]] Error converting time stamp to string value or back

* [[4114]] DEPRECATED ERROR: invalid disk or disk drive reference
* [[4115]] The specified database has not been opened
* [[4120]] Invalid Y2K data found in an index field
* [[4121]] DEPRECATED ERROR: invalid use of key file
* [[4123]] Corrupted BTREE index
* [[4128]] DEPRECATED ERROR: invalid file name
* [[4135]] DEPRECATED ERROR: volume ID invalid
* [[4137]] DEPRECATED ERROR: not enough storage space to create file
* [[4138]] Can't rename between client and server
* [[4140]] DEPRECATED ERROR: shared memory problem
* [[4141]] DEPRECATED ERROR: shared memory problem
* [[4142]] DEPRECATED ERROR: too many opened file names
* [[4143]] DEPRECATED ERROR: out of shared memory
* [[4144]] DEPRECATED ERROR: network semaphore error
* [[4145]] Time out while waiting for input from user or ASYNC file I/O
* [[4147]] A file has been opened too many times at the share level
* [[4149]] Different version of BR running with locking
* [[4159]] DEPRECATED ERROR: volume not on line
* [[4160]] Out of internal file handles
* [[4174]] Attempted file reservation on non-local file
* [[4175]] Multiple wbserver files detected
* [[4177]] DEPRECATED ERROR: windows shell call without command
* [[4179]] Failed to lock in progress on wbserver.dat
* [[4180]] Bad drive statement
* [[4185]] Setting the directory failed on the client side
* [[4194]] REWRITE check for null bytes failed
* [[4195]] READ check for null bytes failed
* [[4196]] WRITE check for null bytes failed

* [[4200]] DEPRECATED ERROR: DOS/Windows/Novell error 0
* [[4201]] DEPRECATED ERROR: DOS/Windows/Novell error 1
* [[4202]] DEPRECATED ERROR: DOS/Windows/Novell error 2
* [[4203]] Path does not exist or is not a directory
* [[4204]] Too many file handles open on the system level
* [[4205]] Access is denied
* [[4206]] Invalid file descriptor
* [[4207]] DEPRECATED ERROR: DOS/Windows/Novell error 7
* [[4208]] DEPRECATED ERROR: DOS/Windows/Novell error 8
* [[4209]] DEPRECATED ERROR: DOS/Windows/Novell error 9
* [[4210]] DEPRECATED ERROR: DOS/Windows/Novell error 10
* [[4211]] DEPRECATED ERROR: DOS/Windows/Novell error 11
* [[4212]] DEPRECATED ERROR: DOS/Windows/Novell error 12
* [[4213]] DEPRECATED ERROR: DOS/Windows/Novell error 13
* [[4214]] DEPRECATED ERROR: DOS/Windows/Novell error 14
* [[4215]] Invalid drive reference
* [[4216]] Cannot remove directory
* [[4217]] DEPRECATED ERROR: DOS/Windows/Novell error 17
* [[4218]] DEPRECATED ERROR: DOS/Windows/Novell error 18
* [[4219]] I/O error on write protected floppy
* [[4220]] DEPRECATED ERROR: DOS/Windows/Novell error 20
* [[4221]] DEPRECATED ERROR: DOS/Windows/Novell error 21
* [[4222]] DEPRECATED ERROR: DOS/Windows/Novell error 22
* [[4223]] DEPRECATED ERROR: DOS/Windows/Novell error 23
* [[4224]] File is too large for locking mode
* [[4225]] DEPRECATED ERROR: DOS/Windows/Novell error 25
* [[4226]] DEPRECATED ERROR: DOS/Windows/Novell error 26
* [[4227]] DEPRECATED ERROR: DOS/Windows/Novell error 27
* [[4228]] DEPRECATED ERROR: DOS/Windows/Novell error 28
* [[4229]] DEPRECATED ERROR: DOS/Windows/Novell error 29
* [[4230]] DEPRECATED ERROR: DOS/Windows/Novell error 30
* [[4231]] DEPRECATED ERROR: DOS/Windows/Novell error 31
* [[4232]] DEPRECATED ERROR: DOS/Windows/Novell error 32
* [[4233]] DEPRECATED ERROR: DOS/Windows/Novell error 33
* [[4234]] DEPRECATED ERROR: DOS/Windows/Novell error 34
* [[4235]] DEPRECATED ERROR: DOS/Windows/Novell error 35
* [[4236]] DEPRECATED ERROR: DOS/Windows/Novell error 36
* [[4237]] DEPRECATED ERROR: DOS/Windows/Novell error 37
* [[4238]] DEPRECATED ERROR: DOS/Windows/Novell error 38
* [[4239]] Disk is full
* [[4240]] DEPRECATED ERROR: DOS/Windows/Novell error 40
* [[4241]] DEPRECATED ERROR: DOS/Windows/Novell error 41
* [[4242]] DEPRECATED ERROR: DOS/Windows/Novell error 42
* [[4243]] DEPRECATED ERROR: DOS/Windows/Novell error 43
* [[4244]] DEPRECATED ERROR: DOS/Windows/Novell error 44
* [[4245]] DEPRECATED ERROR: DOS/Windows/Novell error 45
* [[4246]] DEPRECATED ERROR: DOS/Windows/Novell error 46
* [[4247]] DEPRECATED ERROR: DOS/Windows/Novell error 47
* [[4248]] DEPRECATED ERROR: DOS/Windows/Novell error 48
* [[4249]] DEPRECATED ERROR: DOS/Windows/Novell error 49
* [[4250]] DEPRECATED ERROR: DOS/Windows/Novell error 50
* [[4251]] DEPRECATED ERROR: DOS/Windows/Novell error 51
* [[4252]] DEPRECATED ERROR: DOS/Windows/Novell error 52
* [[4253]] DEPRECATED ERROR: DOS/Windows/Novell error 53
* [[4254]] DEPRECATED ERROR: DOS/Windows/Novell error 54
* [[4255]] DEPRECATED ERROR: DOS/Windows/Novell error 55
* [[4256]] DEPRECATED ERROR: DOS/Windows/Novell error 56
* [[4257]] DEPRECATED ERROR: DOS/Windows/Novell error 57
* [[4258]] DEPRECATED ERROR: DOS/Windows/Novell error 58
* [[4259]] DEPRECATED ERROR: DOS/Windows/Novell error 59
* [[4260]] DEPRECATED ERROR: DOS/Windows/Novell error 60
* [[4261]] Printer queue full
* [[4262]] DEPRECATED ERROR: DOS/Windows/Novell error 62
* [[4263]] DEPRECATED ERROR: DOS/Windows/Novell error 63
* [[4264]] DEPRECATED ERROR: DOS/Windows/Novell error 64
* [[4265]] DEPRECATED ERROR: DOS/Windows/Novell error 65
* [[4266]] DEPRECATED ERROR: DOS/Windows/Novell error 66
* [[4267]] DEPRECATED ERROR: DOS/Windows/Novell error 67
* [[4268]] DEPRECATED ERROR: DOS/Windows/Novell error 68
* [[4269]] DEPRECATED ERROR: DOS/Windows/Novell error 69
* [[4270]] End of file
* [[4271]] Incomplete record
* [[4272]] Key not found
* [[4273]] Help keyword or topic not found
* [[4274]] DEPRECATED ERROR: DOS/Windows/Novell error 74
* [[4275]] DEPRECATED ERROR: DOS/Windows/Novell error 75
* [[4276]] Lock does not exist
* [[4277]] DEPRECATED ERROR: DOS/Windows/Novell error 77
* [[4278]] DEPRECATED ERROR: DOS/Windows/Novell error 78
* [[4279]] DEPRECATED ERROR: DOS/Windows/Novell error 79
* [[4280]] DEPRECATED ERROR: DOS/Windows/Novell error 80
* [[4281]] DEPRECATED ERROR: DOS/Windows/Novell error 81
* [[4282]] Data does not match LINK=
* [[4283]] Updating previous/next link failed
* [[4284]] DEPRECATED ERROR: DOS/Windows/Novell error 84
* [[4285]] DEPRECATED ERROR: DOS/Windows/Novell error 85
* [[4286]] DEPRECATED ERROR: DOS/Windows/Novell error 86
* [[4287]] DEPRECATED ERROR: DOS/Windows/Novell error 87
* [[4288]] DEPRECATED ERROR: DOS/Windows/Novell error 88
* [[4289]] DEPRECATED ERROR: DOS/Windows/Novell error 89
* [[4290]] DEPRECATED ERROR: DOS/Windows/Novell error 90
* [[4291]] DEPRECATED ERROR: DOS/Windows/Novell error 91
* [[4292]] DEPRECATED ERROR: DOS/Windows/Novell error 92
* [[4293]] DEPRECATED ERROR: DOS/Windows/Novell error 93
* [[4294]] DEPRECATED ERROR: DOS/Windows/Novell error 94
* [[4295]] DEPRECATED ERROR: DOS/Windows/Novell error 95
* [[4296]] DEPRECATED ERROR: DOS/Windows/Novell error 96
* [[4297]] DEPRECATED ERROR: DOS/Windows/Novell error 97
* [[4298]] DEPRECATED ERROR: DOS/Windows/Novell error 98
* [[4299]] Cannot copy or rename file to itself

* [[4300]] Shell call return value
* [[4301]] DEPRECATED ERROR: DOS/Windows/Novell error 101
* [[4302]] DEPRECATED ERROR: DOS/Windows/Novell error 102
* [[4303]] DEPRECATED ERROR: DOS/Windows/Novell error 103
* [[4304]] DEPRECATED ERROR: DOS/Windows/Novell error 104
* [[4305]] DEPRECATED ERROR: DOS/Windows/Novell error 105
* [[4306]] DEPRECATED ERROR: DOS/Windows/Novell error 106
* [[4307]] DEPRECATED ERROR: DOS/Windows/Novell error 107
* [[4308]] DEPRECATED ERROR: DOS/Windows/Novell error 108
* [[4309]] DEPRECATED ERROR: DOS/Windows/Novell error 109
* [[4310]] DEPRECATED ERROR: DOS/Windows/Novell error 110
* [[4311]] DEPRECATED ERROR: DOS/Windows/Novell error 111
* [[4312]] DEPRECATED ERROR: DOS/Windows/Novell error 112
* [[4313]] DEPRECATED ERROR: DOS/Windows/Novell error 113
* [[4314]] DEPRECATED ERROR: DOS/Windows/Novell error 114
* [[4315]] DEPRECATED ERROR: DOS/Windows/Novell error 115
* [[4316]] DEPRECATED ERROR: DOS/Windows/Novell error 116
* [[4317]] DEPRECATED ERROR: DOS/Windows/Novell error 117
* [[4318]] DEPRECATED ERROR: DOS/Windows/Novell error 118
* [[4319]] DEPRECATED ERROR: DOS/Windows/Novell error 119
* [[4320]] Unknown system error see SYSERR function
* [[4321]] DEPRECATED ERROR: DOS/Windows/Novell error 121
* [[4322]] DEPRECATED ERROR: DOS/Windows/Novell error 122
* [[4323]] DEPRECATED ERROR: DOS/Windows/Novell error 123
* [[4324]] DEPRECATED ERROR: DOS/Windows/Novell error 124
* [[4325]] DEPRECATED ERROR: DOS/Windows/Novell error 125
* [[4326]] DEPRECATED ERROR: DOS/Windows/Novell error 126
* [[4327]] DEPRECATED ERROR: DOS/Windows/Novell error 127
* [[4328]] DEPRECATED ERROR: DOS/Windows/Novell error 128
* [[4329]] DEPRECATED ERROR: DOS/Windows/Novell error 129
* [[4330]] DEPRECATED ERROR: DOS/Windows/Novell error 130
* [[4331]] DEPRECATED ERROR: DOS/Windows/Novell error 131
* [[4332]] DEPRECATED ERROR: DOS/Windows/Novell error 132
* [[4333]] DEPRECATED ERROR: DOS/Windows/Novell error 133
* [[4334]] DEPRECATED ERROR: DOS/Windows/Novell error 134
* [[4335]] DEPRECATED ERROR: DOS/Windows/Novell error 135
* [[4336]] DEPRECATED ERROR: DOS/Windows/Novell error 136
* [[4337]] DEPRECATED ERROR: DOS/Windows/Novell error 137
* [[4338]] DEPRECATED ERROR: DOS/Windows/Novell error 138
* [[4339]] DEPRECATED ERROR: DOS/Windows/Novell error 139
* [[4340]] Unknown curl error - use -e to return OS error
* [[4341]] DEPRECATED ERROR: DOS/Windows/Novell error 141
* [[4342]] DEPRECATED ERROR: DOS/Windows/Novell error 142
* [[4343]] DEPRECATED ERROR: DOS/Windows/Novell error 143
* [[4344]] DEPRECATED ERROR: DOS/Windows/Novell error 144
* [[4345]] DEPRECATED ERROR: DOS/Windows/Novell error 145
* [[4346]] DEPRECATED ERROR: DOS/Windows/Novell error 146
* [[4347]] DEPRECATED ERROR: DOS/Windows/Novell error 147
* [[4348]] DEPRECATED ERROR: DOS/Windows/Novell error 148
* [[4349]] DEPRECATED ERROR: DOS/Windows/Novell error 149
* [[4350]] DEPRECATED ERROR: DOS/Windows/Novell error 150
* [[4351]] DEPRECATED ERROR: DOS/Windows/Novell error 151
* [[4352]] DEPRECATED ERROR: DOS/Windows/Novell error 152
* [[4353]] DEPRECATED ERROR: DOS/Windows/Novell error 153
* [[4354]] DEPRECATED ERROR: DOS/Windows/Novell error 154
* [[4355]] DEPRECATED ERROR: DOS/Windows/Novell error 155
* [[4356]] DEPRECATED ERROR: DOS/Windows/Novell error 156
* [[4357]] DEPRECATED ERROR: DOS/Windows/Novell error 157
* [[4358]] DEPRECATED ERROR: DOS/Windows/Novell error 158
* [[4359]] DEPRECATED ERROR: DOS/Windows/Novell error 159
* [[4360]] DEPRECATED ERROR: DOS/Windows/Novell error 160
* [[4361]] DEPRECATED ERROR: DOS/Windows/Novell error 161
* [[4362]] DEPRECATED ERROR: DOS/Windows/Novell error 162
* [[4363]] DEPRECATED ERROR: DOS/Windows/Novell error 163
* [[4364]] DEPRECATED ERROR: DOS/Windows/Novell error 164
* [[4365]] DEPRECATED ERROR: DOS/Windows/Novell error 165
* [[4366]] DEPRECATED ERROR: DOS/Windows/Novell error 166
* [[4367]] DEPRECATED ERROR: DOS/Windows/Novell error 167
* [[4368]] DEPRECATED ERROR: DOS/Windows/Novell error 168
* [[4369]] DEPRECATED ERROR: DOS/Windows/Novell error 169
* [[4370]] DEPRECATED ERROR: DOS/Windows/Novell error 170
* [[4371]] DEPRECATED ERROR: DOS/Windows/Novell error 171
* [[4372]] DEPRECATED ERROR: DOS/Windows/Novell error 172
* [[4373]] DEPRECATED ERROR: DOS/Windows/Novell error 173
* [[4374]] DEPRECATED ERROR: DOS/Windows/Novell error 174
* [[4375]] DEPRECATED ERROR: DOS/Windows/Novell error 175
* [[4376]] DEPRECATED ERROR: DOS/Windows/Novell error 176
* [[4377]] DEPRECATED ERROR: DOS/Windows/Novell error 177
* [[4378]] DEPRECATED ERROR: DOS/Windows/Novell error 178
* [[4379]] DEPRECATED ERROR: DOS/Windows/Novell error 179
* [[4380]] DEPRECATED ERROR: DOS/Windows/Novell error 180
* [[4381]] DEPRECATED ERROR: DOS/Windows/Novell error 181
* [[4382]] DEPRECATED ERROR: DOS/Windows/Novell error 182
* [[4383]] DEPRECATED ERROR: DOS/Windows/Novell error 183
* [[4384]] DEPRECATED ERROR: DOS/Windows/Novell error 184
* [[4385]] DEPRECATED ERROR: DOS/Windows/Novell error 185
* [[4386]] DEPRECATED ERROR: DOS/Windows/Novell error 186
* [[4387]] DEPRECATED ERROR: DOS/Windows/Novell error 187
* [[4388]] DEPRECATED ERROR: DOS/Windows/Novell error 188
* [[4389]] DEPRECATED ERROR: DOS/Windows/Novell error 189
* [[4390]] DEPRECATED ERROR: DOS/Windows/Novell error 190
* [[4391]] DEPRECATED ERROR: DOS/Windows/Novell error 191
* [[4392]] DEPRECATED ERROR: DOS/Windows/Novell error 192
* [[4393]] DEPRECATED ERROR: DOS/Windows/Novell error 193
* [[4394]] DEPRECATED ERROR: DOS/Windows/Novell error 194
* [[4395]] DEPRECATED ERROR: DOS/Windows/Novell error 195
* [[4396]] DEPRECATED ERROR: DOS/Windows/Novell error 196
* [[4397]] DEPRECATED ERROR: DOS/Windows/Novell error 197
* [[4398]] DEPRECATED ERROR: DOS/Windows/Novell error 198
* [[4399]] File name is not a UNC path

* [[4501]] OS function failure
* [[4513]] Bad data on OS function
* [[4514]] No memory on OS function
* [[4521]] Device not ready
* [[4522]] Bad system command
* [[4526]] Not a dos disk
* [[4591]] A shell call timed out
* [[4596]] Process signaled
* [[4597]] Process stopped
* [[4598]] Process was terminated in an unknown manner
* [[4614]] Invalid standard handle
* [[4616]] PDF library initialization failed
* [[4618]] An error that aborts further reconnect attempts has occurred
* [[4620]] Client server connection failure
* [[4890]] Temporary index creation failure

* [[6201]] Spooling error while executing lp or lpr
* [[6213]] Unknown windows printing error
* [[6214]] Printing windlg find resource error
* [[6215]] Printing windlg initialization error
* [[6216]] Printing windlg load resource error
* [[6217]] Printing windlg load string failure
* [[6218]] Printing windlg lock resource failure
* [[6219]] Printing windlg no memory
* [[6220]] Printing windlg failed to lock memory
* [[6221]] Printing windlg no hisntance
* [[6222]] Printing windlg no hook
* [[6223]] Printing windlg no template
* [[6224]] Printing windlg struct size
* [[6225]] Printing windlg create IC failure
* [[6226]] Printing windlg default different
* [[6227]] Printing windlg drag and drop mismatch
* [[6228]] Printing windlg print dev mode failure
* [[6229]] Printing windlg error initializing printer
* [[6230]] Printing windlg error loading driver
* [[6231]] Printing windlg no default printer
* [[6232]] Printing windlg no devices
* [[6233]] Printing windlg parse failure
* [[6234]] Printing windlg printer not found
* [[6235]] Printing windlg return default failure
* [[6236]] Printing windlg setup failure
* [[6240]] Failed opening printer DC
* [[6242]] Invalid parametrized substitution format
* [[6243]] Parameter count does not match using parametrized substitutions
* [[6244]] Parametrized substitution result is too long
* [[6245]] Unsupported escape sequence for printing
* [[6246]] Passthrough printing error
* [[6247]] Invalid NWP color specification
* [[6248]] Invalid NWP picture specification or the image is not found
* [[6250]] Invalid PDF import specification
* [[6252]] Print PDF requires either READER or an output file name
* [[6254]] Creating a new PDF document failed
* [[6255]] Adding a page to a PDF document failed
* [[6256]] Ending a PDF document failed
* [[6257]] Adding an image to a PDF document failed
* [[6270]] Spooling error
* [[6272]] Bad initializer for PJL mode
* [[7600]] Invalid or missing key start position
* [[7601]] Invalid key length
* [[7602]] Bad key
* [[7603]] Duplicate keys found
* [[7604]] Missing parameters for INDEX
* [[7605]] Invalid index parameter
* [[7606]] INDEX records in does not match records out
* [[7607]] Not enough memory for INDEX
* [[7609]] Attempt to INDEX a file that is not an internal file
* [[7610]] Invalid INDEX file name
* [[7611]] INDEX file already exists
* [[7612]] Invalid INDEX work path
* [[7636]] INDEX interrupted by user
* [[7699]] Bad internal record size for INDEX
* [[7801]] Invalid sort keyword
* [[7804]] Syntax error in SORT - FILE specification
* [[7805]] Syntax error in SORT - RECORD specification
* [[7806]] Syntax error in SORT - ALTS specification
* [[7807]] Syntax error in SORT - MASK specification
* [[7809]] Syntax error in SORT - SUM specification
* [[7810]] Attempt to SORT a file that is not an internal file
* [[7811]] Not enough memory for SORT
* [[7812]] Invalid SORT output file type
* [[7821]] ALTS value is too large
* [[7823]] Missing MASK specification
* [[7825]] Too many RECORD statements
* [[7828]] SORT specifications out of order
* [[7829]] RECORD specification too long or too many RECORD specifications
* [[7830]] RECORD lower limit is greater than upper limit
* [[7831]] Output file record length is too short
* [[7832]] Output file not empty
* [[7853]] SORT control file not found
* [[8001]] DEPRECATED ERROR: number too long
* [[8002]] Window too small for input
* [[9000]] Out of memmory
* [[9001]] work stack is full
* [[9002]] RPN stack is full
* [[9003]] Flow stack is full
* [[9004]] FOR/NEXT stack is full
* [[9005]] RPN stack is empty
* [[9006]] Too many nested IF, FOR/NEXT or DO/LOOP structures
* [[9100]] DEPRECATED ERROR: compiler error
* [[9111]] Code byte count is incorrect
* [[9112]] Source byte count is incorrect
* [[9201]] Invalid access for opening a file
* [[9203]] Invalid create for opening a file
* [[9301]] Invalid number of RPN entries
* [[9302]] Function error
* [[9303]] Invalid function
* [[9304]] User defined function error
* [[9305]] User defined function error
* [[9306]] User defined function stacking error
* [[9307]] No editor defined or invalid ON error statement
* [[9308]] Utility open file channel is not open
* [[9309]] Corrupt .BR/.WB program file encountered
* [[9310]] Variable index outside of variable table
* [[9400]] DEPRECATED ERROR: output file corrupted
* [[9401]] BTREE verification failed
* [[9502]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9503]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9504]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9505]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9506]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9507]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9508]] DEVELOPMENT ERROR: Actual error code not assigned yet
* [[9985]] DEPRECATED ERROR: work file missing
* [[9987]] No source exists for the given file
* [[9988]] DEPRECATED ERROR: source line greater than 800 bytes
* [[9990]] This version was made without HTTP support
* [[9992]] DEF statement compiler error
* [[9994]] Line reference indicates library, but no libraries active
* [[9995]] DEPRECATED ERROR: RPN stack failure
* [[9996]] Library program not found or internal line not found
* [[9997]] Unbalanced parenthesis or flow stack error
* [[9998]] Corrupt DIM source

[[Category:Needs Help]]

[[Category:Release 4.3]]
[[Category:Release Notes]]