Oracle® GoldenGate

Installing, Configuring, and Upgrading Oracle GoldenGate Monitor Agent

12c (12.1.3)

E52750-05

April 2016

This document describes how to install, configure, and upgrade Oracle GoldenGate Agent.

Oracle GoldenGate Installing, Configuring, and Upgrading Oracle GoldenGate Monitor Agent 12c (12.1.3)

E52750-05

Copyright © 2011, 2016, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate failsafe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

Preface

- Audience

- Documentation Accessibility

- Related Documents

- Conventions

1 About Oracle GoldenGate Monitor Agent

- 1.1 Introduction to Oracle GoldenGate Monitor Agent

- 1.2 Installation Roadmap

- 1.3 Prerequisites

- 1.4 Downloading Oracle GoldenGate Monitor Agent

2 Installing and Configuring Oracle GoldenGate Monitor Agent

- 2.1 Installing Oracle GoldenGate Monitor Agent

- 2.1.1 Start the Installer

- 2.1.2 Install the Product

- 2.1.3 Install Available Patches

- 2.2 Creating and Configuring an Oracle GoldenGate Monitor Agent Instance

- 2.2.1 Create the Instance

- 2.2.2 Update the Configuration Properties

- 2.2.3 Create Wallet Credentials

- 2.2.3.1 Creating an Oracle GoldenGate Monitor Wallet

- 2.2.3.2 Creating an Oracle GoldenGate Enterprise Management Plug-In Wallet

- 2.2.4 Copy the SSL Certificate Files

- 2.2.5 Prepare the Oracle GoldenGate Monitor Agent Instance for Monitoring

- 2.2.6 Start the Oracle GoldenGate Monitor Agent

- 2.2.7 Check Oracle GoldenGate Monitor Agent Instance Log Files

3 Installing and Configuring Oracle GoldenGate Monitor Agent for z/OS and DB2 for i

- 3.1 Installing Oracle GoldenGate Monitor Agent for z/OS

- 3.2 Installing Oracle GoldenGate Monitor Agent for DB2 for i

- 3.3 Install Available Patches

- 3.4 Creating and Configuring an Oracle GoldenGate Monitor Agent Instance

- 3.4.1 Create the Instance

- 3.4.2 Update the Configuration Properties

- 3.4.3 Creating Secure Store Credentials

- 3.4.4 Copy the SSL Certificate Files

- 3.4.5 Prepare the Oracle GoldenGate Monitor Agent Instance for Monitoring

- 3.4.6 Start the Oracle GoldenGate Monitor Agent

- 3.4.7 Check Oracle GoldenGate Monitor Agent Instance Log Files

4 Upgrading Oracle GoldenGate Monitor Agent

A Installation Screens

- A.1 Welcome

- A.2 Installation Location

- A.3 Installation Type

- A.4 Prerequisite Checks

- A.5 Installation Summary

- A.6 Installation Progress

- A.7 Installation Complete

Preface

This document describes how to install and configure standalone Oracle GoldenGate Monitor Agent 12c (12.1.3). This document also provides detailed requirements and various design considerations when installing and configuring Oracle GoldenGate Monitor Agent as a standalone component.

Audience

This document is intended personnel installing, configuring, and running Oracle GoldenGate Monitor.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Related Documents

For more information, see the following documents in the Oracle GoldenGate Monitor 12c (12.1.3) documentation set:

- Administering Oracle GoldenGate Monitor

- Oracle GoldenGate Monitor Console Online Help

- Installing and Configuring Oracle GoldenGate Monitor Server

- Upgrading to Oracle GoldenGate Monitor 12.1.3

- Release Notes for Oracle GoldenGate Monitor

Conventions

The following text conventions are used in this document:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

1 About Oracle GoldenGate Monitor Agent

This chapter helps to prepare you for your Oracle GoldenGate Monitor Agent installation. Various topics are covered that should be reviewed thoroughly to help ensure that you do not encounter any problems either during or after the product installation and configuration. It contains the following sections:

- Section 1.1, "Introduction to Oracle GoldenGate Monitor Agent"

- Section 1.2, "Installation Roadmap"

- Section 1.3, "Prerequisites"

- Section 1.4, "Downloading Oracle GoldenGate Monitor Agent"

1.1 Introduction to Oracle GoldenGate Monitor Agent

Oracle GoldenGate Monitor Agent (formerly JAgent) collects information about an associated instance and sends it to the Oracle GoldenGate Monitor Server and Enterprise Manager Plug-In for Oracle GoldenGate. For Oracle GoldenGate release 11.2.1 and later, the Oracle GoldenGate Monitor Agent is a separate Java agent (sometimes referred to as a standalone agent) and has no C sub-agent.

The agent is a separate download and requires a separate installation process described in this document. You must install Oracle GoldenGate Monitor Agent 12c (12.1.3) to ensure full functionality and take advantage of all command and control features (for example, edit, stop, and display logs).

1.2 Installation Roadmap

