G Oracle GoldenGate Installed Components

This appendix describes the programs, directories, and other components created or used by the Oracle GoldenGate software in the Oracle GoldenGate installation directory.

This appendix includes the following sections:

G.1 Oracle GoldenGate Programs and Utilities

This section describes programs installed in the root Oracle GoldenGate installation directory.

Note:

Some programs may not exist in all installations. For example, if only capture or delivery is supported by Oracle GoldenGate for your platform, the extract or replicat program will not be installed, respectively. Likewise, special files might be installed to support a specific database.

Table G-1 Oracle GoldenGate Installed Programs and Utilities

Program Description

convchk

Converts checkpoint files to a newer version.

convprm

Converts parameter files that do not use SQL-92 rules for quoted names and literals to updated parameter files that use SQL-92 rules. SQL-92 format for quoted object names and literals was introduced as the default with version 12c of Oracle GoldenGate.

defgen

Generates data definitions and is referenced by Oracle GoldenGate processes when source and target tables have dissimilar definitions.

emsclnt

Sends event messages created by Collector and Replicat on Windows or UNIX systems to EMS on NonStop systems.

extract

Performs capture from database tables or transaction logs or receives transaction data from a vendor access module.

ggmxinstall

Oracle GoldenGate installation script for the SQL/MX database.

ggcmd

Associated program of ggsci. Launches and monitors external applications, such as the JAGENT of Oracle GoldenGate Monitor. Integrates those applications into the GGSCI environment.

ggsci

User interface to Oracle GoldenGate for issuing commands and managing parameter files.

ggsmgr.jcl

ggsmgr.proc

ggsmgrst.jcl

ggsmgrst.proc

Start the Oracle GoldenGate Manager process from a batch job or the operator console on a z/OS system. Installed to support DB2 z/OS databases.

install

Installs Oracle GoldenGate as a Windows service and provides other Windows-based service options.

keygen

Generates data-encryption keys.

logdump

A utility for viewing and saving information stored in extract trails or files.

mgr

(Manager) Control process for resource management, control and monitoring of Oracle GoldenGate processes, reporting, and routing of requests through the GGSCI interface.

oggerr

Manages Oracle GoldenGate error messages.

replicat

Applies data to target database tables.

reverse

A utility that reverses the order of transactional operations, so that Replicat can be used to back out changes from target tables, restoring them to a previous state.

server

The Collector process, an Extract TCP/IP server collector that writes data to remote trails.

vamserv

Started by Extract to read the TMF audit trails generated by TMF-enabled applications. Installed to support the NonStop SQL/MX database.


G.2 Oracle GoldenGate Subdirectories

This Section describes the subdirectories of the Oracle GoldenGate installation directory and their contents.

Note:

Some directories may not exist in all installations.

Table G-2 Oracle GoldenGate Installed Subdirectories

Directory Description

br

Contains the checkpoint files for the bounded recover feature.

cfg

Contains the property and XML files that are used to configure Oracle GoldenGate Monitor.

dirdb

Contains the data store that is used to persist information that is gathered from an Oracle GoldenGate instance for use by the Oracle GoldenGate Monitor application or within Oracle Enterprise Manager.

dirchk

Contains the checkpoint files created by Extract and Replicat processes, which store current read and write positions to support data accuracy and fault tolerance. Written in internal Oracle GoldenGate format.

File name format is group_name+sequence_number.ext where sequence_number is a sequential number appended to aged files and ext is either cpe for Extract checkpoint files or cpr for Replicat checkpoint files.

Do not edit these files.

Examples:

ext1.cpe

rep1.cpr

dircrd

Contains credential store files.

dirdat

The default location for Oracle GoldenGate trail files and extract files that are created by Extract processes to store extracted data for further processing by the Replicat process or another application or utility. Written in internal Oracle GoldenGate format.

File name format is a user-defined two-character prefix followed by either a six-digit sequence number (trail files) or the user-defined name of the associated Extract process group (extract files).

Do not edit these files.

Examples:

rt000001

finance

dirdef

The default location for data definitions files created by the DEFGEN utility to contain source or target data definitions used in a heterogeneous synchronization environment. Written in external ASCII. File name format is a user-defined name specified in the DEFGEN parameter file.

