Start-up Command: Difference between revisions

From BR Wiki
Jump to navigation Jump to search
(Uploaded, added, and positioned help image)
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
You may use BR in combination with a '''start-up''' [[command]]. It can be executed only from the host [[operating system]].
In order to modify the default behavior of BR after it starts, you may use a '''start-up''' [[:Category:Commands|command]]. It can be executed only from the host [[Wikipedia:Operating system|operating system]].


===Syntax===
==Syntax==


The complete syntax of the BR command is as follows:
[[Image:Startup.png]]


[[Image:HELP0066.jpg|left]]
==Parameters==


<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
The '''name of BR executable''', in either uppercase or lowercase letters, must be specified.


a @UserName may also be used to override the windows [[environmental variable]] [[UserName]] in the [[Login_Name$]] [[internal function]].
A complete "statement" or "command" may follow the name of BR executable. It will be executed as soon as BR is entered. The use of quotation marks around the command or statement is not required, but it is highly recommended.


===Comments and Examples===
The '''-wsid''' parameter represents the workstation ID. It may be a number from 1 to 999. If no -WSID parameter is specified, BR automatically tries to assign a workstation ID of 1 to the session.
As BR32.exe is executed from the [[operating system]], it is operating system dependent. In the next example, Business Rules! is started on a [[Windows]] system. Immediately after Business Rules! starts up, the [[RUN]] command is executed and the MENU [[program]] begins to run:


BR32.exe "RUN MENU"
A plus symbol '''+''' may optionally follow the '''-wsid''' parameter to indicate that when the specified wsid is already in use, BR should increment accordingly until an available ID is found. If the plus symbol is followed by an increment parameter, it will be used when it is necessary to increment. The increment parameter may be any whole number from 0 to 999. If the plus symbol is used but increment is not specified, 1 is used as the incremental default. If no plus symbol is specified and the requested ID is already in use, an error results.


The BR command in the next example causes, Business Rules! to start up at the same time that it assigns a [[workstation ID]] of 42 and specifies altconfg.sys to be used as the [[BRConfig.sys]] file:
The '''name of alternative configuration file''' parameter identifies the name of an alternate BR configuration [[BRConfig.sys]] file. This configuration file can contain important information that helps customize a number of configurable BR and application options for the user. The actual specification must consist of a dash (-) followed by a path (optional) and file name. If a '''name of alternative configuration file''' is not specified, BR automatically looks for a file named [[BRConfig.sys]] and uses its contents as the configuration file.


  br32.exe -42 -altconfg.sys
@UserName parameter may also be used to override the windows [[environmental variable]] [[UserName]] in the [[Login_Name$]] [[internal function]].


The BR command in the next example uses all the available specifications for a Windows version of Business Rules!. It causes a PROC command to be executed as soon as Business Rules! is started; it assigns a WSID of 21 to the workstation; and it identifies ALT6.SYS as the alternate BRConfig.sys file:
==Comments and Examples==


BR32.exe "PROC START" -21 -ALT6.SYS
As BR32.exe is executed from the [[Wikipedia:Operating system|operating system]], it is operating system dependent. In the next example, BR is started on a [[Wikipedia:Microsoft Windows|Windows]] system. Immediately after BR starts up, the [[RUN]] command is executed and the MENU [[program]] begins to run:


[[Image:HELP0168.jpg]]
BR32.exe "RUN MENU"


===Defaults===
Consider this example for Windows:
:1.) Do not load Business Rules! as a memory-resident task.
:2.) 25.
:3.) Enter Business Rules! without executing a command or statement.
:4.) Assign a workstation ID of 01 on single-user systems; assign the workstation's hardware- dependent ID on Unix and Linux systems; assign according to sign-on order on Windows systems.
:5.) Access BRConfig.sys from the default directory.
:
At startup the number of authorized users is displayed, in addition to the number of current users.


#Click Start &rarr; Run
#Type in '''C:\BR\BR.exe -45 @alternateUser''' and press <ENTER>