Oracle GoldenGate Monitor Agent as a separate product from other components on the Oracle GoldenGate Management Pack. For all non-z/OS or DB2 for i platforms, you will use the Oracle Universal Installer (OUI). For the z/OS or DB2 for i platform you will use a set of separate binaries provided with the distribution and use these sections:

- Section 2.1, "Installing Oracle GoldenGate Monitor Agent"

- Section 3.1, "Installing Oracle GoldenGate Monitor Agent for z/OS"

- Section 3.2, "Installing Oracle GoldenGate Monitor Agent for DB2 for i"

Once the Oracle GoldenGate Monitor Agent product installation is successful, you need to create instances and configure their properties, based on the operating system and platform, as described in these sections:

- Section 2.2, "Creating and Configuring an Oracle GoldenGate Monitor Agent Instance" for non-z/OS and DB2 for i.

- Section 3.4, "Creating and Configuring an Oracle GoldenGate Monitor Agent Instance" for z/OS and DB2 for i.

1.3 Prerequisites

Before installing Oracle GoldenGate Monitor Agent ensure that the following prerequisites are met:

- Install the Oracle GoldenGate Core product. For database-specific installation instructions, see the Oracle GoldenGate for Windows and UNIX documentation library. For DB2 for i, Oracle GoldenGate Core release 12.2.0.1.0 is required. For Oracle database, see Fusion Middleware Installing and Configuring Oracle GoldenGate for Oracle Database.

- Install and configure Oracle GoldenGate Monitor if you are planning to monitor your Oracle GoldenGate instance using Oracle GoldenGate Monitor. For instructions, see Installing and Configuring Oracle GoldenGate Monitor Server.

- Install Oracle Enterprise Manager Plug-In for Oracle GoldenGate and deploy Oracle Enterprise Manager Plug-In for Oracle GoldenGate to monitor your Oracle GoldenGate instances. For instructions, see Oracle Enterprise Manager Oracle GoldenGate System Monitoring Plug-in Installation Guide.

- Install a supported Java Runtime Environment (JRE), such as JRE 1.7; Oracle GoldenGate Monitor Agent releases12.1.3.0.0 and 12.1.3.0.1 do not support JRE 1.8. For instructions, see the Java documentation for the release you are installing.

1.4 Downloading Oracle GoldenGate Monitor Agent

Download the Oracle GoldenGate Monitor Agent product from the Oracle Software Delivery Cloud website as follows:

1. Enter the Oracle Software Delivery Cloud link into a web browser:
http://edelivery.oracle.com/

2. Click Sign-in/Register.

Note:
If you are not already logged in, the Oracle Single Sign-On page appears. Enter your Oracle user id and password and click Sign In.

The Terms & Restrictions page appears.

3. Select the Oracle Software Delivery Cloud Trial License Agreement and the Export Restrictions check boxes, and then click Continue.
The Media Pack Search page appears.

4. On the Media Pack Search page, do the following:

1. From the Select Product Pack drop-down list, select Oracle Fusion Middleware.

2. From the Platform drop-down list, select the platform on which you are installing Oracle GoldenGate Monitor Agent.

3. Click Go.

The Results list expands to show all available media packs that include your search criteria.

5. Locate and select Oracle Fusion Middleware 12c Media Pack, and then click Continue.

6. Click the Download button next to Oracle Fusion Middleware 12c (12.1.3.0.0) GoldenGate Monitor and Veridata.

7. Browse to the directory where you want to save the file. Click Save to start the file download. A ZIP file is downloaded.

8. Extract the ZIP file to a temporary directory.

2 Installing and Configuring Oracle GoldenGate Monitor Agent

This chapter walks you through the process of installing and configuring Oracle GoldenGate Monitor Agent for all non-z/OS platforms (if you are installing Oracle GoldenGate Monitor Agent on a z/OS platform, see Chapter 3, "Installing and Configuring Oracle GoldenGate Monitor Agent for z/OS and DB2 for i").

This chapter contains the following sections:

- Section 2.1, "Installing Oracle GoldenGate Monitor Agent"

- Section 2.2, "Creating and Configuring an Oracle GoldenGate Monitor Agent Instance"

2.1 Installing Oracle GoldenGate Monitor Agent

Use the Oracle Universal Installer (OUI) to install Oracle GoldenGate Monitor Agent for all non-z/OS platforms. Perform the following steps:

1. Start the Installer

2. Install the Product

3. Install Available Patches

2.1.1 Start the Installer

To start the installation program:

1. Log in to the target system.

2. Go to the directory where you downloaded the installation program.

3. Launch the installation program by invoking java -jar from the JDK directory on your system, as shown in the following table:

For this O/S...

Use this command..

Unix

$ java -jar -Xmx1024m /path/to/jar/file/ogg_generic.jar

Windows

C:\ java -jar -Xmx1024m  ogg_generic.jar

When the installation program appears, you are ready to begin the installation. See Section 2.1.2, "Install the Product" for a description of each installation program screen.

2.1.2 Install the Product

