Setting Up Your Environment

This topic describes how to configure your CORBA application so that you can run the University sample applications.

The University sample applications use a database (the University database) to store all the data (for example, course names and course summaries) used in the sample applications. Before you can build and run the University sample applications, you need to install and set up the database.

For details about the setting up a database, see the product documentation for the database you are using.

System Prerequisites

To run the client applications in the University sample applications, you need the following development tools:

Editing the setenv and UBBCONFIG Files

You need to set several parameters in the setenv and UBBCONFIG files in order for the University sample applications to work properly, as follows:

The setenv file sets the system environment variables needed to build and run the sample applications. Each sample application directory contains a unique setenv file. The name of the setenv file designates which sample application the file is to be used with. For example, setenvb is for the Basic sample application. Each sample application directory contains a setenv file for the Windows and UNIX operating systems. For a list of the specific filenames for the setenv file, see Table 2-1.
The UBBCONFIG file is the configuration file for the sample application. The UBBCONFIG file defines parameters for how the client and server applications in the sample application should work. Each sample application directory contains a unique UBBCONFIG file. The name of the UBBCONFIG file designates which sample application the file is to be used with. For example, ubb_b is for the Basic sample application. Each sample application directory contains a UBBCONFIG file for the Windows and UNIX operating systems. For a list of the specific filenames for the UBBCONFIG file, see Table 2-1.

The information in the setenv and UBBCONFIG files must match. The following sections explain how to edit the setenv and UBBCONFIG files.

Naming Conventions for the setenv and UBBCONFIG Files

Table 2-1 describes the naming conventions for the setenv and UBBCONFIG files. The bold letter is the identifying letter for the sample application.

Table 2-1 Naming Conventions for `setenv` and `UBBCONFIG` Files
University Sample Application	Naming Convention
Basic	`setenvb.cmd`—the `setenv` file for Windows `setenvb.sh`—the `setenv` file for UNIX `ubb_b.nt`—the `UBBCONFIG` file for Windows `ubb_b.mk`—the `UBBCONFIG` file for UNIX
Security	`setenvs.cmd`—the `setenv` file for Windows `setenvs.sh`—the `setenv` file for UNIX `ubb_s.nt`—the `UBBCONFIG` file for Windows `ubb_s.mk`—the `UBBCONFIG` file for UNIX
Transactions	`setenvt.cmd`—the `setenv` file for Windows `setenvt.sh`—the `setenv` file for UNIX `ubb_t.nt`—the `UBBCONFIG` file for Windows `ubb_t.mk`—the `UBBCONFIG` file for UNIX
Wrapper	`setenvw.cmd`—the `setenv` file for Windows `setenvw.sh`—the `setenv` file for UNIX `ubb_w.nt`—the `UBBCONFIG` file for Windows `ubb_w.mk`—the `UBBCONFIG` file for UNIX
Production	`setenvp.cmd`—the `setenv` file for Windows `setenvp.sh`—the `setenv` file for UNIX `ubb_p.nt`—the `UBBCONFIG` file for Windows `ubb_p.mk`—the `UBBCONFIG` file for UNIX

Setting setenv Parameters

