Building an Environment

Each Environment represents a unit of software that implements one or more master index applications. You need to define and configure an Environment for the master index application before you can deploy the application. The clients that access the master index application should use the same Environment as the server project.

The following topics provide instructions for building an Environment for the master index application. For client projects that reference the master index server project, additional components might be required.

• Creating the Environment for a Master Index Application (Repository)

• Adding a Logical Host to a Master Index Environment (Repository)

• Adding Servers to a Master Index Environment (Repository)

• Adding an External System to a Master Index Environment (Repository)

• Adding a Database External System to the Master Index Environment (Repository)

Creating the Environment for a Master Index Application (Repository)

Once you create the Environment, you can add the necessary components. Perform the following steps to create an Environment for a master index project.

To Create an Environment

1. In NetBeans, open the Services window.
2. Right-click CAPS Environments, and then select New Environment.

   An Environment icon appears on the Services window.

3. Right–click the new Environment, and then click Rename.
4. Enter a unique name for the Environment, and then press Enter.

Adding a Logical Host to a Master Index Environment (Repository)

The Logical Host contains the servers that run the master index application and messaging services. You need to include a Logical Host in the Environment for all Oracle Java CAPS Master Index implementations.

To Add a Logical Host

1. Right-click the Environment for the project.
2. Point to New, and then select Logical Host.

   A Logical Host icon appears on the Services window.

3. Right–click the new Logical Host, and then click Rename.
4. Enter a unique name for the Logical Host, and then press Enter.

Adding Servers to a Master Index Environment (Repository)

Each Environment must include at least one application server and, if the master index server project uses a Topic, at least one message server. Perform the following steps to add a GlassFish Application Server and Java System Message Server to the Environment. You must have the GlassFish Application Server installed on your system in order to use this feature.

To Add Servers

1. In NetBeans, open the Services window.
2. To add a GlassFish Application Server, do the following:
   1. Right-click the Logical Host.
   2. Point to New, and then select Sun Java System Application Server.
   3. Right–click the new application server, and then click Rename.
   4. Enter a unique name for the application server, and then press Enter.
   5. Right-click the application server, and then select Properties.
   6. Enter the server’s URL, administrator login ID, and password.
3. To add a Java System Message Server, do the following:
   1. Right-click the Logical Host.
   2. Point to New, and then select Sun Java System Message Queue.
   3. Right–click the new message server, and then click Rename.
   4. Enter a unique name for the message server, and then press Enter.
   5. Right-click the message server, and then select Properties.
   6. Enter the server’s URL, administrator login ID, and password.

Adding an External System to a Master Index Environment (Repository)

External systems are required for projects that connect an external system to the master index application. The Connectivity Maps in these projects include External Applications that will be mapped to the external system. Perform the following steps to add an external system to the master index Environment.

To Add an External System

1. In NetBeans, open the Services window.
2. Right-click the master index Environment.
3. Point to New, and then select system_type External System, where system_type is the type of Adapter connecting the external system to Java CAPS (such as Oracle, SQL Server, File, and so on).
4. In the External System Name field, enter the name of the new external system and then click OK.
5. To configure the external system, right-click the new external system in the Environment, and then select Properties from the context menu.
6. Configure the properties as described in the Adapter documentation, and then click OK.
7. Repeat these steps for each external system defined in the projects that will be using this Environment.

Adding a Database External System to the Master Index Environment (Repository)

Either an Oracle or a SQL Server external system is required for master index server projects that connect to the database using a database Adapter. Optionally, the database connection can be handled by the application server. Perform the following steps to add a database external system to the master index Environment. If you are not using an Oracle or SQL Server Adapter, be sure to follow the instructions under Defining a Database Connection Pool Through the Application Server in Developing Oracle Java CAPS Master Indexes (Repository) to create a database connection pool.

To Add a Database External System

1. In NetBeans, open the Services window.
2. Right-click the master index Environment.
3. Point to New, and then select Oracle External System or Sqlserver External System.
4. In the External System Name field, enter a name for the new external system.
5. Click OK.
6. To configure the connection pool, right-click the new external system, and then select Properties.

   The Properties window appears.

7. Do one of the following:
   • For Oracle, expand Outbound Oracle eWay, and then select JDBC Connector Settings.
   • For SQL Server, expand Outbound Sqlserver non-Transactional Adapter, and then select JDBC Connector Settings.
8. Define the properties in the right portion of the window with information specific to the master index database you created. All properties are described in Configuring Project Components for Oracle Java CAPS Database Adapters.

   Be sure to only define the properties for the driver type you are using.

   ---

   Note - Creating the database is described in Creating the Master Index Database (Repository) in Developing Oracle Java CAPS Master Indexes (Repository). Use the information for that database for the properties on this window.

   ---

9. When you finish defining the properties, click OK to close the Properties window.