To install the product, navigate through the Installer screens, providing the necessary information as described on the following table. This table lists the screens in the order they will appear and provides instructions for completing any necessary fields. If you want further information on any screen, click its name in the left-hand column.

Screen

Description

Installation Action

Welcome

This screen introduces you to the product installer.

Click Next.

Installation Location

On this screen, specify the location of your Oracle home directory.

1. Type or browse and select the Oracle Home location. This path will referred to as OGG_AGENT_ORA_HOME.

2. Click View to see the products installed under the selected Oracle Home.

3. Click Next.

Installation Type

On this screen, specify the type of installation you want to perform and thus, which products and features are installed.

1. Select Oracle Golden Gate Monitor Agent.

2. Click Next.

Prerequisite Checks

This screen analyzes the host computer to ensure that specific operating system prerequisites have been met.

Click Next.

Installation Summary

This screen contains a list of the feature sets you selected for installation, along with the approximate amount of disk space to be used by the feature sets once installation is complete.
Note: To display an individual component's approximate installed size, click its name.

Click Install.

Installation Progress

This screen shows the progress of the installation. When the progress bar reaches 100%, the installation is complete. Be aware that the Generating Libraries process can take up to 70% of the total installation time on some systems.

When the installation progress is 100%, click Next.

Installation Complete

This screen appears at the conclusion of the installation and provides a summary of the products and features that were installed.

Click Finish o dismiss the installer.
With this step, OUI installs the Oracle GoldenGate Monitor Agent binaries and configuration files, along with OUI specific file set, under OGG_AGENT_ORA_HOME.

2.1.3 Install Available Patches

1. Enter the My Oracle Support link into a web browser:
http://support.oracle.com

2. Click Sign In....

Note:
If you are not already logged in, the Oracle Single Sign-On page appears. Enter your Oracle user id and password and click Sign In.

The Dashboard page appears.

3. Click the Patches & Updates tab.

4. Search for Management Pack for Oracle GoldenGate patches for your operating system.

5. Download at least Patch 19916072.

6. Unzip the downloaded file.

7. Follow the instructions in the README.txt file, from the patch ZIP file, to verify that the patch is needed for your system and how to install the patch.

2.2 Creating and Configuring an Oracle GoldenGate Monitor Agent Instance

This section describes the procedures for creating and configuring an Oracle GoldenGate Monitor Agent instance for non-z/OS platforms. This process requires these six steps:

1. Create the Instance

2. Update the Configuration Properties

3. Create Wallet Credentials

4. Copy the SSL Certificate Files

5. Start the Oracle GoldenGate Monitor Agent

6. Check Oracle GoldenGate Monitor Agent Instance Log Files

Note:
These procedures are for non-z/OS applications. If you are installing Oracle GoldenGate Monitor Agent for the z/OS platform, see Section 3.4, "Creating and Configuring an Oracle GoldenGate Monitor Agent Instance".

2.2.1 Create the Instance

Go to the directory that contains the Oracle GoldenGate Monitor Agent creation script, create_ogg_agent_instance.sh. For example:

cd OGG_AGENT_BASE_HOME

Run the script:

./create_ogg_agent_instance.sh

The system responds:

Please enter absolute path of Oracle GoldenGate home directory :

Enter the absolute path to your Oracle GoldenGate home directory. For example, /u01/ogg/replication/oggcore1.

The system responds:

Please enter absolute path of OGG Agent instance :

Enter the directory that contains your Oracle GoldenGate Monitor Agent instance, which can be an existing directory. For example, /u01/ogg/agents/oggmon/agent1. This directory should be different than the Oracle GoldenGate home directory to avoid overwriting your Oracle GoldenGate Monitor Agent JAR and configuration files the next time you install or patch Oracle GoldenGate.

TheOracle GoldenGate Monitor Agent instance directory can be an existing directory location. In that case, you are prompted:

OGG Agent instance directory already exists, do you want to overwrite the contents (yes | no)".

If you choose yes, the execution of the script will continue and all the contents related to Oracle GoldenGate Monitor Agent will be overwritten on that location. If you choose no, the execution of the script will stop.

You can create additional instances using this same process though you must ensure that you create them in unique directories. For example, you might use /u01/ogg/replication/oggcore2 and /u01/ogg/agents/oggmon/agent2.

2.2.2 Update the Configuration Properties

Oracle GoldenGate Monitor Agent operates in one of two modes, Oracle GoldenGate Monitor Server or Oracle GoldenGate Enterprise Management Plug-In. You set the configuration properties for the mode you want to operate in using the following steps:

1. If you are using Oracle GoldenGate Monitor Server (not Oracle GoldenGate Enterprise Management Plug-In), copy the oggmon.properties file from the OGG_MONITORSERVER_DOMAIN/config/monitorserver/cfg directory to the OGG_AGENT_INST_HOME/cfg directory of all of your Oracle GoldenGate Monitor Agent Instances, where OGG_AGENT_INST_HOME is the absolute path to your Oracle GoldenGate Monitor Agent Instance.

2. Edit the OGG_AGENT_INST_HOME/cfg/Config.properties file.

