4 Installing the Gateway

The following topics in this chapter describe how to install and configure the Oracle Procedural Gateway for APPC:

Before You Begin
Planning to Upgrade or Migrate the Gateway
Performing Preinstallation Procedures
Installing the Gateway Software
Installation Steps
Removing Your Oracle Procedural Gateway for APPC

4.1 Before You Begin

Configuring an online transaction processor to allow access by the gateway requires actions on the Online Transaction Processor (OLTP) and on certain components of the host operating system. Although no Oracle software is installed on the host system, access to, and some knowledge of, the host system and the OLTP are required. Although this chapter includes some information about host system and OLTP installation steps, you must ensure that you have the applicable OLTP and host system documentation available.

Some of the configuration actions on the OLTP might require you to restart the OLTP. In preparation for this, have your host system programmer or DBA review the instructions for your OLTP to allow for any necessary preparations.

To install and configure the gateway with a single Oracle Integrating Server and a single OLTP, perform the procedures described in this chapter.

Note:

If your gateway uses the SNA communication protocol, then you will follow the instructions for installation and configuration in this chapter, in Chapter 5, "Configuring Your Oracle Network" and in Chapter 9, "Gateway Configuration Using SNA Communication Protocol".

If your gateway uses the TCP/IP communication protocol, then you will follow the instructions for installation and configuration in this chapter, in Chapter 5, "Configuring Your Oracle Network" and in Chapter 10, "Gateway Configuration Using TCP/IP Communication Protocol".

4.2 Planning to Upgrade or Migrate the Gateway

If you have an earlier version of the Oracle Procedural Gateway for APPC installed on your system, then you may be upgrading or migrating to the current release. A gateway upgrade represents a minor software upgrade within a release, (for example, moving from Release 9.0 to Release 9.2.0) a gateway migration represents a significant change from one version number to another, (for example, migrating from Release 9.0 to 10.2).

This section is only for customers who have a previous release of Oracle Procedural Gateway for APPC. If you have a previous gateway installation, then you will need to carry out specific tasks before you can install Release 10.2.0.1.0 of the Oracle Procedural Gateway for APPC.

After reading this section, you will need to read Chapter 12, "Migration from Existing Gateways" to determine the specific actions you must take to prepare for upgrade or migration of your gateway. If you are migrating to Oracle Procedural Gateway for APPC Release 10.2.0.1.0 from version 4.01 or earlier, then you will find specific material related to migration of the gateway in Chapter 12, "Migration from Existing Gateways".

You may find it helpful to refer to Appendix D, "Summary of Changes in Previous Versions" for information about changes or corrected problems from earlier releases of the gateway.

If you are installing for the first time, then begin with "Performing Preinstallation Procedures".

4.2.1 Performing Pre-Upgrade Procedures

Perform the following steps to prepare for upgrading the Oracle Procedural Gateway for APPC to current versions:

Make backups of altered PGA shipped files.
Remove or rename any old gateway directories.

4.2.2 Upgrade and Migration Considerations

Upgrade considerations are as follows:

PGAU control files from Gateway Release 8 or 9 are upward-compatible, and you do not need to change them.
After upgrade, the PG DD contains all of its earlier entries without modification. New PGAU control information has been added along with some columns to support new features, but no customer entries are altered by the upgrade.
All TIPs from Oracle Procedural Gateway for APPC Release 4.0.1 or earlier must be recompiled, due to changes in the following:
- PL/SQL compatibility
- gateway server RPC interface
- UTL_PG interface
TCP/IP only: If you have existing TIPs that were generated previously on a gateway using the SNA communication protocol and you want to use the new TCP/IP feature, then the TIPs will have to be regenerated by PGAU with mandatory NLS_LANGUAGE and Side Profile Settings. Specify the appropriate ASCII character set in the DEFINE TRANSACTION command.

This is due to the fact that the gateway assumes that the appropriate user exit in IMS Connect is being used, which would translate between the appropriate ASCII and EBCDIC character sets.

Caution:
An upgraded PG Data Dictionary (PG DD) cannot be accessed by an earlier release of PGAU.

4.2.3 Restoration

If you want to restore a previous release of gateway, then you must restore the following components to their previous versions:

PGAU
PG DD
gateway server

4.3 Performing Preinstallation Procedures

Before you install the gateway, perform the following preinstallation procedures:

