6.1 Summary of Oracle GoldenGate Parameters

This section summarizes the Oracle GoldenGate parameters by module and purpose and includes the following topics:

Topics:

6.1.1 Summary of GLOBALS Parameters

The GLOBALS file stores parameters that relate to the Oracle GoldenGate instance as a whole, as opposed to runtime parameters for a specific process.

Table 6-1 All GLOBALS Parameters

Parameter	Description
`ALLOWOUTPUTDIR`	Use to `ALLOWOUTPUTDIR` specify the allowed output trail directory (including its subdirectories) through `\u000b`.
`ALLOWNULLABLEKEYS \| NOALLOWNULLABLEKEYS`	Use `ALLOWNULLABLEKEYS` to change the key selection logic so that it does not consider a nullable unique key.
`CACHEMGR`	Manages virtual memory resources.
`CHARMAP`	Specifies that the character mapping file overrides the character code point mapping.
`CHARSET`	Specifies a multibyte character set for the process to use instead of the operating system default when reading the parameter file.
`CHECKPOINTTABLE`	Specifies a default checkpoint table.
`CREDENTIALSTORELOCATION`	Specifies the location of the Oracle GoldenGate credential store that stores login credentials.
`CRYPTOENGINE`	Selects which cryptographic library will the OGG processes use to provide implementation of security primitives.
MARKERTABLE	Controls the name of the masterkey that Oracle GoldenGate processes in a deployment will use to retrieve the key from the wallet.
`DDLTABLE`	Specifies a non-default name for the DDL history table that supports DDL synchronization for Oracle.
`ENABLE_HEARTBEAT_TABLE \| DISABLE_HEARTBEAT_TABLE`	Enables the processing of heartbeat tables.
`ENABLEMONITORING`	Enables Oracle GoldenGate Monitor to view and monitor Oracle GoldenGate instances.
`EXCLUDEWILDCARDOBJECTSONLY`	Includes non-wildcarded source tables when a `TABLEEXCLUDE`, `SCHEMAEXCLUDE`, or `CATALOGEXCLUDE` parameter contains a wildcard.
`GGSCHEMA`	Specifies the name of the schema that contains the database objects that support heartbeat tables and DDL synchronization for Oracle.
`HEARTBEATTABLE`	Specifies the name of the heartbeat table.
`MARKERTABLE`	Specifies a non-default name for the DDL marker table that supports DDL synchronization for Oracle.
`MAXGROUPS`	Specifies the maximum number of process groups that can run in an instance of Oracle GoldenGate.
`MGRSERVNAME`	Specifies the name of the Manager process when it is installed as a Windows service.
`NAMECCSID`	Specifies a DB2 for i CCSID if the object names in the SQL catalog are of a different CCSID than the system.
`NODUPMSGSUPPRESSION`	Prevents the automatic suppression of duplicate informational and warning messages.
`OUTPUTFILEUMASK`	Specifies a umask that can be used by Oracle GoldenGate processes to create trail files and discard files.
`TRAILBYTEORDER`	Specifies the byte order (endianness) of a file created with the `EXTFILE`, `RMTFILE`, `EXTTRAIL`, or `RMTTRAIL` parameter.
`TRAIL_SEQLEN_6D \| TRAIL_SEQLEN_9D`	Controls the sequence length for trail files.
`UPREPORT`	Specifies the frequency with which Manager reports Extract and Replicat processes that are running. Every time one of those processes starts or stops, events are generated.
`USE_TRAILDEFS \| NO_USE_TRAILDEFS`	Controls where the data pump and Replicat processes obtain the table definitions when the trail files contain full table definitions.
`USEIPV4`	Forces Oracle GoldenGate to use IPv4 for TCP/IP connections.
`USEIPV6`	Forces Oracle GoldenGate to use IPv6 for TCP/IP connections.
`WALLETLOCATION`	Specifies the location of the master key wallet.
`XAGENABLE`	Enables the Oracle GoldenGate Transparent Integration with Clusterware feature that allows you to continue using GGSCI to start and stop manager when GoldenGate instance is under the management of Oracle Grid Infrastructure Bundled Agents (XAG).

6.1.2 Summary of Parameters Common to Extract and Replicat