3. Review and set the properties for one of the following modes:
Oracle GoldenGate Monitor (OGGMON):

jagent.host=

Use the default or change to the complete hostname or IP of the machine where Oracle GoldenGate Monitor Agent (jagent) is running.

jagent.jmx.port=

Use the default or change to your preferred port.

monitor.host=

Set to the hostname you set during your Oracle GoldenGate Monitor Server installation in monitor.properties.

monitor.jmx.port=

Set to the port you set during your Oracle GoldenGate Monitor Server installation in monitor.properties.

monitor.jmx.username=

Set to the user name you provided during your Oracle GoldenGate Monitor Agent installation

jagent.username=

Set a jagent user name.

agent.type.enabled=

Ensure it is set to OGGMON.

jagent.backward.compatibility=

Ensure it is set to false.

jagent.ssl=

Ensure it is set to false.

Or

Oracle GoldenGate Enterprise Management Plug-In (OEM):

jagent.host=

Use the default or change to the complete hostname or IP of the machine where Oracle GoldenGate Monitor Agent (jagent) is running.

jagent.username=

Set a jagent user name.

jagent.rmi.port=

Use the default or change to a specific port.

agent.type.enabled=

Set it to OEM.

jagent.backward.compatibility=

Ensure it is set to false.

jagent.ssl=

Ensure it is set to false.

4. Close and save the file.

The oggmon.properties file is required to create the wallet. For instructions, see "Edit Monitor Properties" in Installing and Configuring Oracle GoldenGate Monitor Server.

2.2.3 Create Wallet Credentials

Navigate to the OGG_AGENT_INST_HOME/bin directory, and then use one of the following sections to create the Oracle Wallet for your operating mode, Oracle GoldenGate Monitor or Oracle GoldenGate Enterprise Management Plug-In.

2.2.3.1 Creating an Oracle GoldenGate Monitor Wallet

1. Delete any existing dirwlt directory.

2. Ensure that the oggmon.properties file is copied into the cfg directory.

3. Start creating the wallet credentials:

For this Operating System

Use this command

Unix

$ ./pw_agent_util.sh  -create

Windows

C:\ pw_agent_util.bat  -create

4. Enter and confirm a user password for your jagent.username property.

Please create a password for Java Agent:
Please confirm password for Java Agent:

5. Enter and confirm a user password for your monitor.jmx.username property.

Please enter Monitor Server JMX password:

6. Please confirm Monitor Server JMX password:

The system responds:

Jan 06, 2014 5:17:22 PM oracle.security.jps.JpsStartup start
INFO: Jps initializing.
Jan 06, 2014 5:17:24 PM oracle.security.jps.JpsStartup start
INFO: Jps started.
Wallet is created successfully.

This creates the wallet cwallet.sso and cwallet.sso.lck files in dirwlt in the OGG_AGENT_INST_HOME/cfg directory.

2.2.3.2 Creating an Oracle GoldenGate Enterprise Management Plug-In Wallet

1. Start creating the wallet credentials:

For this Operating System

Use this command

Unix

$ ./pw_agent_util.sh  -jagentonly

Windows

C:\ pw_agent_util.bat  -jagentonly

2. Enter and confirm a user password for your jagent.username property.

Please create a password for Java Agent:
Please confirm password for Java Agent:

The system responds:

Jan 06, 2014 5:17:22 PM oracle.security.jps.JpsStartup start
INFO: Jps initializing.
Wallet is created successfully.

This creates the wallet cwallet.sso and cwallet.sso.lck files in dirwlt in the OGG_AGENT_INST_HOME directory.

2.2.4 Copy the SSL Certificate Files

Note:
This step is required only if the Oracle GoldenGate Monitor Agent is running in SSL mode.

Go to the OGG_AGENT_INST_HOME/dircrt and copy the Keystore and Truststore files.

After copying the keystore and truststore files, do the following:

1. Using the pw_agent_util.sh (or .bat, on Windows) utility, update the wallet with keystore and truststore passwords, as described in "Updating Oracle GoldenGate Monitor Agent Passwords" in Administering Oracle GoldenGate Monitor.

2. Update the jagent.keystore and jagent.truststore values in the config.properties file; for example:

jagent.keystore.file=jagentKeyStore
jagent.truststore.file=jagentTrustStore

Note:
If you are using a self-signed certificate, you can use the same file for both keystore file and truststore. If you are using a third-party signed certificate, you need to update your property file with the appropriate keystore and trust store files.

2.2.5 Prepare the Oracle GoldenGate Monitor Agent Instance for Monitoring

1. Create a file named GLOBALS in the OGG_HOME directory, if this file does not exist.

2. Edit the GLOBALS file.

3. Add ENABLEMONITORING on a new line.

4. Close and save the file.

5. Create the datastore using the CREATE DATASTORE command:
GGSCI> CREATE DATASTORE

Note:
All processes should be stopped before creating the datastore. You can also add autostart jagent to the mgr.prm file.

2.2.6 Start the Oracle GoldenGate Monitor Agent