Table 2-2 Parameters in the `setenv` File
Parameter	Description
`APPDIR`	The directory path where you copied the sample application files. For example: Windows `APPDIR=c:\work\university\basic` UNIX `APPDIR=/usr/work/university/basic`
`TUXCONFIG`	The directory path and name of the configuration file. For example: Windows `TUXCONFIG=c:\work\university\basic\tuxconfig` UNIX `TUXCONFIG=/usr/work/university/basic/tuxconfig`
`TUXDIR`	The directory path where you installed the BEA Tuxedo software. For example: Windows `TUXDIR=c:\Tux8` UNIX `TUXDIR=/usr/local/Tux8`
`ORACLE_HOME`	The directory path where you installed the Oracle software. For example: Windows `ORADIR=c:\Orant` UNIX `ORACLE_HOME=/usr/local/oracle`
`TOBJADDR`	If you are using a CORBA C++ client application that does not reside on the same machine as the server application, enter the host and port of the machine where the server application runs. It must be specified exactly (including case) as it appears in the `UBBCONFIG` file for the machine. For example: `//BEANIE:2500`
`USERID`	If you are using a remote instance of the Oracle database, the format is as follows: USERID`=username/password@aliasname` This is the same information you defined when you set up a remote instance of the Oracle database. If you are using a local instance of the Oracle database, the format is as follows: USERID`=username/password`
`ORACLE_SID`	The instance ID of the Oracle database. On Windows, you do not need to specify the `ORACLE_SID`, the parameter automatically defaults to `ORCL`.
`CCMPL`	The directory location of the C compiler. This parameter is set to a typical installation directory. Verify that your installation matches this directory location and change the location if necessary. This parameter applies only to the UNIX operating system.
`CPPCMPL`	The directory location of the C++ compiler. This parameter is set to a typical installation directory. Verify that your installation matches this directory location and change the location if necessary. This parameter applies only to the UNIX operating system.
`CPPINC`	The directory location of the C++ include directory. This parameter is set to a typical installation directory. Verify that your installation matches this directory location and change the location if necessary. This parameter applies only to the UNIX operating system.
`SHLIB_PATH, LD_LIBRARY_PATH,` or `LIBPATH`	The directory location of the shared library. This parameter is set to a typical installation directory. Verify that your installation matches this directory location and change the location if necessary. This parameter applies only to the UNIX operating system.
`PROC`	The directory location of the Oracle Programmer C/C++ SQL Precompiler. You only need to specify this parameter if you are using the Windows operating system.
`PRODIR`	The directory location of the Oracle Programmer C/C++ SQL Precompiler. You only need to specify this parameter if you are using the Windows operating system.

Setting the UBBCONFIG Parameters

Table 2-3 Parameters in the `UBBCONFIG` File
Parameter	Description
`MY_SERVER_MACHINE`	Delete this parameter and replace it with the name of the server machine. On Windows, you can obtain the server machine name by entering the following command at the MS-DOS prompt: `set COMPUTERNAME` On UNIX, you can obtain the server machine name by entering the following command at the shell prompt: `prompt>uname -n` You must enter the server machine name exactly (including case) as it appears in the output of the command. Specify the server machine name as it appears. For example, `BEANIE`. Full names must be included in quotation marks. For example: `"beanie.bea.com"`.
`APPDIR`	The full directory path where you copied the sample application files. The directory path needs to be included in quotation marks. For example: Windows `APPDIR="c:\work\university\basic"` UNIX `APPDIR="/usr/work/university/basic"` This parameter needs to match the `APPDIR` parameter in the `setenv` file.
`TUXCONFIG`	The full directory path of the configuration file. This is the subdirectory of the sample application. The directory path needs to be included in quotation marks. For example: Windows `TUXCONFIG="c:\work\university\basic\tuxconfig"` UNIX `TUXCONFIG="usr/work/university/basic/tuxconfig"` This parameter needs to match the `TUXCONFIG` parameter in the `setenv` file.
`TUXDIR`	The full directory path where you installed the BEA Tuxedo software. The directory path needs to be included in quotation marks. For example: Windows `TUXDIR="c:\Tux8"` UNIX `TUXDIR="/usr/local/Tux8"` This parameter needs to match the `TUXDIR` parameter in the `setenv` file.
`CLOPT for the ISL process`	Enter the host name and port number of the machine on which the server application is installed. For example: `ISL` `SRVGRP = SYS_GRP` `SRVID =` `CLOPT = "-A --n //BEANIE:2500"`
`OPENINFO`	If you are using the Transactions, Wrapper, or Production sample applications, you need to specify this parameter for the Oracle database. If you are using a remote instance of the Oracle database, the OPENINFO parameter is specified as follows: `OPENINFO = "Oracle_XA:Oracle_XA+SqlNet=aliasname+Acc=P/account/password+SesTM=100+LogDir=.+MaxCur=5"` For example, on Windows: `OPENINFO = "Oracle_XA:Oracle_XA+SqlNet=ORCL+Acc=P/scott/ tiger+SesTM=100+LogDir=.+MaxCur=5"` If you are using a local instance of the Oracle database, the `OPENINFO` parameter is specified as follows: `OPENINFO = "Oracle_XA:Oracle_XA+Acc=P /account/password+SesTM=100+LogDir=.+MaxCur=5"` For example, on Windows: `OPENINFO = "Oracle_XA:Oracle_XA+Acc=P /scott/tiger+SesTM=100+LogDir=.+MaxCur=5"`

Running the setenv Command

Before you can use the University sample applications, you need to run the setenv script to ensure your system environment variables reflect all the changes made in the process of setting up the database and your configuration. Instructions for running the setenv command are included in the descriptions of building the individual sample applications.

Guide to CORBA University Sample Applications