These parameters are available for both the Extract and Replicat processes.

Table 6-2 Parameters Common to Extract and Replicat: General

Parameter	Description
`ALLOCFILES`	Controls the incremental number of memory structures that are allocated after the initial memory allocation specified by the `NUMFILES` parameter is reached.
`CHARSET`	Specifies a multibyte character set for the process to use instead of the operating system default when reading the parameter file.
`CHECKPARAMS`	Verifies parameter file syntax.
`COMMENT \| --`	Denotes comments in a parameter file.
`GETENV`	Retrieves variables that were set with the `SETENV` parameter.
`OBEY`	Processes parameter statements contained in a different parameter file.
`SETENV`	Specifies a value for a UNIX environment variable from within the GGSCI interface.
`TRACETABLE \| NOTRACETABLE`	Specifies a trace table to which Replicat adds a record whenever it updates the target database. Causes Extract to ignore database changes generated by Replicat. Supports Oracle bi-directional replication.
`USERID \| NOUSERID`	Specifies database connection information.
`USERIDALIAS`	Specifies database connection information when a credential store is in use.

Table 6-3 Parameters Common to Extract and Replicat: Selection, Converting, and Mapping Data

Parameter	Description
`ALLOWDUPTARGETMAP \| NOALLOWDUPTARGETMAP`	Allows the same source-target `MAP` statement to appear more than once in the parameter file.
`ASCIITOEBCDIC`	Converts ASCII text to EBCDIC for DB2 on z/OS systems running UNIX System Services.
`CATALOGEXCLUDE`	Excludes the specified source container or catalog from a wildcard specification.
`COLMATCH`	Establishes global column-mapping rules.
`DDL`	Enables and filters the capture of DDL operations.
`DDLSUBST`	Enables string substitution in DDL processing.
`GETDELETES \| IGNOREDELETES`	Controls the extraction of delete operations.
`GETINSERTS \| IGNOREINSERTS`	Controls the extraction of insert operations.
`GETTRUNCATES \| IGNORETRUNCATES`	Controls the extraction of truncate statements.
`GETUPDATEAFTERS \| IGNOREUPDATEAFTERS`	Controls the extraction of update after images.
`GETUPDATEBEFORES \| IGNOREUPDATEBEFORES`	Controls the extraction of update before images.
`GETUPDATES \| IGNOREUPDATES`	Controls the extraction of update operations.
`NAMECCSID`	Specifies a DB2 for i CCSID if the object names in the SQL catalog are of a different CCSID than the system.
`PROCEDURE`	Specifies which feature groups of procedure calls are included or excluded during procedural replication.
`REPLACEBADCHAR`	Replaces invalid character values with another value.
`SCHEMAEXCLUDE`	Excludes the specified source schema from a wildcard specification.
`SOURCEDEFS`	Specifies a file that contains source data definitions created by the DEFGEN utility.
`SOURCECATALOG`	Specifies a default container or catalog for all following `TABLE` or `MAP` statements.
`TRIMSPACES \| NOTRIMSPACES`	Controls whether trailing spaces are trimmed or not when mapping `CHAR` to `VARCHAR` columns.
`VARWIDTHNCHAR \| NOVARWIDTHNCHAR`	Controls whether length information is written to the trail for `NCHAR` columns.

Table 6-4 Parameters Common to Extract and Replicat: Custom Processing

Parameter	Description
`CUSEREXIT`	Invokes a user exit routine during processing.
`INCLUDE`	Invokes a macro library.
`MACRO`	Defines an Oracle GoldenGate macro.
`MACROCHAR`	Defines a macro character other than the default of #.
`SQLEXEC`	Executes a stored procedure or query during Extract processing.
`PTKCAPTUREPROCSTATS`	Enables the capture of process and thread statistics for the PTK Monitoring.
`PTKMONITORFREQUENCY`	Sets the PTK Monitoring collection frequency interval.

Table 6-5 Parameters Common to Extract and Replicat: Reporting