:4.) Load Business Rules! without executing a command or statement.
The effect of the above command will be:
:5.) Assign a workstation ID of 01 on single-user systems; Assign according to sign-on order on Networks.
#BR will be started
:6.) Use the specified [[WSID]]. If already in use, return an error.
#The workstation ID will be 45 (speceified by the -45 parameter)
:7.) Use an increment of 1.
#Instead of the currently logged in Windows user, an alternative name will be used, in this case '''alternateUser'''
:8.) Assume that the configuration file is named [[BRConfig.sys]].


===Parameters===
The above command assumes that the BR executable is located in the directory C:\BR


The top path represents Unix and Linux versions of Business Rules "br", in lowercase letters, must be used to start up Business Rules from either of these systems.
The command in the next example causes BR to start up at the same time that it assigns a [[workstation ID]] of 42 and specifies altconfg.sys to be used as the [[BRConfig.sys]] file:


The bottom path represents DOS and DOS NetWork versions. "BR", in either uppercase or lowercase letters, must be specified.
  br32.exe -42 -altconfg.sys


A complete "statement" or "command" may follow the br keyword. It will be executed as soon as Business Rules is entered. The use of quotation marks around the command or statement is not required, but it is highly recommended.
The BR command in the next example causes a PROC command to be executed as soon as BR is started. It also assigns a WSID of 21 to the workstation, and it identifies ALT6.SYS as the alternate BRConfig.sys file:


The "-xx" parameter represents the workstation ID. It may be a one or two-digit number from 01 to 99. The "-file-ref" parameter allows you to specify the name of an alternate Business Rules configuration file (BRConfig.sys). The system automatically tries to access a file named BRConfig.sys when no other name is specified. All versions of Business Rules (except the single-user DOS version) must access a BRConfig.sys or alternate file that includes a DRIVES specification. If such a file cannot be accessed, the start-up will fail.
BR32.exe "PROC START" -21 -ALT6.SYS


The "statement" and "command" parameters represent a Business Rules statement or command that is to be executed at start-up. The use of quotation marks around the statement or command is not required, but is recommended.
==Defaults==
 
#Do not load BR as a memory-resident task.
The -WSID parameter identifies the workstation ID that is to be assigned to this session. The actual specification must consist of a dash (-) followed by a workstation ID of up to three digits. If no -WSID parameter is specified, Business Rules automatically tries to assign a workstation ID of 1 to the session.
#Enter BR without executing a command or statement.
 
#Workstation ID assignment
A plus symbol (+) may optionally follow the -WSID parameter to indicate that when the specified WSID is already in use, Business Rules should increment accordingly to create a new ID. If the plus symbol is followed by the increment parameter, the increment specified will be used when it is necessary to increment. If the plus symbol is used but increment is not specified, 1 is used as the incremental default. If no plus symbol is specified and the requested ID is already in use, an error results.
##assign a workstation ID of 1 on single-user systems
 
##assign the workstation's hardware-dependent ID on Unix and Linux systems
The increment parameter may be any whole number from 0 to 999. If the requested -WSID is not available to assign, Business Rules adds this specified increment to the ID requested and attempts to assign the resulting sum as the ID. If the result is also already in use, Business Rules continues to increment in the same fashion until an unused ID is found.
##assign according to sign-on order on Windows systems.
 
#Access BRConfig.sys from the current directory.
The -file-ref parameter identifies the name of an alternate Business Rules configuration (BRConfig.sys) file. This configuration file can contain important information that helps customize a number of configurable Business Rules and application options for the user. The actual specification must consist of a dash (-) followed by a path (optional) and file name. If -file-ref is not specified, Business Rules automatically looks for a file named [[BRConfig.sys]] and uses its contents as the configuration file.
#Use the specified [[WSID]]. If already in use, return an error.
 