These files may be edited to add definitions for newly created tables. If you are unsure of how to edit a definitions file, contact Oracle GoldenGate technical support.

Example:

defs.dat

dirdmp

Contains trace, or dump, files that support the internal activity logging mechanism.

dirjar

Contains the Java executable files that support Oracle GoldenGate Monitor.

dirpcs

Default location for status files. File name format is group.extension where group is the name of the group and extension is either pce (Extract), pcr (Replicat), or pcm (Manager).

These files are only created while a process is running. The file shows the program name, the process name, the port number, and the process ID.

Do not edit these files.

Examples:

mgr.pcm

ext.pce

dirprm

The default location for Oracle GoldenGate parameter files created by Oracle GoldenGate users to store run-time parameters for Oracle GoldenGate process groups or utilities. Written in external ASCII format. File name format is group name/user-defined name.prm or mgr.prm .

These files may be edited to change Oracle GoldenGate parameter values after stopping the process. They can be edited directly from a text editor or by using the EDIT PARAMS command in GGSCI.

Examples:

defgen.prm

finance.prm

dirrec

Not used by Oracle GoldenGate.

dirrpt

The default location for process report files created by Extract, Replicat, and Manager processes to report statistical information relating to a processing run. Written in external ASCII format.

File name format is group name+sequence number.rpt where sequence number is a sequential number appended to aged files.

Do not edit these files.

Examples:

fin2.rpt

mgr4.rpt

dirsql

Contains training scripts and any user-created SQL scripts that support Oracle GoldenGate.

dirtmp

The default location for storing transaction data when the size exceeds the memory size that is allocated for the cache manager. Do not edit these files.

dirwlt

Contains Oracle GoldenGate wallet files.

UserExitExamples

Contains sample files to help with the creation of user exits.


G.3 Other Oracle GoldenGate Files

This section describes other files, templates, and objects created or installed in the root Oracle GoldenGate installation directory.

Note:

Some files may not be installed in your environment, depending on the database and OS platform.

Table G-3 Other Oracle GoldenGate Installed Files

Component Description

bcpfmt.tpl

Template for use with Replicat when creating a run file for the Microsoft BCP/DTS bulk-load utility.

bcrypt.txt

Blowfish encryption software license agreement.

cagent.dll

Contains the Windows dynamic link library for the Oracle GoldenGate Monitor C sub-agent.

category.dll

Windows dynamic link library used by the INSTALL utility.

chkpt_db_create.sql

Script that creates a checkpoint table in the local database. A different script is installed for each database type.

db2cntl.tpl

Template for use with Replicat when creating a control file for the IBM LOADUTIL bulk-load utility.

ddl_cleartrace.sql

Script that removes the DDL trace file. (Oracle installations)

ddl_ddl2file.sql

Script that saves DDL from the marker table to a file.

ddl_disable.sql

Script that disables the Oracle GoldenGate DDL trigger. (Oracle installations)

ddl_enable.sql

Script that enables the Oracle GoldenGate DDL trigger. (Oracle installations)

ddl_filter.sql

Script that supports filtering of DDL by Oracle GoldenGate. This script runs programmatically; do not run it manually.

ddl_nopurgeRecyclebin.sql

Empty script file for use by Oracle GoldenGate support staff.

ddl_ora11.sql

ddl_ora12.sql

Scripts that run programmatically as part of Oracle GoldenGate DDL support; do not run these scripts.

ddl_pin.sql

Script that pins DDL tracing, the DDL package, and the DDL trigger for performance improvements. (Oracle installations)

ddl_purgeRecyclebin.sql

Script that purges the Oracle recycle bin in support of the DDL replication feature.

ddl_remove.sql

Script that removes the DDL extraction trigger and package. (Oracle installations)

ddl_session.sql

ddl_session1.sql

Supports the installation of the Oracle DDL objects. This script runs programmatically; do not run it manually.

ddl_setup.sql

Script that installs the Oracle GoldenGate DDL extraction and replication objects. (Oracle installations)

ddl_status.sql

Script that verifies whether or not each object created by the Oracle GoldenGate DDL support feature exists and is functioning properly. (Oracle installations)

ddl_staymetadata_off.sql

ddl_staymetadata_on.sql

Scripts that control whether the Oracle DDL trigger collects metadata. This script runs programmatically; do not run it manually.

