4 Installing the Gateway

The following topics describe how to install and configure the Oracle Database Gateway for APPC:

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 the following topics include 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 database and a single OLTP, perform the procedures described in the following topics.

Note:

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

Planning to Upgrade or Migrate the Gateway

If you have an earlier version of the Oracle Database 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 Database Gateway for APPC. If you have a previous gateway installation, then you will need to carry out specific tasks before you can install Oracle Database Gateway for APPC 12c Release 2 (12.2).

  • After reading this section, read 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 Database Gateway for APPC 12c Release 2 (12.2) from version 4.01 or earlier, then you will find specific material related to migration of the gateway in Migration from Existing Gateways.

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

Performing Pre-Upgrade Procedures

Perform the following steps to prepare for upgrading the 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 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 Database 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.

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

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 System Requirements.

  • Ensure that your security requirements are met.

    Refer to 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 Configuration Worksheet.

  • Decide on an SID (system identifier) for your gateway. This SID is used in Configuring the GatewayConfiguring 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 Server required for your platform. Refer to 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.

    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

Gateway Installation Methods

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

  1. 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.

  2. On a system different from a local Oracle database .
  3. 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 for Microsoft Windows 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 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.

Using Windows User Account as Oracle Home User

With Windows, you log in as a user with Administrator privileges to install the Oracle Database software. You can also specify an Oracle Home User (based on a low-privileged, non-administrative user account) during installation.

The following are the Windows User Accounts:

  • Windows Local User account

  • Windows Domain User account

  • Windows Managed Services Account (MSA)

  • Windows Built-in Account

See Also:

"Using Oracle Home User on Windows" in Oracle Database Platform Guide for Microsoft Windows

Installation Steps

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

Step 1: Log On to Windows System

Log on 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 for login information.

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".

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:

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

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 Database Gateway for APPC and the Oracle Universal Installer.

Step 5: Start the Oracle Universal Installer

To start the Oracle Universal Installer, run 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 6: Step Through the Oracle Universal Installer

Note:

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.

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 Oracle Database Gateway for APPC

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 Database Gateway 12.2, open up this row

c. Select Oracle Database Gateway for APPC 12.2. (Note that you may also choose to select other products to install besides the Oracle Database 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.

Note:

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 the configuration of the gateway.

Removing Your Oracle Database Gateway for APPC

The following topics describe 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 ORACLE_HOME\deinstall.

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

The script 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 noninteractive mode. This option requires a properties file that contains the configuration values for the Oracle home that is being deinstalled or deconfigured.

    To create a properties file and provide the required parameters, see the template file deinstall.rsp.tmpl, located in the response folder. If you prefer, instead of using the template file, you can generate a properties file by using the -checkonly option to have deconfig discover information from the Oracle home that you want to deinstall and deconfigure. The tool will generate the properties file, which you can then use with the -silent option.

  • -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.

  • -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\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 files

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

    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 optional flags

Removing Oracle Software

Complete the following procedure to remove Oracle software:

  1. Log in as a member of the Administrators group.
  2. Run the deinstall command, providing information about the Oracle System Identifier (SID), when prompted.