Parameter	Description
`CMDTRACE`	Displays macro expansion steps in the report file.
`LIST \| NOLIST`	Displays or suppresses the listing of macros in the report file.
`REPORT`	Schedules a statistical report.
`STATOPTIONS`	Specifies information to include in statistical displays.
`REPORTCOUNT`	Reports the number of records processed.
`TRACE \| TRACE2`	Shows processing information to assist in revealing processing bottlenecks.

Table 6-6 Parameters common to Extract and Replicat: Tuning

Parameter	Description
`ALLOCFILES`	Controls the number of incremental memory structures allocated when the value of `NUMFILES` is reached.
`CACHEMGR`	Manages virtual memory resources.
`CHECKPOINTSECS`	Controls how often the process writes a checkpoint.
`DBOPTIONS`	Specifies database options.
`DDLOPTIONS`	Specifies DDL processing options.
`EOFDELAY \| EOFDELAYCSECS`	Determines how long the process delays before searching for more data to process in its data source.
`FUNCTIONSTACKSIZE`	Controls the size of the memory stack that is used for processing Oracle GoldenGate functions.
`NUMFILES`	Controls the initial allocation of memory dedicated to storing information about tables to be processed by Oracle GoldenGate.

Table 6-7 Parameters Common to Extract and Replicat: Error Handling

Parameter	Description
`DDLERROR`	Controls error handling for DDL extraction.
`DISCARDFILE \| NODISCARDFILE`	Contains records that could not be processed.

Table 6-8 Parameters Common to Extract and Replicat: Maintenance

Parameter	Description
`DISCARDROLLOVER`	Controls how often to create a new discard file.
`PURGEOLDEXTRACTS for Extract and Replicat`	Purges obsolete trail files.
`REPORTROLLOVER`	Specifies when to create new report files.

6.1.3 Summary of Extract Parameters

The Extract process captures either full data records or transactional data changes, depending on configuration parameters, and then sends the data to a target system to be applied to target tables or processed further by another process, such as a load utility.

Table 6-9 Extract Parameters: General

Parameter	Description
`ABORTDISCARDRECS`	Controls the number of discarded records after which Extract aborts.
`RECOVERYOPTIONS`	Controls the recovery mode of the Extract process.
`SOURCEDB`	Specifies the data source as part of the login information.
`TCPSOURCETIMER \| NOTCPSOURCETIMER`	Adjusts timestamps of records transferred to other systems when those systems reflect different times.
`UPDATERECORDFORMAT`	Controls whether before and after images are stored in one trail record or two.

Table 6-10 Extract Parameters: Processing Method

Parameter	Description
`EXTRACT`	Defines an Extract group as an online process.
`GETAPPLOPS \| IGNOREAPPLOPS`	Controls whether or not operations from all processes except Replicat are written to a trail or file.
`GETREPLICATES \| IGNOREREPLICATES`	Controls whether or not replicated operations are captured by an Extract on the same system.
`RMTTASK`	Creates a processing task on a remote system.
`SOURCEISTABLE`	Extracts entire records from source tables.
`VAM`	Indicates that a Teradata Access Module (TAM) is being used to provide transactional data to the Extract process.

Table 6-11 Extract Parameters: Selecting, Converting, and Mapping Data

Parameter	Description
`COMPRESSDELETES \| NOCOMPRESSDELETES`	Controls whether Oracle GoldenGate writes only the key or all columns to the trail for delete operations.
`COMPRESSUPDATES \| NOCOMPRESSUPDATES`	Causes only primary key columns and changed columns to be logged for updates.
`EXCLUDEHIDDENCOLUMNS`	The parameter disables all the Oracle Database hidden columns including the timestamp columns created using automatic CDR.
`EXCLUDETAG`	Specifies Replicat or data pump changes to be excluded from trail files.
`FETCHOPTIONS`	Controls certain aspects of the way that Oracle GoldenGate fetches data.
`LOGALLSUPCOLS`	Logs the columns that are required to support Conflict Detection and Resolution and Integrated Replicat.
`SEQUENCE`	Specifies sequences for synchronization.
`TABLE \| MAP`	Specifies tables for extraction and controls column mapping and conversion.
`TABLEEXCLUDE`	Excludes source tables from the extraction process.
`TARGETDEFS`	Specifies a file containing target table definitions for target databases that reside on the NonStop platform.
`TRAILCHARSETASCII`	Specifies the ASCII character set for data captured from DB2 on z/OS, when both ASCII and EBCDIC tables are present.
`TRAILCHARSETEBCDIC`	Specifies the EBCDIC character set for data captured from DB2 on z/OS, when both ASCII and EBCDIC tables are present.

