A Oracle Oracle GoldenGate Components

Here we discuss components of Oracle GoldenGate code used for customer implementations, such as programs, utilities, macros, libraries, and databases. There are also templates, demos, and sample code.

This the following:

Programs, Utilities, Macros, and Libraries

Program/Macro	Description
AUDDUMP	A utility program to print the contents of the AUDCFG or GGSCPUxx segments.
AUDSERV	Reads audited database changes from TMF audit trails. Started by Extract processes. Must be owned by SUPER group and must have a PROG ID and license for other users to extract changed data from the audit trails.
BASELIB	The intercept library that is bound with programs to facilitate non-TMF based database change logging. The TNS mode can be used with programs written in TAL, and C.
BASELIBN	Native version of BASELIB that can be used with TAL, C, C++, and Java VM. On the operating systems, this library can be also be used with native COBOL programs.
BINDEXIT	TACL macro that merges Extract and Replicat with user exit routines.
BINDSKEL	TACL macro that merges BASELIB with the BASE24 SKELB library.
CHGNOTE	Notifies GGSLIB of configuration changes.
COMBLIB	A macro that combines the Oracle GoldenGate intercept library GGSLIB with a User Library that intercepts the same calls as Oracle GoldenGate.
COORDINATOR	Tracks the status of distributed network transactions to coordinate the processing across multiple nodes.
DBINIT	A macro that initializes the Oracle GoldenGate checkpoint and configuration files.
DDLGEN	Generates target database table definitions based on NonStop DDL.
DEFGEN	Generates source table definitions for Replicat to use for the translation of heterogeneous databases.
EMSDIST	Contains EMS messaging and tokens for Oracle GoldenGate messages.
EMSINST	A macro that installs EMS event message detail text.
ENTRYLIB	A macro that combines the Oracle GoldenGate intercept library BASELIBE with a User Library that intercepts the same calls as GGSLIB.
EVCXFUP	Contains the FUP scripts to create the EVENTCX file for custom EMS messages.
EXTRACT	Performs database change extract; formats and outputs results.
EXTRACTN	Native version of Extract.
EXTRR	Native relinkable version of Extract. Use when you have a native user exit to be linked into Extract. The NLDEXIT macro will reference this program.
FIXFLS	Adjusts alternate key pointers and turns auditing on proper Oracle GoldenGate files (for example, after duplicating from another location).
FUPLOG	Contains the FUP scripts to create the Logger configuration file LOGCONF.
GGSCI	User interface to Oracle GoldenGate functions.
GGSDLL	The default name of the executable version of native BASELIB for applications running on the operating systems. NLDLIB may combine BASELIB with other relinkables when creating GGDLL.
GGSLIB	User library bound with application programs to facilitate non-TMF based database change extract.
GGSLIBR	Native relinkable version of GGSLIB that can be combined with other code to create a larger combined user library.
GGSUNPAK	A macro that performs the UNPAK against Oracle GoldenGate installation files and runs the installation macro.
INSTALL	TACL macro that creates database files and performs other installation tasks.
KEYGEN	Program used to generate random keys. Used for encryption.
LEANBIND	A macro that removes the several routines out of BASELIB and creates LEANLIB. Use in place of BASELIB; however, you must contact Technical Support at Oracle GoldenGate before proceeding.
LOGDUMP	A program that provides the ability to display or search for information stored in log trails, extract trails, or extract flat files.
LOGDUMPA	A program that provides the same usage as LOGUDMP, but this must be used to access AES encrypted files.
LOGGER	Writes non-TMF audited database changes to log trails.
MGR	Carries out resource management functions as configured by system administrators.
MIGRATE	Moves checkpoint and other data from an old to a new Oracle GoldenGate installation.
NLDEXIT	A macro used to combine a native version of the intercept libraries.
NLDLIB	A macro used to create a native version of the intercept libraries.
REPLICAT	Replicates selected database changes from a set of source Enscribe files and SQL tables to a set of target files and tables.
REPR	A relinkable, native version of Replicat. Used when linking native user exits.
SCANGRP	A utility used by the MIGRATE utility to scan and convert group records.
SEGDUMP	A utility program used to examine the contents of the private context segment maintained by BASELIB. The context segment contains I/O buffers and state information for all files being logged.
SERVER	Another name for the Collector that receives data over TCP/IP and writes data to remote trails.
SFGEXIT	A program that can be activated within NonStop Safeguard to audit update access file opens and issue a message if no Oracle GoldenGate intercept program is bound in.
SQLCOMPS	List of SQLCOMP commands for Oracle GoldenGate programs.
SYNCFILE	Performs file replication of non-database files based on a user-set schedule.
TMFARLB2	A distributed TMF audit read library.
TMFARUL2	A distributed TMF audit read library.

Oracle GoldenGate Database