ddl_trace_off.sql

ddl_trace_on.sql

Scripts that control whether DDL tracing is on or off.

ddl_tracelevel.sql

Script that sets the level of tracing for the DDL support feature. (Oracle installations)

debug files

Debug text files that may be present if tracing was turned on.

demo_db_scriptname.sql
demo_more_db_scriptname.sql

Scripts that create and populate demonstration tables for use with tutorials and basic testing.

.dmp files

Dump files created by Oracle GoldenGate processes for tracing purposes.

ENCKEYS

User-created file that stores encryption keys. Written in external ASCII format.

exitdemo.c

User exit example.

exitdemo_utf16.c

User exit example that demonstrates how to use UTF16 encoded data in the callback structures for information exchanged between the user exit and the process.

freeBSD.txt

License agreement for FreeBSD.

ggmessage.dat

Data file that contains error, informational, and warning messages that are returned by the Oracle GoldenGate processes. The version of this file is checked upon process startup and must be identical to that of the process in order for the process to operate.

ggserr.log

File that logs processing events, messages, errors, and warnings generated by Oracle GoldenGate.

ggsmsg.dll

Windows dynamic link library used by the install program.

GLOBALS

User-created file that stores parameters applying to the Oracle GoldenGate instance as a whole.

help.txt

Help file for the GGSCI command interface.

icudtxx.dll

icuinxx.dll

icuucxx.dll

Windows shared libraries for International Components for Unicode, where xx is the currently used version.

jagent.bat

Windows batch file for the Java Agent for Oracle GoldenGate Monitor.

jagent.log

jagentjni.log

Log files for the Oracle GoldenGate Monitor Agent.

jagent.sh

UNIX shell script for the Java Agent for Oracle GoldenGate Monitor

LGPL.txt

Lesser General Public License statement. Applies to free libraries from the Free Software Foundation.

libodbc.so

ODBC file for Ingres 2.6 on UNIX.

libodbc.txt

License agreement for libodbc.so.

libxml2.dll

Windows dynamic link library containing the XML library for the Oracle GoldenGate XML procedures.

libxml2.txt

License agreement for libxml2.dll .

marker.hist

File created by Replicat if markers were passed from a NonStop source system.

marker_remove.sql

Script that removes the DDL marker table. (Oracle installations)

marker_setup.sql

Script that installs the Oracle GoldenGate DDL marker table. (Oracle installations)

marker_status.sql

Script that confirms successful installation of the DDL marker table. (Oracle installations)

notices.txt

Third-party software license file.

odbcinst.ini

Ingres 2.6 on UNIX ODBC configuration file.

params.sql

Script that contains configurable parameters for DDL support. (Oracle installations)

pthread-win32.txt

License agreement for pthread-VC.dll .

pthread-VC.dll

POSIX threads library for Microsoft Windows.

prvtclkm.plb

Supports the replication of Oracle encrypted data.

pw_agent_util.bat

pw_agent_util.sh

Script files that support the Oracle GoldenGate Monitor Agent.

role_setup.sql

Script that creates the database role necessary for Oracle GoldenGate DDL support. (Oracle installations)

sampleodbc.ini

Sample ODBC file for Ingres 2.6 on UNIX.

sqlldr.tpl

Template for use with Replicat when creating a control file for the Oracle SQL*Loader bulk-load utility.

start.prm

stop.prm

z/OS paramlib members to start and stop the Manager process.

startmgr

stopmgr

z/OS UNIX System Services scripts to start the Manager process from GGSCI.

startmgrcom

stopmgrcom

z/OS system input command for the Manager process.

tcperrs

File containing user-defined instructions for responding to TCP/IP errors.

usrdecs.h

Include file for user exit API.

xerces-c_2_8.dll

Apache XML parser library.

zlib.txt

License agreement for zlib compression library.


G.4 Oracle GoldenGate Checkpoint Table

When database checkpoints are being used, Oracle GoldenGate creates a checkpoint table with a user-defined name in the database upon execution of the ADD CHECKPOINTTABLE command, or a user can create the table by using the chkpt_db_create.sql script (where db is an abbreviation of the type of database that the script supports). For a description of this table, see Administering Oracle GoldenGate for Windows and UNIX.