4 Installing the Gateway

This chapter describes how to install and configure the Oracle Database Gateway for APPC. It contains the following sections:

Before You Begin

Configuring an online transaction processor to allow access by the gateway requires actions on the 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 configuration actions on the OLTP might require you to restart the OLTP. Ensure that your host system programmer or DBA review the instructions for your OLTP before you restart it.

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

Note:

If your gateway uses the SNA communication protocol, then 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 follow the instructions for installation and configuration in this chapter, in Chapter 5, "Configuring Your Oracle Network", and in Chapter 11, "Gateway Configuration Using TCP/IP Communication Protocol".

Planning to Upgrade or Migrate the Gateway

This section is only for customers who have a previous release of Oracle Database Gateway for APPC. If you have a previous gateway installation, then you need to perform some tasks before you can install 12c Release 1 (12.1) of the Oracle Database Gateway for APPC.

Note:

After reading this section, you must read Chapter 13, "Migration From Existing Gateways" to determine the specific actions you must perform to prepare for upgrade or migration of your gateway. If you are migrating to Oracle Database Gateway for APPC 12c Release 1 (12.1) from version 4.01 or earlier, then you will find content related to migrating the gateway in Chapter 13, "Migration From Existing Gateways".

If you are installing Oracle Database Gateway for APPC for the first time, then begin with "Preinstallation Steps".

This section includes the following topics:

Preupgrade Procedures

Perform the following steps to prepare for upgrading the previous versions of Oracle Database Gateway for APPC to current versions:

  1. Make backups of altered PGA shipped files.

  2. Remove or rename any old gateway directories.

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 Data Dictionary (PG DD) contains all of its earlier entries without modification. New PGAU control information is added along with some columns to support new features, but no customer entries are altered by the upgrade.

  • All TIPs from Oracle Database Gateway for APPC release 4.0.1 or earlier must be recompiled because of the changes in the following:

    • PL/SQL compatibility

    • Gateway server RPC interface

    • UTL_PG interface

  • If you have existing TIPs that were generated previously on a gateway using the SNA communication protocol and you want to utilize the new TCP/IP feature, then 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 because the gateway assumes that the user exit in IMS Connect is being used, which would translate between the ASCII and EBCDIC character sets.

    Caution:

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

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

Preinstallation Steps

Before you install the gateway, perform the following pre-installation procedures:

  • Ensure that your system meets all of 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 Appendix D, "Configuration Worksheet".

  • Decide on a SID (system identifier) for your gateway. This SID is used in "Configuring the Gateway".

    The SID must be unique and must not be used by any other gateway or Oracle database 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 communication package appropriate for your platform.

    For more information about setting up and configuring the SNA communication package your platform needs to run the Oracle Database Gateway for APPC, refer to the appropriate chapter in this guide from the following list:

  • TCP/IP only: Your TCP/IP 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 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.

Gateway Installation Methods

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

  • On the same system as the existing Oracle database 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 database.

  • On the same system as the Oracle database, and in the same Oracle home directory. Note that in this case, the Oracle database and the gateway must be at the same Release level.

 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 and perform all necessary tasks there first.

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

Installation Steps

If you want to install the gateway in the same Oracle home as the Oracle database, then the release number of both products must be the same. This section provides the steps for installing the gateway. It contains the following topics:

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 use the Oracle Universal Installer to install the gateway on your platform:

Oracle Universal Installer on UNIX 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 UNIX 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 Inventory Directory and credentials

a. Specify the full path of the inventory directory.

b. Specify the operating system group name.

c. Click Next.

Oracle Universal Installer: Specify Home Details

a. Specify the name of the installation.

b. Specify the full path where you want to install the product.

c. Click Next.

Oracle Universal Installer: Available Product Components

a. Deselect the checked products.

b. Select "Oracle Database Gateway 12.1", open up this row.

c. Select "Oracle Database Gateway for APPC 12.1".

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 Configuration, 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 Finish.

Execute Configuration scripts

You must run the root.sh configuration script from the $ORACLE_HOME directory at this point. Leave the installation open, run the script as the root user from another window, then come back to the installation screen and click OK to continue.

Oracle Universal Installer: End of Installation

Click Exit.


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 $ORACLE_HOME/install directory. The default file name is make.log.

Attention:

Print the contents of the $ORACLE_HOME/dg4appc/doc/README.doc file and read the entire document; it contains important information about the installation. After reading the README.doc file, proceed with configuration of the gateway.

Deinstalling Oracle Database Gateway for APPC

This section describes how to remove Oracle Database Gateway from an Oracle home directory. It contains information about the following topics:

About the Deinstallation Tool

The Deinstallation Tool (deinstall) is available in the installation media before installation, and is available in Oracle home directories after installation. It is located in the path $ORACLE_HOME/deinstall.

The deinstall command stops Oracle software, and removes Oracle software and configuration files on the operating system.

The command uses the following syntax, where variable content is indicated by italics:

deinstall -home complete path of Oracle home [-silent] [-checkonly] [-local]
[-paramfile complete path of input parameter property file] [-params name1=value
name2=value . . .] [-o complete path of directory for saving files] [-help | -h]

The options are:

  • -silent

    Use this flag to run the command in silent or response file mode. If you use the -silent flag, then you must use the -paramfile flag, and provide a parameter file that contains the configuration values for the Oracle home that you want to deinstall or deconfigure.

    You can generate a parameter file to use or modify by running deinstall with the -checkonly flag. The deinstall command then discovers information from the Oracle home that you want to deinstall and deconfigure. It generates the properties file, which you can then use with the -silent option.

    You can also modify the template file deinstall.rsp.tmpl, located in the response folder.

  • -checkonly

    Use this flag to check the status of the Oracle software home configuration. Running the command with the -checkonly flag does not remove the Oracle configuration. The -checkonly flag generates a parameter file that you can use with the deinstall command.

  • -local

    Use this flag on a multinode environment to deconfigure Oracle software in a cluster.

    When you run deconfig with this flag, it deconfigures and deinstalls the Oracle software on the local node (the node where deconfig is run). On remote nodes, it deconfigures Oracle software, but does not deinstall the Oracle software.

  • -paramfile complete path of input parameter property file

    Use this flag to run deconfig with a parameter file in a location other than the default. When you use this flag, provide the complete path where the parameter file is located.

    The default location of the parameter file depends on the location of deconfig:

    • From the installation media or stage location: $ORACLE_HOME/inventory/response

    • From an unzipped archive file from Oracle Technology Network: /ziplocation/response

    • After installation from the installed Oracle home: $ORACLE_HOME/deinstall/response

  • -params [name1=value name 2=value name3=value . . .]

    Use this flag with a parameter file to override one or more values that you want to change in a parameter file you have already created.

  • -o complete path of directory for saving response files

    Use this flag to provide a path other than the default location where the properties file (deinstall.rsp.tmpl) is saved.

    The default location of the parameter file depends on the location of deconfig:

    • From the installation media or stage location before installation: $ORACLE_HOME/

    • From an unzipped archive file from Oracle Technology Network: /ziplocation/response/

    • After installation from the installed Oracle home: $ORACLE_HOME/deinstall/response

  • -help | -h

    Use the help option (-help or -h) to obtain additional information about the command option flags.

Removing Oracle Software

Complete the following procedure to remove Oracle software:

  1. Log in as the installation owner.

  2. Run the deinstall command, providing information about your servers as prompted.