Table 6-12 Extract Parameters: Routing Data

Parameter	Description
`EXTFILE`	Specifies an extract file to which extracted data is written on the local system.
`EXTTRAIL`	Specifies a trail to which extracted data is written on the local system.
`RMTFILE`	Specifies an extract file to which extracted data is written on a remote system.
`RMTHOST`	Specifies the target system and Manager port number.
`RMTTRAIL`	Specifies a trail to which extracted data is written on a remote system.

Table 6-13 Extract Parameters: Tuning

Parameter	Description
`BR`	Controls the Bounded Recovery feature of Extract.
`CACHEMGR`	Controls the virtual memory cache manager.
`FLUSHSECS \| FLUSHCSECS`	Determines the amount of time that record data remains buffered before being written to the trail.
`LOBMEMORY`	Controls the amount of memory and temporary disk space available for caching transactions that contain `LOB`s.
`RMTHOSTOPTIONS`	Specifies connection attributes other than host information for a TCP/IP connection used by a passive Extract group.
`THREADOPTIONS`	Controls aspects of the way that Extract operates in an Oracle Real Application Cluster environment.
`TRANLOGOPTIONS`	Supplies capture processing options.
`TRANSMEMORY`	Controls the amount of memory and temporary disk space available for caching uncommitted transaction data.
`WARNLONGTRANS`	Defines a long-running transaction and controls the frequency of checking for and reporting them.

Table 6-14 Extract Parameters: Maintenance

Parameter	Description
`ROLLOVER`	Specifies the way that trail files are aged.

Table 6-15 Extract Parameters: Security

Parameter	Description
`DECRYPTTRAIL`	Required to decrypt data when Extract is used as a data pump and must do work on the data.
`ENCRYPTTRAIL \| NOENCRYPTTRAIL`	Controls encryption of data in a trail or extract file.

6.1.4 Summary of Replicat Parameters

The Replicat process reads data extracted by the Extract process and applies it to target tables or prepares it for use by another application, such as a load utility.

Parameter	Description
`TARGETDB`	Specifies the data source as part of the login information.
`HAVEUDTWITHNCHAR`	Causes Replicat to connect in UTF-8 to prevent data loss when the record being processed is a user-defined type that has an `NCHAR/NVARCHAR2` attribute.

Replicat parameters: Processing method.

Parameter	Description
`BEGIN`	Specifies a starting point for Replicat processing. Required when `SPECIALRUN` is specified.
`BULKLOAD`	Loads data directly into the interface of the Oracle SQL*Loader utility.
`END`	Specifies a stopping point for Replicat processing. Required when using `SPECIALRUN`.
`GENLOADFILES`	Generates run and control files that are compatible with a database load utility.
`REPLICAT`	Specifies a Replicat group for online change synchronization.
`SPECIALRUN`	Used for one-time processing that does not require checkpointing from run to run.

Replicat parameters: Selecting, converting, and mapping data.