Go to the Oracle GoldenGate Core GGSCI console and start Oracle GoldenGate Monitor Agent by executing the start jagent command:

GGSCI>start jagent

2.2.7 Check Oracle GoldenGate Monitor Agent Instance Log Files

Once you have completed the preceding steps and Oracle GoldenGate Monitor Agent is running, the Oracle GoldenGate Monitor Agent log details will be written to ogg_agent.log, which is in OGG_AGENT_INST_HOME/logs.

3 Installing and Configuring Oracle GoldenGate Monitor Agent for z/OS and DB2 for i

This chapter walks you through the process of installing and configuring Oracle GoldenGate Monitor Agent for the z/OS and DB2 for i platforms (if you are installing Oracle GoldenGate Monitor Agent on a non-z/OS or DB2 for i platform, see Chapter 2, "Installing and Configuring Oracle GoldenGate Monitor Agent").

This chapter contains the following sections:

- Section 3.1, "Installing Oracle GoldenGate Monitor Agent for z/OS"

- Section 3.2, "Installing Oracle GoldenGate Monitor Agent for DB2 for i"

- Section 3.3, "Install Available Patches"

- Section 3.4, "Creating and Configuring an Oracle GoldenGate Monitor Agent Instance"

3.1 Installing Oracle GoldenGate Monitor Agent for z/OS

The Oracle GoldenGate Monitor Agent product distribution contains the file ogg_agent-zos.tar, which you will use to install Oracle GoldenGate Monitor Agent on z/OS platforms. Use this procedure:

1. Create a directory to install Oracle GoldenGate Monitor Agent binaries; for this example, we will call that directory /apps/products/ogg-agent-zos-home/.

2. Navigate to /apps/products/ogg-agent-zos-home and untar ogg_agent-zos.tar:

$ tar xvf ogg_agent-zos.tar

You will see a new directory, ogg_agent-zos, under /apps/products/ogg-agent-zos-home/. This ogg_agent-zos directory contains all Oracle GoldenGate Monitor Agent binaries and its configuration and scripts files. On z/OS platforms, this directory (/apps/products/ogg-agent-zos-home/ogg_agent-zos) is your OGG_AGENT_BASE_HOME.

3.2 Installing Oracle GoldenGate Monitor Agent for DB2 for i

The Oracle GoldenGate Monitor Agent product distribution contains the file ogg_agent_generic.tar, which you will use to install Oracle GoldenGate Monitor Agent on DB2 for i platforms. Use this procedure:

1. Create a directory to install Oracle GoldenGate Monitor Agent binaries; for this example, we will call that directory /apps/products/ogg-agent-ibmi-home/

2. Navigate to /apps/products/ogg-agent-ibmi-home and untar ogg_agent_generic.tar:

$ tar xvf ogg_agent_generic.tar && rm ogg_agent_generic.tar

You will see all Oracle GoldenGate Monitor Agent binaries and its configuration and scripts files. On DB2 for i platforms, this directory (/apps/products/ogg-agent-ibmi-home) is your OGG_AGENT_BASE_HOME.

3.3 Install Available Patches

1. Enter the My Oracle Support link into a web browser:
http://support.oracle.com

2. Click Sign In....

Note:
If you are not already logged in, the Oracle Single Sign-On page appears. Enter your Oracle user id and password and click Sign In.

The Dashboard page appears.

3. Click the Patches & Updates tab.

4. Search for Management Pack for Oracle GoldenGate patches for your operating system.

5. Unzip the downloaded file.

6. Follow the instructions in the README.txt file, from the patch ZIP file, to verify that the patch is needed for your system and how to install the patch.

3.4 Creating and Configuring an Oracle GoldenGate Monitor Agent Instance

This section describes the procedures for creating and configuring an Oracle GoldenGate Monitor Agent instance. This process is comprised of these six steps:

1. Create the Instance

2. Update the Configuration Properties

3. Creating Secure Store Credentials

4. Copy the SSL Certificate Files

5. Start the Oracle GoldenGate Monitor Agent

6. Check Oracle GoldenGate Monitor Agent Instance Log Files

3.4.1 Create the Instance

Go to the directory that contains the Oracle GoldenGate Monitor Agent creation script:

cd OGG_AGENT_BASE_HOME

Run the script:

./createMonitorAgentInstance.sh

The system responds:

Please enter absolute path of Oracle GoldenGate home directory :

Enter the absolute path to your Oracle GoldenGate home directory. For example, /u01/ogg/replication/oggcore1.

The system responds:

Please enter absolute path of OGG Agent instance :

Enter the directory that contains your Oracle GoldenGate Monitor Agent instance, which can be an existing directory. For example, /u01/ogg/agents/oggmon/agent1. This directory should be different than the Oracle GoldenGate home directory to avoid overwriting your Oracle GoldenGate Monitor Agent JAR and configuration files the next time you install or patch Oracle GoldenGate.

The Oracle GoldenGate Monitor Agent directory can be an existing directory location. In that case, you are prompted:

OGG Agent instance directory already exists, do you want to overwrite the contents (yes | no)".