The Oracle GoldenGate database is created at installation time with the INSTALL macro. Each database file and its function are listed in the next table.

Database File	Description
AUDCFG	A dynamically created shared segment file used for GGSLIB configuration retrieval.
AUDSPEC	Contains audit management configuration parameters set up with GGSCI and read by Manager to perform audit management tasks.
CONTEXT	Contains Extract checkpoints to facilitate continuous processing of audit for particular Extract groups. Used by Manager to determine whether particular audit resources are still required.
EXTCTXT	Contains Extract checkpoints to track restart points within extract files in case Extract halts prematurely. Also contains information about individual extract trail dimensions and management.
EXTCTXT0	Alternate key file for EXTCTXT.
GROUP	Contains each distinct Extract processing group.
LOGCONF	Stores logger configuration.
LOGGGS	Keeps log of critical events.
MRKRGGS	Audited file that accepts audit marker records.
REMCTXT	Contains the names of local and remote REPCTXT files to check before deleting extract files.
REPCTXT	Contains Replicat checkpoints to facilitate continuous processing of extract information. Used by Manager to determine whether particular extract file resources are still required.
REPCTXT0	Alternate key file for REPCTXT.
REPGRP	Contains each distinct Replicat processing group.
RMTCTXT	Contains checkpoints for remote extract files.
SYNCGRP	Contains each distinct Syncfile processing group.

External Component Summary

Component	Description
TMF Audit Trails	Contain change data information for source file and table insert, update and delete operations. Audit trails are read by Extract processes with Audserv for relevant database changes. Each audit trail can be read from one of four locations: the original location (on disk), from a disk dump, restored to disk from tape, or from a duplicate created by Manager.
Extract Files	Created by Extract processes. Extract files contain formatted database change records that can be input to Replicat processes, user-written applications or utilities. Extract processes can write to a single extract file, or a sequence of extract files known as extract trails. Manager purges extract files.
SQL and Enscribe Database Files	Database files that are the source of extract and target of delivery activities.
Parameter Files	Parameter files provide run-time parameters for all Oracle GoldenGate processes. There is no facility for entering parameters interactively, so parameter files are required.
Report Files	Extract and Replicat generate reports detailing statistical highlights of processing. Report files can be virtually any format, including spooler, edit files or the home terminal.
DDL Dictionaries	Dictionaries are an optional component of Extract and Replicat processing. DDL dictionaries describe Enscribe records processed by Extract and Replicat. This lets you describe record selection and column mapping criteria for both Extract and Replicat activities. The dictionaries must have been compiled using C30 or later DDL.
SQL Catalogs	Provide the definition of extracted SQL database change records. You need read access to the catalog associated with any source and target SQL tables. The catalogs allow Extract and Replicat to decode audit records and to build replicate SQL operations.
User Exit Routines	Object files you create that are bound in with Extract or Replicat to perform customized routines.
Error Console	Extract and Replicat send errors and warnings to both the error console and to the report file. The default error console is the home terminal. You can change the error console with the statement PARAMS EMSLOG EMS_collector before issuing the run command for either program. filename can include EMS distributors, processes, disk or spooler files.

Templates, Demonstrations, and Sample Code

File	Description
DDLEXIT	DDL for creating copy files for user exit and API routines.
DEMOCL	C include library for user exit demos.
DEMOCOBL	COBOL copy library for user exit demos.
DEMOEDDL	Sample DDL scripts for sample Enscribe files.
DEMOFUPS	Sample FUP scripts to create sample Enscribe source files.
DEMOFUPT	Sample FUP scripts to create sample Enscribe target files.
DEMOOLDE	Source code for the DEMOLEDO Enscribe demo program that performs inserts and updates for sample files.
DEMOLDEO	Program used to generate insert and update operations for sample Enscribe files.
DEMOLDS	Sample data for tables created by DEMOSQL.
DEMOSQL	SQL table creation DDL for sample TMF delivery User Tutorial example.
DEMOXC	An example user exit written in C.
DEMOXCOB	An example user exit written in COBOL.
HELP	Help file for GGSCI.
TCPERRS	Contains TCP/IP error handling parameters.
TMPLMSA	DDLGEN template file for Microsoft Access.
TMPLMSS	DDLGEN template file for Microsoft SQL Server.
TMPLORA	DDLGEN template file for Oracle.
TMPLTDM	DDLGEN template file for Non Stop NS SQL.
TMPLSYB	DDLGEN template file for Sybase.
TMPLDB2	DDLGEN template file for DB2 on Windows and UNIX.
TMPLDB2M	DDLGEN template file for DB2 on z/OS and OS/390.
USEREXC	Blank template that can be used as a starting point for C user exits.
USEREXT	Blank template that can be used as a starting point for TAL user exits.
XLIBC	Include library for writing C user exits and interfacing to API.
XLIBCOB	Copy library for writing COBOL user exits and interfacing to API.