Parameter	Description
`DBOPTIONS`	Specifies database options. This is a global parameter, applying to all `TABLE` or `MAP` statements in the parameter file. Some `DBOPTIONS` options apply only to Extract or Replicat.
`ALLOWNOOPUPDATES \| NOALLOWNOOPUPDATES`	Controls how Replicat responds to a no-op operation. A no-op operation is one in which there is no effect on the target table.
`APPLYNOOPUPDATES \| NOAPPLYNOOPUPDATES`	Force a no-op update to be applied using all columns in both the `SET` and `WHERE` clauses.
`APPLY_PARALLELISM`	Configures number of appliers. This controls the number of connections in the target database used to apply the changes. The default value is four.
`ASSUMETARGETDEFS`	Assumes that source and target tables have the same column structure.
`INSERTALLRECORDS`	Inserts a new record into the target table for every change operation made to a record.
`INSERTDELETES \| NOINSERTDELETES`	Converts deletes to inserts.
`INSERTMISSINGUPDATES \| NOINSERTMISSINGUPDATES`	Converts an update to an insert when the target row does not exist.
`INSERTUPDATES \| NOINSERTUPDATES`	Converts updates to inserts.
`TABLE \| MAP`	Specifies a relationship between one or more source and target tables and controls column mapping and conversion.
`MAPEXCLUDE`	Excludes source tables from being processed by a wildcard specification supplied in `MAP` statements.
`MAP_PARALLELISM`	Configures the number of mappers. This controls the number of threads used to read the trail file. The minimum value is 1, maximum value is 100 and the default value is 2.
`MAX_PARALLELISM , MIN_PARALLELISM`	`APPLY_PARALLELISM` is auto-tuned. You can set a minimum and maximum value to define the ranges in which the Replicat automatically adjusts its parallelism. There are no defaults. Do not use with `APPLY_PARALLELISM` at the same time.
`PRESERVETARGETTIMEZONE`	Overrides the default Replicat session time zone.
`REPLACEBADNUM`	Specifies a global substitution value for invalid numeric data encountered when mapping number columns.
`SOURCECHARSET`	Controls whether the source character set it converted to the target character set.
`SOURCETIMEZONE`	Specifies the time zone of the source database for Replicat to use as the session time zone.
`SPACESTONULL \| NOSPACESTONULL`	Controls whether or not a target column containing only spaces is converted to `NULL`.
`TABLE for Replicat`	Specifies a table or tables for which event actions are to take place when a row satisfies the given filter criteria.
`TRAILCHARSET`	Specifies the character set of the source data when the trail is of an older version that does not store the source character set, or to override the character set that is stored in the trail.
`UPDATEINSERTS \| NOUPDATEINSERTS`	Converts insert operations to update operations for all `MAP` statements that are specified after it in the parameter file.
`UPDATEDELETES \| NOUPDATEDELETES`	Converts deletes to updates.
`USEDEDICATEDCOORDINATIONTHREAD`	Specifies a dedicated thread for barrier transactions when Replicat is in coordinated mode.

Replicat parameters: Routing data.

Parameter	Description
`EXTFILE`	Defines the name of an extract file on the local system that contains data to be replicated. Used for one-time processing.
`EXTTRAIL`	Defines a trail containing data to be replicated. Used for one-time processing.

Replicat parameters: Error handling and reporting.

Parameter	Description
`HANDLECOLLISIONS \| NOHANDLECOLLISIONS`	Handles errors for duplicate and missing records.
`HANDLETPKUPDATE`	Prevents constraint errors associated with replicating transient primary key updates.
`OVERRIDEDUPS \| NOOVERRIDEDUPS`	Overlays a replicated insert record onto an existing target record whenever a duplicate-record error occurs.
`RESTARTCOLLISIONS \| NORESTARTCOLLISIONS`	Controls whether or not Replicat applies `HANDLECOLLISIONS` logic after Oracle GoldenGate has abended because of a conflict.
`REPERROR`	Determines how Replicat responds to database errors.
`REPFETCHEDCOLOPTIONS`	Determines how Replicat responds to operations for which a fetch from the source database was required.
`SHOWSYNTAX`	Causes Replicat to print its SQL statements to the report file.
`SQLDUPERR`	Specifies the database error number that indicates a duplicate record. Use with `OVERRIDEDUPS`.
`WARNRATE`	Determines how often database errors are reported.

Replicat parameters: Tuning.