If you choose yes, the execution of the script will continue and all the contents related to Oracle GoldenGate Monitor Agent will be overwritten on that location. If you choose no, the execution of the script will stop.

The system responds:

Please enter unique name to replace timestamp in startMonitorAgent script (startMonitorAgentInstance_<TIMESTAMP>.sh) :

Enter the name you want to use to start your Oracle GoldenGate Monitor Agent instance. For example, startMonitorAgentInstance_production.sh.

3.4.2 Update the Configuration Properties

Oracle GoldenGate Monitor Agent operates in one of two modes, Oracle GoldenGate Monitor Server or Oracle GoldenGate Enterprise Management Plug-In. You set the configuration properties for the mode you want to operate in using the following steps:

1. Once you have completed the steps in the preceding sections, copy the oggmon.properties file from the OGG_MONITORSERVER_DOMAIN/config/monitorserver/cfg directory to the OGG_AGENT_INST_HOME/cfg directory of all of your Oracle GoldenGate Monitor Agent Instances.

2. Edit the OGG_AGENT_INST_HOME/cfg/Config.properties file.

3. Review and set the properties for one of the following modes:
Oracle GoldenGate Monitor (OGGMON):

jagent.host=

Use the default or change to the complete hostname or IP of the machine where Oracle GoldenGate Monitor Agent (jagent) is running.

jagent.jmx.port=

Use the default or change to your preferred port.

monitor.host=

Set to the hostname you provided during your Oracle GoldenGate Monitor Agent installation.

monitor.jmx.port=

Set to the port you provided during your Oracle GoldenGate Monitor Agent installation.

monitor.jmx.username=

Set to the user name you provided during your Oracle GoldenGate Monitor Agent installation

jagent.username=

Set a jagent user name.

agent.type.enabled=

Ensure it is set to OGGMON.

jagent.backward.compatibility=

Ensure it is set to false.

jagent.ssl=

Ensure it is set to false.

Or

Oracle GoldenGate Enterprise Management Plug-In (OEM):

jagent.host=

Use the default or change to the complete hostname or IP of the machine where Oracle GoldenGate Monitor Agent (jagent) is running.

jagent.username=

Set a jagent user name.

jagent.rmi.port=

Use the default or change to a specific port.

agent.type.enabled=

Set it to OEM.

jagent.backward.compatibility=

Ensure it is set to false.

jagent.ssl=

Ensure it is set to false.

4. Close and save the file.

The oggmon.properties file is required to create the wallet. For instructions, see "Edit Monitor Properties" in Installing and Configuring Oracle GoldenGate Monitor Server.

3.4.3 Creating Secure Store Credentials

Go to OGG_AGENT_INST_HOME/bin and run the wallet utility to store the Oracle GoldenGate Monitor Agent, Monitor Server JMX, and other passwords; for example:

$ ./pw_agent_util.sh  -create
Please create a password for Java Agent:
Please confirm password for Java Agent:
Please enter Monitor Server JMX password:
Please confirm Monitor Server JMX password:
Jan 06, 2014 5:17:22 PM oracle.security.jps.JpsStartup start
INFO: Jps initializing.
Jan 06, 2014 5:17:24 PM oracle.security.jps.JpsStartup start
INFO: Jps started.
Wallet is created successfully.

This step creates the password.properties file in the OGG_AGENT_INST_HOME/bin directory.

To create an Oracle GoldenGate Enterprise Management Plug-In Wallet:

1. Create the wallet credentials:
./pw_agent_util.sh -jagentonly

2. Enter and confirm a user password for your jagent.username property.

Please create a password for Java Agent:
Please confirm password for Java Agent:

The system responds:

Jan 06, 2016 5:17:22 PM oracle.security.jps.JpsStartup start
INFO: Jps initializing.
Wallet is created successfully.

This creates the wallet cwallet.sso and cwallet.sso.lck files in dirwlt in the OGG_AGENT_INST_HOME directory.

3.4.4 Copy the SSL Certificate Files

Note:
This step is required only if the Oracle GoldenGate Monitor Agent is running in SSL mode.

Go to the OGG_AGENT_INST_HOME/dircrt and copy the Keystore and Truststore files.

After copying the keystore and truststore files, do the following:

1. Using the pw_agent_util.sh (or .bat, on Windows) utility, update the wallet with keystore and truststore passwords, as described in "Updating Oracle GoldenGate Monitor Agent Passwords" in Administering Oracle GoldenGate Monitor.

2. Update the jagent.keystore and jagent.truststore values in the config.properties file; for example:

jagent.keystore.file=jagentKeyStore
jagent.truststore.file=jagentKeyStore

3.4.5 Prepare the Oracle GoldenGate Monitor Agent Instance for Monitoring

1. Create a file named GLOBALS in the OGG_HOME directory, if this file does not exist.

2. Edit the GLOBALS file.

3. Add ENABLEMONITORING on a new line.

4. Close and save the file.

5. Create the datastore using the CREATE DATASTORE command:
GGSCI> CREATE DATASTORE