Ensure that your system meets all the hardware and software requirements specified in Chapter 3, "System Requirements".
Ensure that your security requirements are met.

Refer to Chapter 3, "System Requirements" for more information about the security requirements for connections and data access on your OLTP.
Fill out the worksheet identifying unique parameter names needed to configure your system and your chosen communication protocol (either SNA or TCP/IP), which is located in Chapter E, "Configuration Worksheet".
Decide on an SID (system identifier) for your gateway. This SID is used in Section 9.7, "Configuring the Gateway".

The SID must be unique and must not be used by any other gateway or Oracle Integrating Server on the system.
SNA only : Your SNA package must be installed and configured before you can proceed with installation of the gateway. Ensure that your system can communicate with the OLTP using the SNA Server required for your platform. Refer to Chapter 6, " Configuring the SNA Communication Package on Windows" for more information about setting up and configuring SNA for Windows.
TCP/IP only: Your TCP/IP package must be installed and configured before you can proceed with installation of the gateway. Refer to Chapter 7, "Configuring the TCP/IP Communications Package for IMS Connect" for more information about setting up and configuring TCP/IP for Windows.

Ensure that your system can communicate with the OLTP using the TCP/IP communication package for your platform.

If you need general information about installing Oracle products and using the Oracle Universal Installer, then refer to the Oracle Database Installation Guide for Microsoft Windows (32-Bit)

4.3.1 Gateway Installation Methods

You can install the gateway in either of the following ways:

On the same system as the existing Oracle Integrating Server but in a different directory.

All tasks for this type of installation or upgrade are discussed in this section.
On a system different from a local Oracle Integrating Server.
On the same system as the Oracle Integrating Server, and in the same Oracle home directory. Note that in this case, the Oracle Integrating Server and the gateway must be at the same release level.

4.4 Installing the Gateway Software

For general information about installing Oracle products and how to use the Oracle Universal Installer, refer to the Oracle Database Installation Guide for Microsoft Windows (32-Bit) and perform all necessary tasks there first.

If your server release is different than your gateway release, then do not install the gateway in the same Oracle home directory as the Oracle Integrating Server. This is required to isolate the gateway from the Oracle Integrating Server upgrades that might cause incompatibilities if the gateway executables were relinked with later versions of the Oracle server libraries.

4.5 Installation Steps

If you wish to install the gateway in the same Oracle home as the Oracle Integrating Server, then the release number of both products must be the same.

4.5.1 Step 1: Log On to Windows System

Logon to your Windows system as a member of the Administrators group. If you are not currently a DBA user, then contact your system administrator to create a DBA login user ID. Refer to the Oracle Database Installation Guide for Microsoft Windows (32-Bit) for login information.

4.5.2 Step 2: Ensure Minimum Amount of Disk Space

If you are installing the gateway for the first time, then ensure that there is enough space on the disk where the gateway will reside, as specified in"Disk Space Requirements".

4.5.3 Step 3: Stop All Oracle Services

Before beginning the gateway installation process, you must stop all Oracle services that are currently running. Follow these steps:

Click Start, then Settings, then Control Panel.
Select Services. A list of all Windows services appears.
Select an Oracle service (those services begin with Oracle).
Click Stop.
Continue to select and stop Oracle services until all active Oracle services are stopped.

4.5.4 Step 4: Insert the Gateway Product Installation Media

Verify that the drive is assigned to the logical drive you selected and that you can access files on the installation media.

Note:

The installation steps that follow assume that the installation media location is mapped to the D: drive.

The installation media package contains the Oracle Procedural Gateway for APPC and the Oracle Universal Installer.

4.5.5 Step 5: Start the Oracle Universal Installer

To start the Oracle Universal Installer, run setup.exe:

From the Start Menu, select Run.
Enter the path of the executable file name. For example:
```
D:\Disk1\setup.exe
```

4.5.6 Step 6: Step Through the Oracle Universal Installer

Caution:

Oracle Universal Installer automatically installs the Oracle-supplied version of the Java Runtime Environment (JRE). This version is required to run the Oracle Universal Installer and several Oracle assistants. Do not modify the JRE except by using a patch provided by Oracle Support Services. The Oracle Universal Installer also installs JDK.

Oracle Universal Installer is a menu-driven utility that guides you through installing the gateway by prompting you with action items. The action items and the sequence in which they appear depend on your platform.