Parameter	Description
`BATCHSQL`	Increases the throughput of Replicat processing by arranging similar SQL statements into arrays and applying them at an accelerated rate.
`COORDSTATINTERVAL`	The interval at which the coordinator thread sends a request to the apply threads for statistics.
`COORDTIMER`	The amount of time that the coordinator thread waits for the apply threads to start.
`CHUNK_SIZE`	Controls how large a transaction must be for parallel Replicat to consider it as large. When parallel Replicat encounters a transaction larger than this size, it will serialize it, resulting in decreased performance. However, increasing this value will also increase the amount of memory consumed by parallel Replicat.
`COMMIT_SERIALIZATION`	Enables commit FULL serialization mode, which forces transactions to be committed in trail order.
`DEFERAPPLYINTERVAL`	Specifies a length of time for Replicat to wait before applying replicated operations to the target database.
`GROUPTRANSOPS`	Controls the number of records that are grouped into a Replicat transaction.
`INSERTAPPEND \| NOINSERTAPPEND`	Controls whether or not Replicat uses an `APPEND` hint when applying `INSERT` operations to Oracle target tables.
`LOOK_AHEAD_TRANSACTIONS`	Controls how far ahead the Scheduler looks when batching transactions. The default value is 10000.
`MAXDISCARDRECS`	Limits the number of discarded records reported to the discard file.
`MAXSQLSTATEMENTS`	Controls the number of prepared SQL statements that can be used by Replicat.
`MAXTRANSOPS`	Divides large source transactions into smaller ones on the target system.
`NUMFILES`	Controls the initial allocation of memory that is dedicated to storing information about tables to be processed by Oracle GoldenGate.
`SPLIT_TRANS_REC`	Specifies that large transactions should be broken into pieces of specified size and applied in parallel. Dependencies between pieces are still honored. Disabled by default.
`TRANSACTIONTIMEOUT`	Specifies a time interval after which Replicat will commit its open target transaction and roll back any incomplete source transactions that it contains, saving them for when the entire source transaction is ready to be applied.

6.1.5 Summary of Wildcard Exclusion Parameters

Table 6-16 Wildcard Exclusion Parameters

Parameter	Description
`EXCLUDEWILDCARDOBJECTSONLY`	Forces the inclusion of non-wildcarded source objects specified in `TABLE` or `MAP` parameters when an exclusion parameter contains a wildcard that otherwise would exclude that object.
`MAPEXCLUDE`	Excludes a source object from a `MAP` statement.
`TABLEEXCLUDE`	Excludes a source object from a `TABLE` statement.
`CATALOGEXCLUDE`	Excludes source objects in the specified source container or catalog from the Oracle GoldenGate configuration when the container or catalog name is being specified with a wildcard in `TABLE` or `MAP` statements.
`SCHEMAEXCLUDE`	Excludes source objects that are owned by the specified source owner (such as a schema) from the Oracle GoldenGate configuration when wildcards are being used to specify the owners in `TABLE` or `MAP` statements.

6.1.6 Summary of DEFGEN Parameters

DEFGEN creates a file with data definitions for source or target tables. Data definitions are needed when the source and target tables have different definitions or the databases are of different types.

Table 6-17 All DEFGEN Parameters

Parameter	Description
`CATALOGEXCLUDE`	Excludes the specified source container or catalog from a wildcard specification.
`CHARSET`	Specifies a multibyte character set for the process to use instead of the operating system default when reading the parameter file.
`DEFSFILE`	Identifies the name of the file to which DEFGEN writes the definitions
`NAMECCSID`	Specifies a DB2 for i CCSID if the object names in the SQL catalog are of a different CCSID than the system.
`NOCATALOG`	Prevents the container or catalog name from being included in the metadata.
`SCHEMAEXCLUDE`	Excludes the specified source schema from a wildcard specification.
`SOURCEDB`	Specifies the data source as part of the login information.
`TABLE for DEFGEN`	Identifies a table for which you want to capture a definition.
`USERIDALIAS`	Specifies database connection information.

6.1.7 Summary of DDL Parameters

These parameters control Oracle GoldenGate DDL support. Other parameters may be required with DDL support, but the ones here deal specifically with the DDL feature.

Table 6-18 All DDL Parameters

Parameter	Description
`DDL`	Enables DDL support and filters DDL.
`DDLERROR`	Handles errors that occur during DDL replication.
`DDLOPTIONS`	Configures aspects of DDL replication other than filtering and string substitution.
`DDLSUBST`	Enables the substitution of strings in DDL operations.
`DDLTABLE`	Specifies an alternate name for the DDL history table.
`GGSCHEMA`	Specifies the name of the schema that contains the objects that support DDL replication.
`PURGEDDLHISTORY \| PURGEDDLHISTORYALT`	Controls the size of the DDL history table.
`PURGEMARKERHISTORY`	Controls the size of the DDL marker table.