INFORMATION PROVIDED IN THIS DOCUMENT AND ANY SOFTWARE THAT MAY ACCOMPANY THIS DOCUMENT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
The user assumes the entire risk as to the accuracy and the use of the information supplied. This information may be copied and distributed subject to the following conditions: 1)All text must be copied without modification and all pages must be included; 2)If software is included, all files on the disk(s) must be copied without modification; 3)All software included and documentation must be distributed together; and 4)This information may not be distributed for profit.
Copyright © 1996 Platinum Software Corporation. All Rights Reserved.
Platinum ia a registered trademark of Platinum Software Corporation.
All other trademarks contained herein are acknowledged.
BTRIEVE NLM ver. 6.xx
Btrieve NLM gives you the option, during the setup configuration, to state if you want newly created files in the previous (5.15) format). If you do not wish to do so, state so in the setup and then all newly created files are in the new 6.xx format. The files that are created in the older version, remain in that format, since Btrieve 6.xx is downward compatible. These files are not rebuilt into the new format, unless you manually do so through the Rebuild process.
Section 1:
Btrieve setup:
1. To start the setup, at the System Console prompt (on the server), type:
load bsetup <enter>
2. Select Set Btrieve Configuration from the following screen:
3. The following screen will appear:
Note: The above is an example setup for 4 sessions using Platinum.
Where:
Number of Open Files -
Range: 1 through 64,000 files
Default: 20 files
Approximate Memory Required: 425 bytes per file
Specify the maximum number of unique Btrieve files that can be opened at one time at the server. The value you specify determines the size of the internal tables used to
track active files. Each unique Btrieve file on the server counts as one file.
Number of Handles -
Range: 1 through 64,000 files
Default: 60 handles
Approximate Memory Required: 200 bytes per handle
Specify the maximum number of file handles that the Btrieve NLM can use at one time. This is different from the number of open files. If two sessions open the same file on the same server, Btrieve counts it as one open file, but two different file
handles.
The Number of Handles is obtained by multiplying 55 by the Number of Remote Sessions.
Number of Locks -
Range: 0 through 64,000 locks
Default: 20 locks per client session
Approximate Memory Required: 20 bytes per lock
This options sets the maximum number of records a client session can lock at the server at one time. This maximum applies to whichever type of read lock (single or
multiple record) the client session is using.
Note: A session occurs when a client uses the Btrieve Requester or Message Router to communicate with the Btrieve NLM, or when an application calls Btrieve directly.
To determine the Number of Locks that Platinum uses, multiply the Number of Remote Sessions by 55.
Number of Transactions -
Range: 0 through 64,000 transactions
Default: 15 transactions
Approximate Memory Required: 20 bytes + (2 * maximum number of files)
This sets the maximum number of Btrieve clients that can simultaneously have active transactions at the server. If you specify 6 transactions, Btrieve creates a transaction file at the server (BTRIEVE.TRN in the SYS:SYSTEM directory) and allows a maximum of 6 clients to have one active transaction each at the server. If you specify a value of 0, no clients can perform a Btrieve transaction.
Note: Each of the clients can have only one active transaction at the server.
This option is not used by Platinum, therefore it is set to 0.
Largest Compressed Record Size -
Range: 0 through 64 KB
Default: 0 KB
Approximate Memory Required: 2,048 bytes * specified value
This option allows you to allocate memory for a compression buffer that Btrieve can use when you access records in a Btrieve file created with the Data Compression file attribute enabled. Btrieve allocates a compression buffer with a size of 2,048 bytes
multiplied by the value you specify for this option.
If you use compressed files, set this option to the longest record in any of your compressed files. Round any uneven values up to the next kilobyte. If every compressed file you use has Variable-tail Allocation Tables (VATs), set this option to the file's largest page size (in bytes) divided by 128.
This option is not used by Platinum, therefore it is set to 0.
Largest Record Size -
Range: 600 through 64,000 bytes
Default: 8,192 bytes
Approximate Memory Required: recordLength * (remoteSession / 5) + 1 + (remoteSessions * recordLength / 580) * 600
recordLength 538 + largest record size
remoteSessions Number of remote sessions
The length of the largest record or record chunk that any remote Btrieve application (excluding other NLMs that call Btrieve, such as NetWare SQL) can access at the server. Specify the length of the record (or record chunk) in bytes. Specifying a value higher than you need does not improve performance and may waster memory.
The Largest Record Size in Platinum is 1,200 bytes.
Note: If there are any problems, increment this number.
Largest Page Size -
Range: 512 through 4,094 bytes
Default: 4,096 bytes
Approximate Memory Required: Not applicable
This option specifies the maximum page size (in bytes) of any Btrieve file you want to access. The page size must be a multiple of 12 bytes, but no greater than 4,096 bytes.
Note: Setting the page size to 512, 1,024, 2,048, or 4,096 can improve performance because these page sizes correspond to disk block sizes Setting the page size to 1,536, 2,560, 3,072, or 3,584, a given disk read may span two disk blocks and therefore require two disk accesses per page.
The Largest Page Size for Platinum is 1,536 bytes. This may be set to 2,048 for improved performance.
Number of Remote Session -
Range: 1 through 64,000 session
Default: 15 sessions
Approximate Memory Required: 150 bytes * number of remote sessions
This specifies the number of SPX sessions that can access the remote Btrieve NLM at one time. Each session is allocated two packet buffers for Btrieve requests.
Note: If you receive a Status Code 96, increase the value for this option. However, do not specify a value higher than you need. Specifying a value that is too high does not improve performance; instead it uses memory that NetWare or other processes might need.
Cache Allocation -
Range: 32 through 64,000 KB
Default: 256 KB
Approximate Memory Required: Not applicable
This is the size of the cache (in KB) that Btrieve allocates. To achieve best performance, allocate a cache size equal to the Same of the sizes of the files you are using. However, be careful not to take all available cache, especially if the server is running other applications. You cannot improve performance, and may waster memory, by specifying a value higher than you need.
Perform Index Balancing -
Range: Yes or No
Default: No
Approximate Memory Required: Not applicable
When an index page becomes full, Btrieve automatically creates a new index page and splits the values in the full index page between the two index pages. This option lets you avoid creating a new index page every time an old one fills up.
Specifying Yes causes Btrieve to look for available space in sibling index pages each time and index page becomes full.
Create Files as Transactional -
Range: Yes or No
Default: No
Approximate Memory Required: Not applicable
This option controls whether Btrieve automatically flags each file as transactional when you create it. The transactional flag indicates that the NetWare Transaction Tracking System (TTS) is protecting the file.
Logging of Selected Files -
Range: Yes or No
Default: No
Approximate Memory Required: Not applicable
This controls whether Btrieve logs operations executed on selected files. If you specify Yes, Btrieve logs all operations that change any file listed in the BLOG.CFG file on Btrieve's sever volume. If you specify No, Btrieve performs no logging.
Create Btrieve files in pre v6.x format -
Range: Yes or No
Default: No
Approximate Memory Required: Not applicable
This option specifies that all files be created in a Btrieve Version prior to v6.x. Use this option only if you need backward compatibility with a previous version of Btrieve.
Note: If this option is set to No, then all files that are created are set to Btrieve v6.x. All files that were created in an older version of Btrieve, will remain in that format until they are Converted/Rebuilt.
Platinum uses Btrieve 5.15 file format. If you want to use the v6.x format, you must first Convert/Rebuild the files (described in section 2). If the DATA directory of Platinum is Converted/Rebuilt before any company data is initialized, in order to create a new company), then all the new company's data files will be in the newer 6.x format. Any new Platinum files that are entered, will need to be Converted/Rebuilt as well, prior to initializing it in the company.
Configure BSTART.NCF to Load BROUTER -
Range: Yes or No
Default: No
Approximate Memory Required: Not applicable
This option controls whether the Message Router is loaded during the execution of the BSTART.NCF NetWare command file. The Message Router allows other NLMs (such as NetWare SQL) to communicate with remote servers on which Btrieve is loaded. If you want to access Btrieve data on a remote server, specify Yes for his option.
Section 2:
The conversion may be done in two different methods -
Using the BSETUP utility:
1. Start the setup, at the System Console prompt (on the server), type:
load bsetup <enter>
2. Select Set Rebuild Configuration from the following screen:
(A warning will appear asking you to back up your data files)
3. If you have not done a back up, press <ESC> until you exit, and perform a back up of your data. Otherwise, press <ESC> once. The following screen will appear. Select Set Rebuild Configuration:
4. The following screen will appear:
Where:
Files To Be Converted -
Give the complete path of where the file(s) are to be Converted/Rebuilt. Wildcards are accepted and single file names are accepted as well. In order to enter data in this field, you must press <ENTER> then <INS> at the prompt. At the list of available volumes, highlight the volume you want and press <ENTER>. Continue highlighting directories & subdirectories and pressing <ENTER> until you have reached the one that contains the files or files you want to rebuild. Then press <ESC>.
Choose the files you want to rebuild as follow:
To specify more than one file, enter the filenames manually, using wildcards (* or ?).
To specify an individual file, press <ENTER> to list the filenames in the specified directory.Highlight the filename you want and press <ENTER> to select it.
Output Directory -
Specify the location you want to use for the rebuilt files. You must press <ENTER> at this field. Either type the server or directory name manually and press <ENTER>, or choose from the list of available directories on the current server by entering a valid path and pressing <INS>.
If you want to place the rebuilt files on a different server, you must type the output server name, volume and path manually, then press <ENTER>
Note: Do not use wildcards in the pathname that specifies the location for the rebuilt files.
Page Size:
Type the size manually or choose from a list of sizes. The AUTO option (the default) means the utility will choose the optimum page size for the files. The EXISTING option means the utility will use the same page size as that of the original files.
Note: When using the EXISTING option, the utility changes the page size if the original size will not work. For example, assume you have a Btrieve v5.x file with a pages size of 1,024 and 24 keys. Since Btrieve v6.x supports only 23 keys for a file of that page size, the utility selects a new page size for the file and displays a message on the screen to that effect.
Key Number:
Specify a number between 0 and 23 on which to sort the records, or specify -1 to sort the records in physical order; then press <ENTER>
Note: If you are using NetWare SQL, you must specify a key number of 0 when rebuilding the VIEW.DDF file.
Preserve TTS Setting:
Specify Y (Yes) or N (No) on whether you want to preserve the Transaction Tracking System (TTS) but during conversion, then press <ENTER>.
Note: If you specify N (the default), the utility clears the bit when creating Btrieve v6.x files.
Conversion Method:
Press <ENTER> then select either PRIMARY (the default) or SECONDARY, and press<ENTER>.
The PRIMARY method clones the files, drops the indexes, copies the records into the new files, and rebuilds the indexes. This method is faster and creates smaller files, you should use this method whenever possible. However, if you are using NetWare SQL, you must NOT use this method when rebuilding the VIEW.DDF file.
The SECONDARY method clones and copies the files without dropping and replacing indexes. If you are using NetWare SQL, you must use this method.
Continue On Error:
Specify Y, the utility continues if it encounters and error. If you specify N, the utility stops if it encounters an error and aborts the rebuild process.
Note: If you specify Y, the Utility notifies you of non-Btrieve files or other errors but continuesrebuilding Btrieve files.
Convert Supplemental Indexes:
Specify Y for the utility to convert Btrieve v5.x supplemental indexes (which allow duplicates to Btrieve v6.x indexes with linked duplicates. Specify N (the default) so the utility does not convert the v5.x supplemental indexes but preserves them as repeating duplicates.
Note: Btrieve v5.x supplemental indexes have, by default, repeating duplicates. Do not use the Convert Supplemental Indexes option if you access your data files through NetWare SQL.
4. Press <ESC> to leave the Rebuild Configuration Setup screen. And select Yes to save your changes.
5. Choose Execute Rebuild from the following screen:
This utility executes and also creates a log file. It then notifies you that the process has completed. To return to the Rebuild Options screen, press <ESC>.
Note: Be sure to check the utility's log file to see if any errors occurred during the conversion. To check the log, select View Rebuild Log File from the above screen.
‚ Using the Command line:
At the Server prompt, execute the following:
LOAD BREBUILD [-option ...] file OR LOAD BREBUILD @commandFile
Where:
option:
Specifies the configuration options for the utility. Precede each option letter with a dash (-).
-B[path] Specifies an alternate location for the rebuilt files (The default is the current directory).
-C Instructs the utility to continue with the next file even if an error occurs.
-D Converts Btrieve v5.x supplemental indexes to v6.x indexes with linked duplicates.
Note: do not use -D if you access your data files through NetWare SQL.
-M0 | M2 Specifies the conversion method as follows:
M0 - Clones and copies the files without dropping and replacing indexes.
M2 - (Default) Clones the files, drops the indexes, copies the records into the new files and rebuilds the indexes.
Note: If you are using NetWare SQL, you must use the -M0 and -K0 options to rebuild the VIEW.DDF file. The M2 method may create a v6.x file in which the records are in a different physical order than in the original v5.x file.
-P{nnn} Specifies the page size (in bytes) of the new files. _P with no page size, causes the utility to use the optimum page size for your file.
Note: If you do not specify the -P parameter, the utility will change the page size if the original size will not work.
-K[nn] Specifies the key by which the utility reads when rebuilding a fields. If the option is not specified, the utility reads the file in physical order.
Note: You must use -K0 option when rebuilding NetWare SQL's VIEW.DDF file.
-T Does not preserve the TTS bit during conversion. If this option is not specified, the TTS bit is preserved.
file:
Specifies the set of files to convert. Use the full directory names, including the volume name. You may use wildcards (* and ?).
Note: The Rebuild utility applies the Btrieve v5.x file's owner name and the level to the Btrieve v6.x file.
@commandFile:
Specifies a command file for the utility to execute. Each set of files to convert must end with <end> or [end]. Be sure to use full directory names, including the volume name. You may use wildcards (* and ?).
EX: -C sys:\mydir\*.* <end>
-C -P1024 data:\dir\*.* <end>
-M0 -K0 sys:\nwsql\*.* <end>
Recommended Configuration for Platinum
· If you are using BTRIEVE(N).EXE dated 10/15/91, configuration should be set as follows:
CONFIG.SYS - Files=60
NETSTART.BAT - would have the Btrieve line REM'd out.
SHELL.CFG - No longer needed for Platinum.
PLT.CFG* - This would hold the Btrieve line that used to be in the NETSTART.BAT file. It would start with either a Y or an N, depending if you wanted to load help, and
would look as follows:
Y BTRIEVE(N) /M:64/P:1536/F:55/O/E
* To use 3rd Party Application - To drop the environment space.
(The presence of this file tells Resource Manager to unload all but UTLOAD1 (14K TSR) and about 7K stub for total of 20-22K left in Ram when you drop the environment space).
· If you have BTRIEVE(N).EXE dated prior to 10/15/91, configuration should be set as follows:
CONFIG.SYS - Files=100
NETSTART.BAT or PLT.CFG - The /F: parameter should be set to 120.
SHELL.CFG - Must contain two lines (Exactly as shown below in caps.)
FILE HANDLES=100
MAXIMUM FILE LOCKS PER CONNECTION=100
AUTOEXEC.NCF - (AUTOEXEC on server) Also needs the MAXIMUM FILE LOCKS PER CONNECTION=100 line.
· You need at least 500K to 520K of conventional memory available before loading Platinum.