Note:
All processes should be stopped before creating the datastore. You can also add autostart jagent to the mgr.prm file.

3.4.6 Start the Oracle GoldenGate Monitor Agent

Go to the Oracle GoldenGate Core GGSCI console, and start the Oracle GoldenGate Monitor Agent by executing the start jagent command:

GGSCI>start jagent

3.4.7 Check Oracle GoldenGate Monitor Agent Instance Log Files

Once you have completed the preceding steps and Oracle GoldenGate Monitor Agent is running, the Oracle GoldenGate Monitor Agent log details will be written to ogg_agent.log, which is in OGG_AGENT_INST_HOME/logs.

4 Upgrading Oracle GoldenGate Monitor Agent

This chapter describes the tasks you perform to install and upgrade Oracle GoldenGate Monitor Agent from 11g to 12c or when upgrading the original JAgent that was delivered with 12c.

Note:
Do not follow the instructions in this chapter if you have installed Oracle GoldenGate Monitor Agent 12c for the first time; the upgrade occurs automatically.

Use the following tasks to upgrade your existing Oracle GoldenGate Monitor Agent($OGG_HOME/dirjar) 11g to 12c:

- Task 1, "Obtain Oracle GoldenGate Monitor Agent"

- Task 2, "Backup the Existing Oracle GoldenGate Monitor Agent"

- Task 3, "Configuring the JRE"

- Task 4, "Installing Oracle GoldenGate Monitor Agent"

- Task 5, "Stopping JAgent"

- Task 6, "Create a New Instance"

- Task 7, "Copying Files to the New Agent Directories"

- Task 8, "Starting the Agent"

- Task 9, "Removing the Previous Oracle GoldenGate Monitor Agent Software"

Task 1   Obtain Oracle GoldenGate Monitor Agent

Obtain the product distribution by following the instructions in Section 1.4, "Downloading Oracle GoldenGate Monitor Agent."

Task 2   Backup the Existing Oracle GoldenGate Monitor Agent

Create a backup copy of your entire pre-upgrade Oracle GoldenGate Monitor Agent environment before you upgrade by copying the following to a backup location:

- OGG_HOME/cfg directory

- OGG_HOME/dirjar directory

- OGG_HOME/pw_agent_util.* files

- OGG_HOME/jagent.* files

- OGG_HOME/dirwlt directory

Task 3   Configuring the JRE

Configure your JRE as follows:

1. Set your $JAVA_HOME environment variable to use JRE 1.7 or greater.

2. Set $JAVA_HOME/bin first in your $PATH environment variable.

3. Verify that $JAVA_HOME and $JAVA_HOME/bin are setup correctly by running the following command:
java -version

The Java version is displayed and should be similar to the following:

java version "1.7.0_60"
Java(TM) SE Runtime Environment (build 1.7.0_60-b19)
Java HotSpot(TM) 64-Bit Server VM (build 24.60-b09, mixed mode)

Task 4   Installing Oracle GoldenGate Monitor Agent

Execute the OUI to install Oracle GoldenGate Monitor Agent:

java -jar -Xmx1024m /path/to/jar/file/fmw_12.1.3.0.0_ogg.jar

Install Oracle GoldenGate Monitor Agent in a separate, standalone location using the instructions in one of the following dependent on your database:

For non-z/OS platforms, use Section 2, "Installing and Configuring Oracle GoldenGate Monitor Agent."

For z/OS platforms, use Section 3, "Installing and Configuring Oracle GoldenGate Monitor Agent for z/OS and DB2 for i."

Task 5   Stopping JAgent

Go to the Oracle GoldenGate Core GGSCI terminal and stop the Oracle GoldenGate Monitor Agent by executing the stop jagent command:

GGSCI>stop jagent

Verify that there are no remaining jagent processes after by running the following command:

ps -ef |grep jagent

Use the kill -9 command to stop if any stray jagent processes.

Task 6   Create a New Instance

Create a new instance using the instructions in one of the following dependent on your operating system:

For non-z/OS platforms, use Section 2.2.1, "Create the Instance."

For z/OS platforms, use Section 3.4.1, "Create the Instance."

This modifies the $OGG_HOME/dirprm/jagent.prm file as in the following example:

COMMAND java -Dconfig.dir=/home/oracle/oggmon_agent/oggmon/cfg -Djava.util.logging.config.class=oracle.core.ojdl.logging.LoggingConfiguration -Doracle.core.ojdl.logging.config.file=/home/oracle/oggmon_
agent/oggmon/cfg/logging-config.xml -Doracle.core.ojdl.logging.componentId=JAGENT -jar -Xms512m -Xmx1024m /home/oracle/oggmon_agent/oggmon/ogg_agent/dirjar/jagent.jar

In this example, the jagent that will now be used is in /home/oracle/oggmon_agent/oggmon/ogg_agent/dirjar/jagent.jar and its configuration file is in the /home/oracle/oggmon_agent/oggmon/cfg directory.

Task 7   Copying Files to the New Agent Directories