The following section describes how to use the Oracle Universal Installer to install the gateway on your platform.

4.5.6.1 Oracle Universal Installer on Windows Platforms

Use Table 4-1 as a guide to step through the Oracle Universal Installer. At each prompt from the Oracle Universal Installer, perform the actions described in the Response column of the table to install the gateway on your Windows platform.

Table 4-1 The Oracle Universal Installer: Steps for Installing the Gateway

Prompt	Response
Oracle Universal Installer: Welcome	Click Next
Oracle Universal Installer: Specify Home Details	a. Specify the name of the installation. Specify the full path where you want to install the product Click Next
Oracle Universal Installer: Available Product Components	a. Deselect the checked products b. Select Oracle Transparent Gateway 10.2.0.1.0, open up this row c. Select Oracle Procedural Gateway for APPC 10.2.0.1.0. (Note that you may also choose to select other products to install besides the Oracle Procedural Gateway for APPC). d. Click Next
Oracle Universal Installer: Network Software	Specify your network package and click Next
Oracle Universal Installer: Summary	Click Install
Oracle Net Configuration Assistance: Welcome	Click Next
Oracle Net Configuration Assistance: Listener Configuration, Listener Name	Specify the name of Listener you want to create and click Next
Oracle Net Configuration Assistance: Listener Configutration, Select Protocols	Select the protocols and click Next
Oracle Net Configuration Assistance: Listener Configuration, TCP/IP Protocol	Specify a port number and click Next
Oracle Net Configuration Assistance:Listener Configuration, More Listeners?	Click No and then click Next
Oracle Net Configuration Assistance: Listener Configuration Done	Click Next
Oracle net Configuration Assistance: Naming Methods Configuration	Click No and then click Next
Oracle Net Configuration Assistance:Done	Click Yes
Oracle Universal Installer: End of Installation	Click Finish
Exit	Click Exit

Your gateway is now installed.

When the Oracle Universal Installer confirms that the installation is complete, verify that the installation procedure was successful. To do this, read the contents of the installation log file, which is located in the C:\Program Files\Oracle\Inventory\logs directory.

The default file name is InstallActionsYYYY-MM-DD_HH-mm-SS-AM/PM.log, where:

YYYY is year;

MM is month

DD is day

HH is hour

mm is minute

SS is seconds

AM/PM is daytime or evening

Each of these variables in the log file name represents the date and time the product was installed.

Attention:

Print the contents of the %ORACLE_HOME%\pg4appc\doc\README.doc file and read the entire document, it contains important information about the installation. After reading the README.doc file, proceed with the configuration of the gateway.

4.6 Removing Your Oracle Procedural Gateway for APPC

If you decide to remove the gateway, then perform the following steps:

Drop the PG DD (packages and procedures) as follows:
1. Use SQL*Plus to connect to the Oracle Integrating Server as user PGAADMIN.
2. From SQL*Plus, run the pgdddel.sql script in the %ORACLE_HOME%\pg4appc\admin directory.
Insert the gateway product installation media.
Start the Oracle Universal Installer by running the Oracle Universal Installer executable, setup.exe:
1. From the Start menu, select Run.
2. Enter the path of the executable file name. For example:
```
D: \Disk1\setup.exe
```

Step through the Oracle Universal Installer. Use the prompts listed in Table 4-2, "Steps to Remove the Gateway Using Oracle Universal Installer" as a guide for removal, following the instructions in the Response column.

Table 4-2 Steps to Remove the Gateway Using Oracle Universal Installer

Prompt	Response
1. Oracle Universal Installer:	Click Deinstall Products...
2. Inventory	Check the specified ORACLE_HOME name and click Remove.
3. Confirmation	Click Yes.
4. Inventory	Click Close.
5. Oracle Universal Installer	Click Cancel.
6. Exit	Click Yes.

The gateway is now removed.

When the Oracle Universal Installer confirms that the gateway is removed, verify that the removal procedure was successful. To do this, read the contents of the deinstallation log file, which is located in the C:\Program Files\Oracle\Inventory\logs directory.

The default file name is InstallActionsYYYY-MM-DD_HH-mm-SS-AM/PM.log, where:

YYYY is year;

MM is month

DD is day

HH is hour

mm is minute

SS is seconds

AM/PM is daytime or evening

Each of these variables in the log file name represents the date and time the product was removed.