osBatch (Start a TIBCO Object Service Broker Batch Client)

osBatch {parameter[=value] [, parameter[=value]]}

Executing osBatch starts a single-session Execution Environment. The rule specified by the RULE parameter is executed. When this rule is finished, the session ends and the Execution Environment exits. The exit code of the osBatch process is 0 unless the $SETSESSIONEND tool is used to set the session exit code, or the session abends. If the session abends, the exit code is greater than 127.


	To determine the cause of an abend, refer to TIBCO Object Service Broker Messages With Identifiers.

An osBatch session normally creates an Execution Environment log file and a session log file, in install_path/log for Solaris and in install_path\log for Windows. The default name of the Execution Environment log file is EE.<configuration name>.<date>-<time>.log. The default name of the session log file is batch.<configuration name>.<date>-<time>. log. The value for <configuration name> is determined by the EENAME parameter for the Execution Environment log file, and the NAME parameter for the session log file.

While osBatch is setting up, it writes parameter syntax and validation error messages to the console and to startup.<date>.log (for example, startup.04.24.log created on April 24). For example, the command line osBatch aaa=bbb results in some console output, which also appears also in the log file, reporting that the parameter is invalid.

Session and Execution Environment parameters are used to control the behavior of a batch session. Refer to TIBCO Object Service Broker Parameters for detailed information about parameters. The values can be assigned to the osBatch parameters from the following sources (in order of precedence):


Source	Description	Precedence
Command line	Both Execution Environment and session parameters can be specified.	Highest
User options	Session parameters specified on the user’s profile screen.
Parameter file	Execution Environment parameters specified on the user’s profile screen.
Registry (Windows only)	Execution Environment and session parameters read from the Windows registry.
Environment variables	Execution Environment and session parameters read from environment variables.
Default values	Execution Environment and session parameters have reasonable default values. Note In most cases, you must override the parameters shown in the following table.	Lowest


Execution Environment Parameters Requiring Override	Description
DOB	Name of the Data Object Broker to which the Execution Environment connects.
USERID	user ID.
PASSWORD	User password.
RULE	Name of rule to be executed.
SEARCH	SEARCH defaults to S for SITE. If your rule is located in your local library, set SEARCH to L.
LIBRARY	Library that contains the rule to execute.
BATCHCONSOLE/ NOBATCHCONSOLE	BATCHCONSOLE: osBatch output (except for the copyright message followed by the parameter list) appears on the console as well as in the log files. NOBATCHCONSOLE: no output appears on the console, except for parameter syntax errors. Default: NOBATCHCONSOLE.
BROWSE/ NOBROWSE	If your rule updates database tables, set this to NOBROWSE. Default: NOBROWSE.

Parameters

To access parameter settings of parameter files, use the registry or environment variables NAME or EENAME.

To access session parameter settings, use the NAME parameter.

To access Execution Environment parameter settings, use the EENAME parameter.

Refer to TIBCO Object Service Broker Parameters for more information on parameters.

Example 1- Command Line

osBatch DOB=PROD U=JOEB P=XYZ123 R=BATCH1 SEARCH=L

NOBROWSE LIBRARY=PRODBATCH

Since the command line has the highest precedence, the values of the specified parameters are used during the execution of the batch session. Other Execution Environment and session parameters can be set in their respective DEFAULT configurations.

Example 2 - Session.prm file

osBatch NAME=BATCH2

Suppose the session.prm file contains the following:

NAME=BATCH2
EENAME=BATCHEE
USER=JOEB
P=XYZ123
R=BATCH1
SEARCH=L
NOBROWSE
LIBRARY=PRODBATCH

... and the ee.prm file contains the following:

NAME=BATCHEE
DOB=PROD

This execution of osBatch assigns the same values to the DOB, USER, PASSWORD, RULE, SEARCH, BROWSE and LIBRARY parameters as in Example 1.


	In Example 2, the source of the parameter assignments is the parameter file instead of the command line.

Example 3 - Command Line

osBatch NAME=BATCH2 DOB=TEST

If the ee.prm and session.prm are set as in Example 2, all the parameters are set to the same values they are assigned in Example 2 with the exception of the Data Object Broker parameter. Since the command line has the highest precedence, it overrides the value assigned from the ee.prm parameter file.