#Use an increment of 1.
Note that with more recent versions of Business Rules, the BR executable file may have a different name (NOT BR.exe). Additionally, you may rename the exe file to anything you like. This is especially handy if you have multiple BR versions on your computer. You might name them according to version or release number (i.e. BR41.exe, BR390k.exe, etc). If this is the case, simply start Business Rules by using the name of the executable file.
#Assume that the configuration file is named [[BRConfig.sys]].
 
===See Also===
*[[BR32.exe Debug]]


At startup the number of authorized users is displayed, in addition to the number of current users.


<noinclude>
<noinclude>
[[Category:Basics]]
[[Category:Basics]]
[[Category:Commands]]
[[Category:Start-up Commands]]
[[Category:Needs Help]]
[[Category:Needs Help]]
[[Category:Files]]
[[Category:Required Files]]
</noinclude>
</noinclude>

Latest revision as of 15:44, 26 February 2014

In order to modify the default behavior of BR after it starts, you may use a start-up command. It can be executed only from the host operating system.

Syntax

Parameters

The name of BR executable, in either uppercase or lowercase letters, must be specified.

A complete "statement" or "command" may follow the name of BR executable. It will be executed as soon as BR is entered. The use of quotation marks around the command or statement is not required, but it is highly recommended.

The -wsid parameter represents the workstation ID. It may be a number from 1 to 999. If no -WSID parameter is specified, BR automatically tries to assign a workstation ID of 1 to the session.

A plus symbol + may optionally follow the -wsid parameter to indicate that when the specified wsid is already in use, BR should increment accordingly until an available ID is found. If the plus symbol is followed by an increment parameter, it will be used when it is necessary to increment. The increment parameter may be any whole number from 0 to 999. If the plus symbol is used but increment is not specified, 1 is used as the incremental default. If no plus symbol is specified and the requested ID is already in use, an error results.

The name of alternative configuration file parameter identifies the name of an alternate BR configuration BRConfig.sys file. This configuration file can contain important information that helps customize a number of configurable BR and application options for the user. The actual specification must consist of a dash (-) followed by a path (optional) and file name. If a name of alternative configuration file is not specified, BR automatically looks for a file named BRConfig.sys and uses its contents as the configuration file.

@UserName parameter may also be used to override the windows environmental variable UserName in the Login_Name$ internal function.

Comments and Examples

As BR32.exe is executed from the operating system, it is operating system dependent. In the next example, BR is started on a Windows system. Immediately after BR starts up, the RUN command is executed and the MENU program begins to run:

BR32.exe "RUN MENU"

Consider this example for Windows:

  1. Click Start → Run
  2. Type in C:\BR\BR.exe -45 @alternateUser and press <ENTER>

The effect of the above command will be:

  1. BR will be started
  2. The workstation ID will be 45 (speceified by the -45 parameter)
  3. Instead of the currently logged in Windows user, an alternative name will be used, in this case alternateUser

The above command assumes that the BR executable is located in the directory C:\BR

The command in the next example causes BR to start up at the same time that it assigns a workstation ID of 42 and specifies altconfg.sys to be used as the BRConfig.sys file:

 br32.exe -42 -altconfg.sys

The BR command in the next example causes a PROC command to be executed as soon as BR is started. It also assigns a WSID of 21 to the workstation, and it identifies ALT6.SYS as the alternate BRConfig.sys file:

BR32.exe "PROC START" -21 -ALT6.SYS

Defaults

  1. Do not load BR as a memory-resident task.
  2. Enter BR without executing a command or statement.
  3. Workstation ID assignment
    1. assign a workstation ID of 1 on single-user systems
    2. assign the workstation's hardware-dependent ID on Unix and Linux systems
    3. assign according to sign-on order on Windows systems.
  4. Access BRConfig.sys from the current directory.
  5. Use the specified WSID. If already in use, return an error.
  6. Use an increment of 1.
  7. Assume that the configuration file is named BRConfig.sys.

At startup the number of authorized users is displayed, in addition to the number of current users.