Copy the existing $OGG_HOME/dirwlt directory, including all content, to the new Agent directory, $AGENT_HOME/oggmon/ogg_agent.

Copy the existing $OGG_HOME/cfg/Config.properties file into the new Agent directory, $AGENT_HOME/oggmon/cfg.

Task 8   Starting the Agent

Go to the Oracle GoldenGate Core GGSCI terminal and restart the Oracle GoldenGate Monitor Agent by executing the following commands:

stop manager
start manager
stop jagent
start jagent

Monitor the new Agent log file, $AGENT_HOME/logs/ogg_agent.log and resolve any issues.

If you are using the Oracle GoldenGate EM Plug-in, after jagent starts correctly you must restart the Oracle Enterprise Manager (OEM) Agent then login to the OEM 12c console to ensure that the out of sync status issues for Oracle GoldenGate registered targets are resolved.

Task 9   Removing the Previous Oracle GoldenGate Monitor Agent Software

Remove the previous Oracle GoldenGate Monitor Agent software that was bundled with Oracle GoldenGate Software by deleting the following:

- OGG_HOME/cfg directory

- OGG_HOME/dirjar directory

- OGG_HOME/pw_agent_util.* files

- OGG_HOME/jagent.* files

- (Optional) If you do not store anything related to Oracle GoldenGate Instance in Oracle Wallet, then delete the OGG_HOME/dirwlt directory.

A Installation Screens

This appendix contains images and descriptions of the Oracle GoldenGate-specific screens used by the Oracle Universal Installer (OUI). This information is contained in the following sections:

- Section A.1, "Welcome"

- Section A.2, "Installation Location"

- Section A.3, "Installation Type"

- Section A.4, "Prerequisite Checks"

- Section A.5, "Installation Summary"

- Section A.6, "Installation Progress"

- Section A.7, "Installation Complete"

A.1 Welcome

This screen introduces you to the product installer.

This page provides two important pieces of information:

- A navigation pane on the left that summarizes the tasks the installer will help you complete. Each item in the navigation pane represents a specific installer screen that will prompt you for information required to install the software.

- Information about any prerequisites you might need to perform before continuing with the installation.

Review the information on this screen carefully to be sure you have performed all the necessary prerequisites.

A.2 Installation Location

Use this screen to specify the location of your Oracle home directory.

If you have an existing directory into which one or more Oracle products have already been installed, that directory can be viewed in the drop-down list. You can see which products are installed in that particular directory by clicking View next to "Features Sets Installed at Selected Oracle Home."

If you want your product to be installed in a new directory, type the full path of your new directory in the Oracle Home field; the installer will create the specified directory for you.

If you are installing Oracle Fusion Middleware Infrastructure, then the Oracle Common home (oracle_common) directory will be created inside the specified Oracle home directory. The Oracle Common home contains services that are shared across all Oracle Fusion Middleware products.

A.3 Installation Type

Use this screen to specify the installation type, which defines which products and features are installed.

The options you see on this screen will differ depending on the product you are installing. For this product, select Oracle GoldenGate Monitor Agent.

A.4 Prerequisite Checks

This screen analyzes the host computer to ensure that specific operating system prerequisites have been met.

The following table describes the options on this screen:

Button

Description

Stop

Click this button to stop prerequisite checking for all components.

Rerun

Click this button if you have encountered any warning or error messages, addressed them appropriately, and want to try the prerequisite checking again.

Skip

Click this button to ignore any error or warning messages and continue with the installation.

View Successful Tasks

This check box is selected by default, and shows the list of tasks in the main part of the screen as they are completed.
De-select this check box if you do not want to see the list of tasks.

View Log

Click this button to open a separate window containing a detailed log file of the prerequisite checking.

A.5 Installation Summary

This screen contains a list of the feature sets you selected for installation, along with the approximate amount of disk space to be used by the feature sets once installation is complete.

You can click an individual component to display its approximate installed size.

Click Save Response File to save this configuration to a response file, which can be used later in a silent install situation. See Chapter 2, "Using the Oracle Universal Installer in Silent Mode" in Installing with the Oracle Universal Installer for more information about response file and silent installation.

A.6 Installation Progress

This screen shows the progress of the installation. When the progress bar reaches 100%, the installation is complete.

The following table describes the options on this screen.

Button

Description

View Messages

Click View Messages to see the installer messages at the bottom of the screen, where the billboard is located. Click the button again to return to the billboard.

View Successful Tasks

This check box is selected by default, and shows the list of tasks in the main part of the screen as they are completed.
De-select this check box if you do not want to see the list of tasks.

View Log

Click View Log to see the installer log; the log will be displayed in a separate window.

A.7 Installation Complete

This screen appears at the conclusion of the installation and provides a summary of the products and features that were installed.

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2016, Oracle and/or its affiliates. All rights reserved.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Private Alpha and Beta Draft Documentation Notice

If this document is in private preproduction status:

The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your beta trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.

This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Master Agreement, Oracle License and Services Agreement, Oracle PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement which has been executed by you and Oracle and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.