Oracle GoldenGate Parameters

2 Oracle GoldenGate Parameters

Learn how to use Oracle GoldenGate parameters for configuring, running, and managing the Oracle GoldenGate processes.

These parameters are grouped based on the processing to which they apply-logging changes, extracting data, replicating data, managing processes, or globally across all.

2.1 Parameter Summaries

This section summarizes Oracle GoldenGate parameters for HP NonStop, based on their functionality. This is followed by an alphabetized reference of the parameters.

2.1.1 GLOBALS Parameters Summary

GLOBALS parameters set global Oracle GoldenGate values to help standardize configuration and to perform other miscellaneous tasks. Normally, you would set global parameters when you install Oracle GoldenGate. Once set, you rarely need to change them, however, some of the parameters set in GLOBALS can be overridden by other Oracle GoldenGate programs.

The GLOBALS parameter file is stored in the subvolume where Oracle GoldenGate is installed. Use the editor to enter or change parameters in the GLOBALS file. You cannot change this file's name.

Oracle GoldenGate recommends setting global parameters before starting your first process. If you update the GLOBALS parameter file after starting a process, you must stop, then restart the process for the changes to take affect.

Table 2-1 GLOBALS Parameters: All

Parameter	Description
ADD DEFINE	Defines non-default locations for certain Oracle GoldenGate components.
AUDITING	Tells various programs in the system whether the installation is TMF, non-TMF, or both.
COMMENT	Indicates comments.
EMSLOG	Establishes a global EMS Collector name.
ERREPLYTIMEOUT	Sets the timeout value for GGSCI communication with Oracle GoldenGate components.
HEARTBEAT	Ensures that Extract and Logger can send data to Replicat.
HOMETERM	Sets up a global home terminal for Oracle GoldenGate processes.
HOMETERMMESSAGES	Suppresses or displays messages to the home terminal.
HOST	Identifies various NonStop nodes in the network.
IGNOREPARAMERROR	Prevents programs from terminating abnormally (abending) when an unrecognized `GLOBALS` entry is encountered.
IGNORETMFDUMPS	Prevents Extract, Manager, and GGSCI from capturing information about TMF disk and tape dumps.
LOGGERFLUSHRECS	Determines how many records Logger buffers before flushing to the log trail.
LOGFILEOPENS	Determines how many opens Logger keeps on the log files.
LOGGERFLUSHSECS \| LOGGERFLUSHCSECS	Determines how many seconds Logger buffers records before flushing to the log trail.
LOGGGSCICOMMANDS	Determines whether user commands are written to the `LOGGGS` file.
MANAGERREQUIRED	Determines whether Extract and Replicat can run without a Manager process.
MAXWILDCARDENTRIES	Sets the initial allocation for wildcard entries.
OLDGROUPNAMING	Determines whether new Extract and Replicat group naming is enforced.
PARAMCHECK	Specifies whether Extract and Replicat check to ensure that the correct parameter file and process name have been specified at startup.
REPORTFILEEXTENTS	Allows the user to change the default `REPORTFILEEXTENTS` setting.
SUPPRESSMARKERMESSAGES	Suppresses messages generated when markers are processed by Extract, Replicat, or GGSCI.
SWAPVOL	Designates a swap volume for Oracle GoldenGate processes.
TMFDUMPAGE	Limits information that is returned when accessing the TMF catalog to dumps created during the specified number of days.
TMFDUMPTABLEENTRIES	Limits information that is returned when accessing the TMF catalog to the number of dumps specified.
TMFREFRESHINTERVAL	Sets the refresh interval.

2.1.2 Manager Parameters Summary

Manager parameters control how Manager interacts with different Oracle GoldenGate components such as Extract, Collector, and Replicat. GGSCI expects a parameter file named MGRPARM in the GGSPARM (or prefixSPARM) subvolume on the Oracle GoldenGate install volume. This name cannot be changed.

Table 2-2 Manager Parameters: General

Parameter	Description
BACKUPCPU	Sets the backup CPU for the Manager process.
CLEANUPSAVECOUNT	Changes the number of Extract and Replicat processing history records that are returned by the GGSCI `INFO EXTRACT` and `INFO REPLICAT DETAIL` commands.
COMMENT	Starts a comment line in the parameter file.
TMFDUMPAGE	Limits the amount of dump information returned from TMF dump process.
TMFDUMPTABLEENTRIES	Lets you store up to 6,000 TMF dump information entries.

Table 2-3 Manager Parameters: Process Management

Parameter	Description
AUTORESTART	Specifies processes to be restarted by Manager after a failure.
AUTOSTART	Specifies processes that are to be automatically started when Manager starts.
EXCLUDESUFFIXCHAR	Specifies characters that are not to be used as the first character of the suffix when generating process names.
MAXABENDRESTARTS	Determines how many times in `RESTARTINTERVAL` minutes Manager attempts to restart an abnormally terminated Extract, Replicat or Logger process.
RESTARTINTERVAL	Determines the period in which restart retries are counted before being reset.

Table 2-4 Manager Parameters: Maintenance

Parameter	Description
CHECKMINUTES	Determines how often Manager cycles through its maintenance activities.
PURGEOLDEXTRACTS for Manager	Purges Oracle GoldenGate trails that are no longer needed according to specified criteria.
PURGEOLDTASKS	Purges Extract and Replicat tasks after a specified period of time.

Table 2-5 Manager Parameters: Port Management

Parameter	Description
DYNAMICPORTLIST	Specifies a range of ports that Manager can dynamically allocate.
IPINTERFACE	Restricts the Manager process to the interface specified by an IP address or DNS name.
PORT	Establishes the TCP/IP port number on which Manager listens for requests.
TCPIPPROCESSNAME	Specifies a TCP/IP process over which Manager listens for remote requests.

Table 2-6 Manager Parameters: Error and Event Management

Parameter	Description
DISKTHRESHOLD \| NODISKTHRESHOLD	Generates an event message when an audit trail file that must be processed is in danger of being recycled.
DOWNCRITICAL	Includes a process that has terminated normally in the report generated by `DOWNREPORT`.
DOWNREPORT	Specifies how often down processes are reported to EMS.
LAGCRITICAL	Specifies a time lag for Extract and Replicat that is reported to EMS as a critical message.
LAGINFO	Specifies a time lag for Extract and Replicat that is reported to EMS as informational.
LAGREPORT	Sets an interval for reporting Extract and Replicat lags to EMS.
LOGFILESBEHIND \| LOGFILESBEHINDINFO	Reports a critical or informational message when Extract or Replicat falls a certain number of files behind the current log trail file.
THRESHOLD \| NOTHRESHOLD	Generates an event message when an audit trail file that needs to be processed is in danger of being recycled.
UPREPORT	Determines how often process "I'm alive" messages are reported.

2.1.3 Logger Parameters Summary

Logger performs data extracts when a NonStop source is non-TMF. By default, GGSCI expects the Logger parameter file to be named LOGPARM and located in install_volume.GGSPARM.LOGPARM. Enter parameters in the default file unless you have strong reasons to specify a different file name.

Table 2-7 Logger Parameters: General

Parameter	Description
COMMENT	Starts a comment line in the parameter file.
CPU	Specifies the primary and backup CPUs for the current logging process.
FORCESTOPDELAY	Causes the logging process to delay for a period of time before it is stopped by an operating system `STOP` or `ABEND`, or by a `STOP` or `ABEND` from an application.
HEARTBEAT	Causes Logger to issue heartbeat records every 60 seconds.
NOTSTOPPABLE	Enables Logger to be stopped only with the GGSCI `STOP LOGGER` command.
PRIORITY	Specifies the priority at which to run the current log process.

Table 2-8 Logger parameters: Trail and File Management

Parameter	Description
EXCLUDEFILE	Excludes a file or file set from extraction. Overrides all `FILE` settings for that Logger process.
FILE	Establishes a file or file set to be logged.
INCLUDESOURCEAPPINFO \| EXCLUDESOURCEAPPINFO	Includes the source application program name and process ID as tokens in the trail.
LOGGERFLUSHRECS	Determines how many records Logger buffers before flushing to the log trail.
LOGGERFLUSHSECS \| LOGGERFLUSHCSECS	Determines how many seconds Logger buffers records before flushing to the log trail.
LOG	Establishes a log process and the dimensions of the log trails for that process.
LOGFILEOPENS	Determines how many opens Logger keeps on the log files.
LOGGERFILENUM	Specifies the file number that `GGSLIB` uses to open the log process.
LOGGERTIMEOUTSECS	Controls how long `GGSLIB` will wait for a response from Logger before allowing the application to resume normal operations.

Table 2-9 Logger Parameters: Error and Event Management

Parameter	Description
DEBUGONSTACKCHECK	Instructs `GGSLIB` to call DEBUG whenever an application's process stack is close to overflowing.
RECEIVEQWARN	Issues an EMS warning if it receives a trail that exceeds the specified threshold.
TRACEALLOPENS	Instructs `GGSLIB` to send all open and close attempts on any file to Logger.
TRACECLOSES	Instructs `GGSLIB` to send close records to Logger for the purpose of tracing system activity.
TRACEOPENS	Instructs `GGSLIB` to send open records to Logger for the purpose of tracing system activity.
TRACEPROCESSIOS	Instructs Logger to precede each record logged with information regarding the process that created the record.
TRACESTATS	Instructs Logger to keep statistics for each process that sends it database operations.

2.1.4 CHGNOTE Parameters Summary

The CHGNOTE process is started whenever Logger is started, whenever a change is made to the Logger configuration, or whenever a FILE RENAME operation occurs. A separate CHGNOTE process is started in each CPU. Each process updates the last modified timestamp for each $SYSTEM.GGS.GGSCPUnn file, which notifies any user application that is bound to the Oracle GoldenGate Intercept library to reevaluate the Logger audit configuration segment.

By default, GGSCI expects the CHGNOTE parameter file to be named CHGPARM and located in the Oracle GoldenGate installation subvolume (not the GGSPARM subvolume). The CHGNOTE parameter file is optional.

Parameter	Description
RENAMEBUMPDELAY	Determines the number of seconds to bump the last modified timestamp on the `GGSCPUnn` files.

2.1.5 Extract Parameters Summary

Extract extracts source data from the TMF audit trail and writes it to one or more files, called Oracle GoldenGate trails. Extract parameter files are typically stored in the GGSPARM subvolume with a file name that is the same as the group name. When using Extract checkpoints, the name of the Extract parameter file must match the entry designated in GGSCI for the Extract group.

Table 2-10 Extract Parameters: General

Parameter	Description
CHECKPARAMS	Verifies parameter file contents.
COMMENT	Indicates comments.
GETENV	Retrieves an environment variable set with the `SETENV` parameter.
INCLUDE	Identifies a macro library to be included.
OBEY	Accepts parameters from a different parameter file.
SETENV	Sets a NonStop environment variable.

Table 2-11 Extract parameters: Process Management

Parameter	Description
ALLOCFILES	Controls the amount of incremental memory that is allocated when the amount of memory specified with `NUMFILES` is reached.
ALTFILERESOLVE \| NOALTFILERESOLVE	Resolves wildcards and identifies audited alternate key files on startup.
ALTINPUT	Distributes files across multiple Extract processes so that Extract never processes two files in sequence.
AUDSERVCACHEBLOCKS	Determines how much caching of SQL table definitions occurs when reading update records.
AUDSERVCPU	Begins reading the audit trail in a CPU different from that in which the Extract is running.
AUDSERVPARAM	Passes parameters that are specific to the Audserv process.
AUDSERVPREFIX	Permits Extract to assign custom prefixes to Audserv processes.
AUDSERVPROCESS	Permits Extract to assign an Audserv process a 5-character name.
AUDSERVPROGRAM	Allows customer to run both Native mode and TNS mode Audserv programs.
BEGIN	Establishes the time for Extract to start processing TMF audit trails. Required when `SPECIALRUN` is specified, otherwise omitted.
CHECKPOINTSECS	Specifies the maximum amount of time that Extract waits before writing a checkpoint.
END	Establishes the `END` time for the current run. Not required unless `SPECIALRUN` is indicated. Online processing is implied if `END` is in the future or unspecified.
EXTRACT	Links this run to a particular Extract group. Required unless `SPECIALRUN` or `SOURCEISFILE` specified.
EXCLUDEGGSTRANSRECS \| INCLUDEGGSTRANSRECS	Suppresses the creation of trail records that track distributed network transactions.
FILEAGEDAYS	Specifies the number of days a file can be inactive before it is aged off Extract's file list.
FILEEXCLUDE TABLEEXCLUDE	Excludes one or more files or tables from a file list.
FILERESOLVE	Controls whether wildcard lists are resolved during startup or dynamically.
FILTERVIEW \| NOFILTERVIEW	Outputs a SQL view update only when a column has changed.
GETALTKEYS \| IGNOREALTKEYS	Instructs Extract to produce (or ignore) file create records for alternate key files after it outputs the file create record for the primary file.
GETDEFAULTS	Lets you reset all Extract parameters to their default settings.
HEARTBEAT	Informs receiving processes (such as Replicat) that the source system is processing data.
LIMITRECS	Limits the number of records when capturing directly from a source table.
MAXWILDCARDENTRIES	Sets the initial allocation of wildcard entries.
NOFILEAGING	Deactivates the default of aging files from memory at two day intervals of no usage.
NUMFILES	Controls the initial allocation of memory dedicated to storing information about files to be processed by Oracle GoldenGate.
OPENTIMEOUT \| OPENTIMEOUTMINUTES	Controls how long inactive files opened for `FETCHCOMPS` or `FETCHLASTIMAGE` remain open.
SOURCEISFILE \| SOURCEISTABLE	Reads all records from the source file rather than reading changes from the TMF audit trails. Useful for initial synchronization of source and target.
SPECIALRUN	Processes from user-specified `BEGIN` and `END` times. Used for one-time processing that does not require checkpointing from run-to-run. One of `EXTRACT`, `SPECIALRUN` or `SOURCEISFILE` is required.
SYSKEYCONVERT	For direct file extraction only. Specifies the format of the syskey in the output file for entry-sequenced and ACI files.
TMFREFRESHINTERVAL	Sets the refresh interval in seconds.
VERBOSE	Allows Extract to allocate memory in large blocks.

Table 2-12 Extract Parameters: Security

Parameter	Description
DECRYPTTRAIL	Performs decryption when reading encrypted files in the Oracle GoldenGate trail.
ENCRYPTTRAIL \| NOENCRYPTTRAIL	Encrypts data records in subsequent trail files until a `NOENCRYPT` is encountered. An Extract or Replicat process downstream must specify a `DECRYPT` to read the files.
LOGON	Specifies an alternate user ID under which Extract should run.

Table 2-13 Extract Parameters: File and Trail Management

Parameter	Description
EOFDELAY \| EOFDELAYCSECS	Determines how many seconds Extract delays before looking for more data to extract when the source is an Oracle GoldenGate trail.
AUDITRETRYDELAY	Controls the frequency with which TMF audit trails are checked for new data.
DISPLAYTRAILSWITCH \| NODISPLAYTRAILSWITCH	Causes Extract to write messages to the report file when it switches trails.
EXTFILE	Identifies the local Oracle GoldenGate trail as a flat file to which extracted data is output.
EXTTRAIL	Identifies the local Oracle GoldenGate trail to which extracted data is output.
FLUSHSECS \| FLUSHCSECS	Determines the maximum time an extracted record remains buffered before being written to the Oracle GoldenGate trail.
NUMEXTRACTS	Allows Extract to exceed the default number of files in an Oracle GoldenGate trail.
OMITAUDITGAPCHECK	Enables Extract to continue processing even when a gap is detected between the oldest required audit trail and the current trail.
PURGEOLDEXTRACTS for Extract and Replicat	Purges Oracle GoldenGate trail files when they are no longer required.
PURGERESTORE \| NOPURGERESTORE	Purges audit files restored from tape immediately after use by Extract.
RESTORE \| NORESTORE	Controls whether audit dumps on tape are reloaded when the dumps are not available on disk.
ROLLOVER	Specifies conditions under which local and remote Oracle GoldenGate trails start a new file in a sequence.
TMFTRAILTRACE	Instructs Extract to write messages to the report file when it switches to the next TMF audit trail.

Table 2-14 Extract Parameters: Remote Processing

Parameter	Description
IPINTERFACE	Restricts the Extract process to the interface specified by an IP address or DNS name.
POSITIONFIRSTRECORD	Positions Extract at the beginning of the input file to reprocess all records. For direct file extraction with `RMTBATCH` only.
RMTBATCH	Outputs data to a batch file on the target system. Enables activities such as trickle batch transfer.
RMTFILE	Identifies the remote Oracle GoldenGate trail as a single file.
RMTHOST	Establishes the remote TCP/IP host and port number to which output will be directed for subsequent `RMTFILE` and `RMTTRAIL` entries.
RMTHOSTALT	Specifies an alternative IP address in the event that the `RMTHOST` address is not reachable.
RMTTASK	Creates a task on the target system.
RMTTRAIL	Identifies the remote Oracle GoldenGate trail.
TCPBUFSIZE	Sets the maximum size for the message buffer sent to remote systems.
TCPFLUSHBYTES	Controls the TCP/IP flush size for better communications performance.
TCPIPPROCESSNAME	Changes the name of the TCP/IP process. Specifies additional processes as backups.
TCPIPSWITCHERRS	Determines how many retries on a TCP/IP connection are attempted before trying alternate addresses and controllers.
TCPSOURCETIMER \| NOTCPSOURCETIMER	Adjusts timestamps of source records to synchronize with timestamp of target system.

Table 2-15 Extract Parameters: Performance Management

Parameter	Description
FASTPOSITION \| NOFASTPOSITION	Instructs the `AUDSERV` program to do a binary search of the TMF Audit trail at startup, reducing startup time and CPU overhead associated with starting the process for the first time.
FASTIO	Writes output using large I/O transfers to increase performance.
FASTREADS \| NOFASTREADS	Enables larger reads (up to 28K bytes) of trails.
FUNCTIONSTACKSIZE	Controls the size of the memory stack that is used for processing Oracle GoldenGate functions.
MAXTRANSMEM	Controls the maximum amount of memory allocated for a transaction.
SHORTREADDELAY	Optimizes system resource usage when Extract runs online by instructing Extract to delay a specified number of seconds whenever a block shorter than the optimal block size is read from a trail.

Table 2-16 Extract Parameters: Data Selection

Parameter	Description
COMPRESSDELETES \| NOCOMPRESSDELETES	Extracts only the primary key fields or columns for deleted operations, which reduces network bandwidth and trail storage requirements.
FETCHCOMPS \| FETCHLASTIMAGE	Controls how data from missing fields in a compressed update is supplied.
GETCOMPS \| IGNORECOMPS	Includes or excludes compressed records in the extracted data.
GETCREATES \| IGNORECREATES	Includes or excludes create records in the extracted data.
GETDELETES \| IGNOREDELETES	Includes or excludes delete records in the extracted data.
GETFILEOPS \| IGNOREFILEOPS	Includes or excludes file alter, create, purge, purgedata, rename and setmode records in the extracted data.
GETINSERTS \| IGNOREINSERTS	Includes or excludes insert records in the extracted data.
GETMARKERS \| IGNOREMARKERS	Includes or excludes marker records in the extracted data.
GETNETCHANGES \| IGNORENETCHANGES	Includes or excludes net update records in the extracted data.
GETNEWCOLUMNS \| IGNORENEWCOLUMNS	Includes or excludes SQL column change records in the extracted data.
GETPARTONLYPURGEDATAS \| IGNOREPARTONLYPURGEDATAS	Includes or excludes `PARTONLY` `PURGEDATA` operations in the extracted data.
GETPURGES \| IGNOREPURGES	Includes or excludes file purge operations in the extracted data.
GETPURGEDATAS \| IGNOREPURGEDATAS	Includes or excludes operations to purge file data in the extracted data.
GETRENAMES \| IGNORERENAMES	Includes or excludes file rename records in the extracted data.
GETREPLICATES \| IGNOREREPLICATES	Includes or excludes records produced by Replicat.
GETROLLBACKS \| IGNOREROLLBACKS	Includes or excludes rollback records from being extracted.
GETUPDATEAFTERS \| IGNOREUPDATEAFTERS	Includes or excludes update after-image records in the extracted data.
GETUPDATEBEFORES \| IGNOREUPDATEBEFORES	Includes or excludes update before-image records in the extracted data.
GETUPDATES \| IGNOREUPDATES	Includes or excludes update records in the extracted data.
GETAUXTRAILS \| IGNOREAUXTRAILS	Ignores database changes stored in auxiliary TMF audit trails.
READTHRULOCKS \| NOREADTHRULOCKS	Ignores record locks when performing `FETCHCOMPS`. This can help avoid a deadlock.
TRANSMEMVOLS	Keeps extracts memory allocation for uncommitted transaction data out of Kernel Managed Swap (KMSF) space.

Table 2-17 Extract Parameters: Data Mapping

Parameter	Description
COLMATCH	Sets global column mapping rules.
FILE \| TABLE	Outputs record changes from the named file into the current trail, subject to conditions and mapping specified as part of this parameter. At least one `FILE` or `TABLE` entry is required.

Table 2-18 Extract Parameters: Data Formatting and Conversion

Parameter	Description
CONVERTALLFLOATSTOIEEE \| NOCONVERTALLFLOATSTOIEEE	Converts all float data type numbers in a table from Oracle GoldenGate HP NonStop Tandem (TDM) format to the Institute of Electrical and Electronics Engineers (IEEE) format.
CONVERTALLFLOATSTOTDM \| NOCONVERTALLFLOATSTOTDM	Converts all float data type numbers in a table from IEEE format to TDM format.
FILLSHORTRECS \| NOFILLSHORTRECS	Fills out records that are shorter than maximum length.
FORMATASCII \| NOFORMATASCII	Formats output in external ASCII format.
FORMATSQL \| NOFORMATSQL	Formats extracted records into equivalent `SQL INSERT`, `UPDATE`, and `DELETE` syntax.
FORMATXML	Formats extracted data into equivalent XML syntax.
FORMATLOCAL	Controls whether ASCII formatting occurs on NonStop or the target system.
REPLACEBADCHAR	Replaces invalid character values with specified entry.
REPLACEBADNUM	Replaces invalid numeric values with specified entry.
Y2KCENTURYADJUSTMENT \| NOY2KCENTURYADJUSTMENT	Controls whether the Y2K window changes the century.

Table 2-19 Extract Parameters: Data Customization

Parameter	Description
COBOLUSEREXIT	Invokes COBOL85 user exit routines at different points during processing.
CUSEREXIT	Invokes C user exit routines at different points during processing.
MACRO	Creates an Oracle GoldenGate macro.
MACROCHAR	Changes the macro character to something other than #.
EMBEDDEDMACROS \| NOEMBEDDEDMACROS	Processes macros embedded within a quoted string.
TALUSEREXIT	Invokes TAL user exit routines at different points during processing.

Table 2-20 Extract Parameters: Reporting and Error Handling

Parameter	Description
DISCARDFILE	Specifies file name to contain records that could not be processed.
DISCARDROLLOVER	Specifies times at which to create new discard files.
DISPLAYFILEREFRESHES	Displays a message when file attributes are refreshed.
ERROR59ROLLOVER	Enables reading to skip ahead to the next file in a sequence upon encountering a damaged block (Guardian Error 59).
HOMETERMMESSAGES	Suppresses message display to the home terminal.
LAGSTATS	Specifies parameters for capturing lag and related statistics.
LIST \| NOLIST	Control whether the macros of a macro library are listed in the report file.
REPORT	Schedules a statistical report at a specified date or time.
REPORTCOUNT	Reports records processed at defined intervals.
REPORTROLLOVER	Specifies times at which to create new report files.
RETRYERR	Sets up error retry options (for example, to retry network errors automatically).
STATOPTIONS	Optionally reports zero counts for insert, update and delete operations
SUPPRESSALLALTERMESSAGES \| NOSUPPRESSALLALTERMESSAGES	Suppress all messages produced when Extract finds a `FILE ALTER` record in the TMF audit trail.
SUPPRESSALTERMESSAGES \| NOSUPPRESSALTERMESSAGES	Suppress all except the first messages produced when Extract finds a `FILE ALTER` record in the TMF audit trail.
SUPPRESSFETCHCOMPRESSEDDISCARDS \| NOSUPPRESSFETCHCOMPRESSEDDISCARDS	Suppress display of messages when a `FETCHCOMP` fails to find the needed record.
SUPPRESSFILEOPMESSAGES \| NOSUPPRESSFILEOPMESSAGES	Suppress the output of messages generated after `FILE RENAME`, `PURGE`, `CREATE`, `ALTER`, `SETMODE`.
SUPPRESSMARKERMESSAGES	Suppress messages generated when markers are processed.
VERSIONERR	Specifies error handling when database definitions are out of synchronization with audit trail records.

Table 2-21 Extract Parameters: Application-Specific

Parameter	Description
DICTIONARY	Opens a DDL dictionary. Used to associate record layouts with Enscribe files.
EXPANDDDL	Enables custom specification of Enscribe array items and formatting of field names.

2.1.6 Replicat Parameters Summary

Replicat reads data from Oracle GoldenGate trails that were created by Extract or Logger. Replicat parameter files are typically stored in the GGSPARM subvolume with a file name that is the same as the group name. When using Replicat checkpoints, the name of the Replicat parameter file must match the entry designated in GGSCI for the Replicat group.

Table 2-22 Replicat Parameters: General

Parameter	Description
CHECKPARAMS	Verifies parameter file contents.
COMMENT	Indicates comments.
GETENV	Retrieves an environment variable set with the `SETENV` parameter.
INCLUDE	Identifies a macro library to be included.
OBEY	Accepts parameters from a different parameter file.
SETENV	Sets a NonStop environment variable.

Table 2-23 Replicat Parameters: Process Management

Parameter	Description
ALLOCFILES	Controls the amount of incremental memory that is allocated when the amount of memory specified with `NUMFILES` is reached.
ASSUMETARGETDEFS	Assumes that the source files or tables are structured like the target, bypassing the retrieval process from source system.
AUDITREPS \| NOAUDITREPS	Turns auditing on or off for Replicat operations.
BEGIN	Establishes the time for Replicat to begin processing the Oracle GoldenGate trails. Required when `SPECIALRUN` specified, otherwise omitted.
CHECKPOINTSECS	Controls how often Replicat writes a checkpoint when checkpoints are not being generated as a result of transaction commits.
CHECKUNIQUEKEY \| NOCHECKUIQUEKEY	Forces Replicat to check for unique key constraint violations on entry-sequenced files before inserting data.
COORDINATOR	Identifies the process that will coordinate transactions that are distributed across multiple nodes.
DICTIONARY	Opens a DDL dictionary. Used to associate definitions with Enscribe files for column mapping and selectivity condition evaluation.
END	Establishes the `END` time for the current run. Not required unless `SPECIALRUN` is specified. Online processing is implied if `END` is in the future or unspecified.
ENTRYSEQUPDATES	Applies changes to entry-sequenced files exactly as they were on the source system (non-audited files only).
EOFDELAY \| EOFDELAYCSECS	Determines how many seconds Replicat delays before looking for more data to replicate.
EXPANDDDL	Enables custom specification of Enscribe array items and formatting of field names.
EXTFILE	Provides the source of records to be replicated. Either `EXTFILE` or `EXTTRAIL` must be specified for `SPECIALRUN`.
EXTTRAIL	See `EXTFILE`.
FASTREADS \| NOFASTREADS	Enables larger reads (up to 28K bytes) of Oracle GoldenGate trails.
FILEAGEDAYS	Specifies the number of days a file can be inactive before it is aged off Replicat's file list. See ticket 21181027.
FILEOPWARNING	Controls Replicat's behavior when it attempts to purge non-existent files.
FLUSHCHECKPOINT \| NOFLUSHCHECKPOINT	Controls whether files are flushed from an Oracle GoldenGate trail when Replicat records a checkpoint.
FORCEUSESYSKEY \| NOFORCEUSESYSKEY	Forces Replicat to specify the `SYSKEY` when executing updates and deletes on entry-sequenced and cluster-sequenced SQL tables. It forces the syskey to be -1 for relative Enscribe files.
GETDEFAULTS	Lets you reset all Extract parameters to their default settings.
GETNETWORKALTFILENAMES \| IGNORENETWORKALTFILENAMES	Controls whether the file system qualifies the alternate key file names with the local node name.
GROUPTRANSOPS	Groups multiple transactions within larger transactions, which can greatly enhance performance.
MAXDISCARDRECS	Limits the number of discarded records reported to the discard file.
MAXETCHECKPOINTSECS	Specifies the maximum amount of time that Replicat waits before writing a checkpoint.
MAXWILDCARDENTRIES	Sets the initial allocation of wildcard entries.
NETWORKCHECKPOINTS	When Replicat encounters partitions residing on a remote node, triggers update of the local checkpoint file to allow identification of replicated data.
NOFILEAGING	Deactivates the default of aging files from memory at two day intervals of no usage.
NUMFILES	Controls the initial allocation of memory dedicated to storing information about files to be processed by Oracle GoldenGate.
OPENTIMEOUT \| OPENTIMEOUTMINUTES	Controls how long inactive files opened for `FETCHCOMPS` or `FETCHLASTIMAGE` remain open.
PARTMAP	Specifies alternate partitioning schemes during file creation on the backup system.
POSITIONFIRSTRECORD	Positions Replicat at the beginning of the input file to reprocess all records. For direct file extraction with `RMTBATCH` only.
PURGEDATAALTFILES \| NOPURGEDATAALTFILE	Purges data on the alternate key files when an Enscribe `PURGEDATA` is received for the primary file.
PURGEOLDEXTRACTS for Extract and Replicat	Purges Oracle GoldenGate trails when they are no longer required.
REPLICAT	Links this run to a particular Replicat group (set up with GGSCI) to facilitate continuous processing through the Oracle GoldenGate trails. Required unless `SPECIALRUN` is entered.
REPNEWCOLUMNS \| NOREPNEWCOLUMNS	Replicates SQL `ALTER TABLE ADD COLUMN` statements.
REVERSEWINDOWSECS \| REVERSEWINDOWCSECS	Holds transactions for a specified number of seconds or centiseconds to wait for an out-of-order transaction to be processed. Valid for non-audited target files.
SOURCEDEFS	Specifies a text file that contains Oracle GoldenGate source file and table data definitions (created by the `DEFGEN` utility).
SPECIALRUN	Processes from user specified `BEGIN` and `END` times. Used for one-time processing that does not require continuous processing of Oracle GoldenGate trails from run to run. Either `REPLICAT` or `SPECIALRUN` is required.
WAITFILEEVENT	Waits for a file-related event to occur before proceeding.

Table 2-24 Replicat Parameters: Security

Parameter	Description
DECRYPTTRAIL	Use `DECRYPTTRAIL` to decrypt encrypted Oracle GoldenGate trail files.
LOGON	Specifies an alternate user ID under which to run Replicat.

Table 2-25 Replicat Parameters: Data Selection

Parameter	Description
GETCREATES \| IGNORECREATES	Includes or excludes file create records from a particular trail.
GETDELETES \| IGNOREDELETES	Includes or excludes delete records from being replicated.
GETFILEOPS \| IGNOREFILEOPS	Includes or excludes file alter, create, purge, purgedata, rename and setmode records from being replicated.
GETINSERTS \| IGNOREINSERTS	Includes or excludes insert records from being replicated.
GETNEWCOLUMNS \| IGNORENEWCOLUMNS	Includes or excludes detection of new SQL columns.
GETPARTONLYPURGEDATAS \| IGNOREPARTONLYPURGEDATAS	Includes or excludes `PARTONLY` `PURGEDATA` operations.
GETPURGES \| IGNOREPURGES	Instructs Replicat to include or ignore the `FUP PURGE` operation.
GETPURGEDATAS \| IGNOREPURGEDATAS	Instructs Replicat to include or ignore the `FUP PURGEDATA` operation.
GETRENAMES \| IGNORERENAMES	Includes or excludes file rename records in the current Oracle GoldenGate trail.
GETUPDATEAFTERS \| IGNOREUPDATEAFTERS	Includes or excludes update after-images from being replicated.
GETUPDATEBEFORES \| IGNOREUPDATEBEFORES	Includes or excludes update before-images from being replicated.
GETUPDATES \| IGNOREUPDATES	Includes or excludes update records from being replicated.
INSERTALLRECORDS \| NOINSERTALLRECORDS	Causes Replicat to insert every change operation made to a record as a new record in the database.
INSERTMISSINGUPDATES \| NOINSERTMISSINGUPDATES	Inserts update operations that have no corresponding records already inserted into the target file.
OVERRIDEDUPS \| NOOVERRIDEDUPS	Overlays the current insert record onto an existing record whenever a duplicate record error occurs. Otherwise, an error results.
UPDATEDELETES \| NOUPDATEDELETES	Changes deletes to update operations. Useful for archiving and reporting.

Table 2-26 Replicat Parameters: Data Mapping

Parameter	Description
COLMATCH	Sets global column mapping rules.
MAP	Specifies a source to target file pair. At least one `MAP` entry is required.
MAPEXCLUDE	Excludes one or more files from a wildcard map list.

Table 2-27 Replicat Parameters: Data Formatting and Conversion

Parameter	Description
CONVERTALLFLOATSTOIEEE \| NOCONVERTALLFLOATSTOIEEE	Converts all float data type numbers in a table from Oracle GoldenGate HP NonStop Tandem (TDM) format to the Institute of Electrical and Electronics Engineers (IEEE) format.
CONVERTALLFLOATSTOTDM \| NOCONVERTALLFLOATSTOTDM	Converts all float data type numbers in a table from IEEE format to TDM format.
FILLSHORTRECS \| NOFILLSHORTRECS	Fills out records that are shorter than maximum length.
INSERTDELETES \| NOINSERTDELETES	Changes deletes to insert operations. Useful for archiving and reporting.
INSERTUPDATES \| NOINSERTUPDATES	Changes updates to insert operations.
REPLACEBADCHAR	Replaces invalid character values with specified entry.
REPLACEBADNUM	Replaces invalid numeric values with specified entry.
UPDATEDELETES \| NOUPDATEDELETES	Changes deletes to update operations. Useful for archiving and reporting.
UPDATEINSERTS \| NOUPDATEINSERTS	Changes insert operations to update operations. Useful for archiving and reporting.
Y2KCENTURYADJUSTMENT \| NOY2KCENTURYADJUSTMENT	Controls whether the Y2K window changes the century.

Table 2-28 Replicat Parameters: Data Customization

Parameter	Description
COBOLUSEREXIT	Instructs Replicat to invoke COBOL85 user exit routines at different points during processing.
CUSEREXIT	Instructs Replicat to invoke C user exit routines at different points during processing.
MACRO	Creates an Oracle GoldenGate macro.
MACROCHAR	Changes the macro character to something other than #.
EMBEDDEDMACROS \| NOEMBEDDEDMACROS	Processes macros embedded in a quoted string.
TALUSEREXIT	Invokes TAL user exit routines at different points during processing.

Table 2-29 Replicat Parameters: Reporting and Error Handling

Parameter	Description
CONTROLTABLELOCKOFF	Used as a global level toggle before and after map statements as well as an option of a map.
DISCARDFILE	Contains records that could not be processed.
DISCARDROLLOVER	Specifies times at which to create new discard files.
DISPLAYFILEREFRESHES	Displays a message when file attributes are refreshed.
HANDLECOLLISIONS \| NOHANDLECOLLISIONS	Ignores duplicate record and missing record errors. Useful for overlaying database changes that occur during initial loading and other purposes.
LAGSTATS	Specifies parameters for capturing lag and related statistics.
LIST \| NOLIST	Controls whether the macros of a macro library are listed in the report file.
OPENWARNINGS	Determines how Replicat processes Enscribe file open warnings.
REPERROR	Determines how Replicat responds to certain Guardian and SQL errors, including how transactions are backed out.
REPORT	Schedules a statistical report at a specified date or time.
REPORTCOUNT	Reports records processed at defined intervals.
REPORTROLLOVER	Specifies times at which to create new report files.
REPORTTMFEXCEPTIONS	Reports when Replicat detects a `TMFEXCEPTIONS` type of condition
REPSQLLOG	Redirects the log to a file other than the Replicat report file.
RESTARTCOLLISIONS \| NORESTARTCOLLISIONS	Enables `HANDLECOLLISIONS` until the first checkpoint is finished.
RETRYDELAY	Specifies the delay between attempts at retrying a failed insert, update, or delete operation.
SQLFORMATDISCARDFILE	Contains SQLCI input for discarded SQL/MP operations
SQLFORMATDISCARDROLLOVER	Specifies when to create new SQL formatted discard files
STATOPTIONS	Optionally reports on time spent creating files, purging files, and ending transactions. Optionally reports zero counts for insert, update and delete operations.
SUPPRESSFILEOPMESSAGES \| NOSUPPRESSFILEOPMESSAGES	Suppresses the output of messages generated after `FILE RENAME`, `PURGE`, `CREATE`, `ALTER`, `SETMODE`.
SUPPRESSMARKERMESSAGES	Suppresses messages generated when markers are processed.
TMFEXCEPTIONS \| NOTMFEXCEPTIONS	Resolves certain out-of-order records in the TMF audit trail within a given transaction.
WARNRATE	Determines how often database errors are reported. Useful when many errors are anticipated; controls the size of the log.

2.1.7 Coordinator Parameters Summary

Coordinator tracks distributed network transactions to coordinate updates on multiple nodes.

Table 2-30 Coordinator Parameters: All

Parameter	Description
COORDINATOR	Links this run to a particular Coordinator group.
FASTREADS \| NOFASTREADS	Enables larger reads (up to 28K bytes) of trails.
READER	Triggers the creation of a Reader process to access a local trail and communicate with the system Coordinator

2.1.8 Syncfile Parameters Summary

Syncfile lets you schedule and manage file duplication when you wish to copy files in their entirety.

Table 2-31 Syncfile Parameters: All

Parameter	Description
ABORTDUPERRWINDOW	Specifies a time period for Syncfile to restart aborted processes before ending abnormally.
CHECKINTERVAL	Lets you change the time interval for evaluating scheduled events.
COMMENT	Starts a comment line in the parameter file.
DUP	Specifies options for duplication, including the file set to duplicate, the target file set, the duplication method and schedule. At least one `DUP` parameter is required.
DUPONLYAFTEREVENT	Specifies a time for events to execute.
DUPPROCESS	Lets you specify the process name used for the TACL or FUP process used to duplicate files. This parameter is useful for debugging.
EVENT	Identifies an event, by name, and supplies its schedule. At least one `EVENT` parameter is required.
HOMETERMMESSAGES	Suppresses message display to the home terminal.
REPORTROLLOVER	Specifies when to age the current report file and create a new one.
SYNCFILE	For use when the parameter file has a different name than the group name.
TRACE	Logs Syncfile processing messages to a report file.
VERBOSE	Turns on display of FUP and TACL messages.

2.2 ABORTDUPERRWINDOW

Valid for

Syncfile

Description

Use ABORTDUPERRWINDOW to specify an alternative time interval for Syncfile to restart processes that abend.

To duplicate files, Syncfile starts either a FUP or TACL process to perform the duplication. If one of these processes abends, Syncfile automatically restarts it. However, if the process abends more than three times within one hour, the Syncfile process abends.

Default

1 HOUR

Syntax

ABORTDUPERRWINDOW num_units unit;

num_units: The number of units of time, as in 1 or 10.
unit: The time unit. Specify one of: SECONDS, MINUTES or HOURS.

Example

ABORTDUPERRWINDOW 4 HOURS;

2.3 ADD DEFINE

Valid for

GLOBALS

Description

ADD DEFINE provides the ability to specify valid DEFINE statements to help with resolution of default locations, file names, or anything that can be set using a standard DEFINE.

Oracle GoldenGate recommends that you use the defaults, however, if your installation requires that you use other definitions, you can define them in the GLOBALS parameter file using ADD DEFINE. By specifying defines in the GLOBALS parameter file, they are established for all the affected components you install; you don't have to specify them in other parameter files.

Default

ADD DEFINE changes the following defaults:

The default for the Oracle GoldenGate environment prefix, GGS.
The default volume and subvolume for AUDCFG, $SYSTEM.GGS.AUDCFG.
The default number of seconds the Logger process delays before closing the old file when rolling to a new file.
The default volume and subvolume for parameter files, $VOL.GGSPARM.
The default volume and subvolume for report files, $VOL.GGSRPT.

Note:

Defaults set by ADD DEFINE for =GGS_PARAMS or =GGS_REPORT can be overridden by the appropriate GGSCI ADD or ALTER command.
The default TCPIP process name, $ZTC0

Note:

Defaults set by the ADD DEFINE for =TCPIP^PROCESS^NAME can be overridden by using the TCPIPPROCESSNAME parameter for Manager or Extract or using the RMTHOST TCPIPPROCESSNAME option.

When you create a new volume, subvolume, or file name, you need to specify the new location and file name in the appropriate places, such as when you execute a GGSCI ADD or ALTER command, or in any parameter file where you specified a location or file name.

Syntax

ADD DEFINE {define}, [class_node_vol_spec]

define

The define must be one of the following:

=GGS_AUDCFG: Changes the default file name of the AUDCFG file.
=GGS_DB_SUBVOL: Defines the subvolume location of the Oracle GoldenGate database.
=GGS_LOGFILE_CLOSE_DELAY: Changes the delay before Logger closes the old file when rolling to a new one. The default is 120 seconds.
=GGS_PARAMS: Changes the default subvolume used to store parameter files.
=GGS_PREFIX: Lets you define a different Oracle GoldenGate prefix for process names and subvolumes.
=GGS_REPORT: Changes the default subvolume used to store the report file.
=TCPIP^PROCESS^NAME: Changes the default TCPIP process name.

class_node_vol_spec

If you are defining a new volume and subvolume or a file name enter class_node_vol_spec as follows:

To specify a file name, enter:

ADD DEFINE =GGS_type, CLASS MAP, 
FILE \NODE.$volume.subvolume.file_name

To specify a new default volume and subvolume, enter:

ADD DEFINE =GGS_type, CLASS DEFAULTS, 
VOLUME \NODE.$volume.subvolume

To specify a new prefix, enter:

ADD DEFINE =GGS_PREFIX, CLASS MAP, FILE $prefix

To specify a delay time for closing the log file, enter:
```
ADD DEFINE =GGS_LOGFILE_CLOSE_DELAY, CLASS MAP, FILE $xseconds
```
Where FILE is up to five digits for seconds and x can be any character a to z.

Examples

Example 1

This example changes the default subvolume used to store parameter files to $GGSPROD.

ADD DEFINE =GGS_PARAMS, CLASS DEFAULTS, VOLUME \PROD.$DATA3.GGSPROD

Example 2

This example changes the default subvolume used to store the report files.

ADD DEFINE =GGS_REPORT, CLASS DEFAULTS, VOLUME \PROD.$DATA3.NEWRPT

Example 3

This example changes the location of the audit configuration file.

ADD DEFINE =GGS_AUDCFG, CLASS MAP, FILE \NODE.$DATA1.GGS.AUDCFG

Example 4

This example identifies the subvolume where the default database is installed. This is not recommended because moving the database can cause problems when migrating to a new release of Oracle GoldenGate. If Extract, Replicat, or Syncfile are moved to a different subvolume it may be necessary to use the defines since they must know where to find checkpoint files.

ADD DEFINE =GGS_DB_SUBVOL, CLASS DEFAULTS, VOLUME, \PROD.$DATA6.GGS

Example 5

This example sets a delay of 240 seconds for Logger to wait before closing the old file when rolling to a new file.

ADD DEFINE =GGS_LOGFILE_CLOSE_DELAY, CLASS MAP, FILE $a240

Example 6

This example changes the default $ZTC0 TCPIP process name to $ZTC3.

ADD DEFINE =TCPIP^PROCESS^NAME, FILE $ZTC3

Note:

For more information on working with defines, see Changing Default Component Names.

2.4 ALLOCFILES

Valid for

Extract, Replicat

Description

Use ALLOCFILES to control the incremental number of memory structures allocated once the initial memory allocation specified by the NUMFILES parameter is reached (see "NUMFILES"). Together, these parameters control how process memory is allocated for storing information about the source and target tables being processed.

The default values should be sufficient for both NUMFILES and ALLOCFILES, because memory is allocated by the process as needed, system resources permitting.

ALLOCFILES must occur before any TABLE or MAP entries to have any effect.

Default

500

Syntax

ALLOCFILES num_structures

num_structures: The additional number of memory structures to be allocated. Do not set ALLOCFILES to an arbitrarily high number, or memory will be consumed unnecessarily. The memory structures of Oracle GoldenGate support up to two million tables.

Example

ALLOCFILES 1000

2.5 ALTFILERESOLVE | NOALTFILERESOLVE

Valid for

Extract

Description

Use ALTFILERESOLVE to resolve wildcards during the startup of Extract. As the wildcards are resolved, audited alternate key files are placed on the "exclude list" so no data will be sent for them. This avoids duplicate key errors that can otherwise occur when alternate key file I/O is encountered before primary file I/O. A message is produced for each wildcard entry as it is processed.

Unstructured files, SQL/MP tables, SQL/MX tables, and NSK standard subvolumes are ignored during the scan.

After startup, any file create or alter operation triggers Extract to evaluate the file for audited alternate key files to add to the exclude list.

To avoid the initial scan and its startup overhead, set NOALTFILERESOLVE. When this is set, alternate key files will be identified when the first primary file I/O is encountered.

Default

ALTFILERESOLVE

Syntax

ALTFILERESOLVE | NOALTFILERESOLVE

Example

The following is an example of the message produced during a wildcard scan at startup.

2010-02-16 08:10:58.161307 Scanning $*.A12GEN* for Alternate Key Files
2010-02-16 08:10:58.230067 Files scanned 16
2010-02-16 08:10:58.230788 Scanning $*.A12SQL* for Alternate Key Files
2010-02-16 08:10:58.289293 Files scanned 72

2.6 ALTINPUT

Valid for

Extract

Description

Use ALTINPUT for direct file extraction. With ACI files, multiple files can be in use at one time. For example, processing can continue on Monday's file after midnight, while Tuesday's file is opened for new data. To handle a multiple file situation, run more than one Extract process for the file sequence. Use the ALTINPUT RANGE option to distribute the files across the processes so that Extract never processes two files in sequence.

You can also use ALTINPUT to specify the access mode of the file open, and to move Extract to the next sequential file if an application has a file open that it is not updating.

To set up Extract for direct file extraction, specify the FILETYPE option in the GGSCI commands ADD or ALTER EXTRACT. When FILETYPE is specified, Extract uses a series of application files as the source of database changes rather than TMF audit trails or log trails. ALTINPUT sets up processing rules for the source files.

Syntax

ALTINPUT [RANGE (x OF y)]
[, SHARED | EXCLUSIVE | PROTECTED]
[, OPENTIMEOUT minutes]
[, TEMPLATE template]
[, USENEXTMODIFIED]
[, NOWAITNEXTMODIFIED]
[, FASTREADS]
[, WAITNEXTRBA num_bytes]
[, JTSOFFSET byte_offset]
[, TANDEMTSOFFSET byte_offset]
[, ONEFILE]

RANGE (x OF y)

Use RANGE to process multiple files within a sequence simultaneously. For information on specifying the RANGE option see "Specifying the ALTINPUT RANGE Option"

SHARED | EXCLUSIVE | PROTECTED

Specifies the access mode of the OPEN for the input file. Defaults to SHARED, in read-only mode.

OPENTIMEOUT minutes

Determines when it is safe to assume that there are no more updates to the input file.

If OPENTIMEOUT is not specified, Extract assumes there are no more updates five seconds after the last one is received.
OPENTIMEOUT minutes instructs Extract to wait for the specified number of minutes before assuming there are no more updates.

An application can have an open file that is not being updated, such as when a report program has opened a file in other than read-only mode.

TEMPLATE template

Specifies a file name template when FILETYPE is ENTRY that can be a wildcard.

The following example specifies files on any volume starting with $DATA, on the MYDAT subvolume, beginning with FL and ending in exactly three more characters.

TEMPLATE $DATA*.MYDAT.FL???

In GGSCI, the ADD EXTRACT or ADD REPLICAT command could specify that the first file to process would be $DATA5.MYDAT.FLABC.

NOWAITNEXTMODIFIED

By default, Extract waits until the next file in the sequence is modified before processing it. Use NOWAITNEXTMODIFIED to move to the next file regardless of when it was modified.

FASTREADS

Causes Extract to perform bulk reads of the source file set, boosting read performance.

WAITNEXTRA num_bytes

Causes Extract to wait until the next file in the sequence has accumulated a specified number of bytes.

JTSOFFSET byte_offset

Specifies the byte offset of a 64-bit Julian timestamp field within each record when specifying FILETYPE ENTRY. Various Oracle GoldenGate processes use the Julian timestamp to help determine replication lag. Use a timestamp field that reflects when the record was inserted into the database.

TANDEMTSOFFSET byte_offset

Specifies the byte offset of a 48-bit timestamp field within each record when specifying FILETYPE ENTRY. Various Oracle GoldenGate processes use the Julian timestamp to help determine replication lag. Use a timestamp field that reflects when the record was inserted into the database.

ONEFILE

Specify ONEFILE if FILETYPE ENTRY is used and the file set to process consists of a single file.

Specifying the ALTINPUT RANGE Option

ALTINPUT RANGE allows processing of multiple ACI BASE24 files within a sequence simultaneously. Since two TLF or PTLF files can be active at the same time, using ALTINPUT RANGE enables one Extract to process even Julian date files and the other Extract to process odd Julian date files. Even and odd Julian dates can be determined by computing a Julian date from the last six digits of each file name.

The "even" Extract process retrieves data from files where the remainder of the Julian date divided by 2 is zero (range 1 of 2). The "odd" Extract retrieves data from files where the remainder of the Julian date divided by 2 is 1 (range 2 of 2).

For example, an "odd" Extract instance processes files named PO990101, PO990103, PO990105 (Julian dates 2451181, 2451183, and 2451185, respectively). An "even" Extract instance processes files PO990102, PO990104, PO990106 (Julian dates 2451180, 2451182, and 2451184, respectively). This enables extraction for files PO990101 and PO990102 at the same time.

Note:

The RANGE option of ALTINPUT should not be confused with the RANGE argument of FILE and MAP or the function @RANGE that can be used within a FILTER. The application of each one is different.

2.7 ASSUMETARGETDEFS

Valid for

Replicat

Description

Use ASSUMETARGETDEFS when the source and target files have the same record or columns structure (for example, in hot site replication). This parameter is useful when source and target data definitions match and a definitions file is not available for the source database.

Use SOURCEDEFS to use the source data definitions.

Syntax

ASSUMETARGETDEFS

2.8 AUDITREPS | NOAUDITREPS

Valid for

Replicat

Description

Use AUDITREPS to determine if Replicat transactions are framed within TMF transactions. It is highly recommended that you use AUDITREPS to ensure the integrity of the target database.

Use NOAUDITREPS when the target files are not protected by TMF. If any target tables or files are audited, AUDITREPS is required.

Default

AUDITREPS

Syntax

AUDITREPS | NOAUDITREPS

2.9 AUDITRETRYDELAY

Valid for

Extract

Description

Use AUDITRETRYDELAY to control the amount of time Extract waits at the end of TMF audit trails before attempting to read more data. Setting AUDITRETRYDELAY to a higher value can save system resources, but can also result in longer lag time when replicating data.

Default

AUDITRETRYDELAY 1

Syntax

AUDITRETRYDELAY seconds | AUDITRETRYDELAYCSECS centiseconds

seconds: The number of seconds to wait before reading more data.
centiseconds: The number of centiseconds to wait before reading more data.

2.10 AUDSERVCACHEBLOCKS

Valid for

Extract

Description

Use AUDSERVCACHEBLOCKS to determine the amount of cache space reserved for SQL table definitions. This parameter affects the amount of memory reserved by Audserv for SQL table definitions. Cache blocks are useful for processing SQL update statements quickly. The default is sufficient for most installations.

Default

300

Syntax

AUDSERVCACHEBLOCKS cache

cache: The amount of cache space. The maximum recommended value is 1000. At a minimum, allocate one cache block per frequently accessed table partition.

2.11 AUDSERVCPU

Valid for

Extract

Description

Use AUDSERVCPU to start the audit reading process on a different CPU from Extract. For example, AUDSERVCPU 1 starts Audserv for the master audit trail and any auxiliary trails in CPU 1. AUDSERVCPUS 3, 5, 6 starts Audserv for the master trail in CPU 3, for AUX01 in CPU 5, and for AUX02 in CPU 6.

Using AUDSERVCPU results in the constant gathering of audit while Extract performs its own processing. This technique can reduce batch run times by up to 20%.

When TMF uses auxiliary TMF audit trails, AUDSERVCPU can specify different processors for each Audserv process. If you specify fewer CPU than the number of master and auxiliary TMF audit trails, the last CPU specified is used as the default.

When you specify IGNOREAUXTRAILS, you should still specify AUDSERVCPU with the CPU for the ignored auxiliary trail as a placeholder for any subsequently included auxiliary trails.

Default

The last CPU specified

Syntax

AUDSERVCPU[S] cpu_num [, cpu_num...]

cpu_num: The CPU identifier.

2.12 AUDSERVPARAM

Valid for

Extract

Description

Use AUDSERVPARAM to pass parameters that are specific to the Audserv process.

Note:

AUDSERVPARAM GETPURGEDATAS and IGNOREPURGEDATAS options are deprecated. Extract will instruct Audserv to return purge data operations if any file or wildcard in its parameter file has GETFILEOPS or GETPURGEDATAS.

Default

ABENDONSECURITYCHECK, IGNORENONDATACHANGES, IGNOREALTFILES, SQLCATCLOSEDELAY 60

Syntax

AUDSERVPARAM 
[NOABENDONSECURITYCHECK | ABENDONSECURITYCHECK]
[ARLIBERROR error_number, response]
[ARERRORREPORTINTERVAL seconds]
[GETNONDATACHANGES | IGNORENONDATACHANGES]
[GETALTFILES | IGNOREALTFILES]
[EXCLUDEFILECODES (file_code [, ...])
[SQLCATCLOSEDELAY seconds]

NOABENDONSECURITYCHECK | ABENDONSECURITYCHECK

NOABENDONSECURITYCHECK triggers Audserv to log a message, but not abend.

NOABENDONSECURITYCHECK is only applicable to Wild carded file entries. If a fully-qualified file name does not pass the security check, then Extract will abend instead of skipping the file. You need to do either of the following: correct the file and or safeguard security settings or remove the file from the Extract parameters.

With ABENDONSECURITYCHECK Audserv will log a message and then abend when the security check omits a file.

The default is ABENDONSECURITYCHECK.

ARLIBERROR error_number, response

Specifies the action to take when the error number is triggered. Valid response are:

IGNORE: Continue processing and do not issue a message.
WARN: Issue a warning message and continue processing.
ABEND: Issue an error message and end processing.

ARERRORREPORTINTERVAL

Specifies the number of seconds to wait before the reissue of a warning message.

GETNONDATACHANGES | IGNORENONDATACHANGES

Filters records for SQL partition moves and splits. The default is IGNORENONDATACHANGES. NOGETNONDATACHANGES is a synonym for IGNORENONDATACHANGES.

When using NOGETNONDATACHANGES, you cannot extract any data changes produced by the RDF subsystem.

GETALTFILES | IGNOREALTFILES

By default Audserv excludes Enscribe alternate keys. This means, when a file is added to Audserv's "include" list, it will search for any alternate keys and automatically exclude them.

If you are using wildcards in your files to denote alternate keys, you may wish to override this feature. There are two ways to override the default programming. If you wish to include alternate keys for specific files, you may specify the following syntax in your parameter file:

FILE $VOL.SUBVOL.PRIMARY;
FILE $VOL.SUBVOL.ALTFILE0;
FILE $VOL.SUBVOL.ALTFILE1;

where ALTFILE0 and ALTFILE1 represent alternate keys in the PRIMARY file.

If you wish to replicate all alternate keys, you can use the GETALTFILES option in your Extract parameter file as follows:

AUDSERVPARAM GETALTFILES

The default setting for this option is IGNOREGETALTFILES.

EXCLUDEFILECODES (file_code)

The numeric file code of a type of file whose audit is to be excluded.

SQL/MX and SQL/MP catalog files (file codes 563, 564, 565, 572, and 585) are automatically excluded and do not need to be listed.

SQLCATCLOSEDELAY seconds

Sets the time delay after which the SQL/MP catalog tables that have not been accessed are closed. The value must be between 10 and 3600 seconds.

The default is to close the catalog tables when they have not been accessed for 60 seconds.

2.13 AUDSERVPREFIX

Valid for

Extract

Description

Use AUDSERVPREFIX to tell Extract to assign its Audserv process a sequence of names with the same prefix. The names are processed in the same order as MAT, AUX01, AUX02, and so on.

Syntax

AUDSERVPREFIX prefix

prefix: A 3-character prefix, as in $GAX.

Example

Specifying:

AUDSERVPREFIX $GAX

would assign:

MAT = $GAX00
AUX01 = $GAX01
AUX02 = $GAX02

If you use AUDSERVPROCESS, you can not use AUDSERVPREFIX, and vice versa.

2.14 AUDSERVPROCESS

Valid for

Extract

Description

Use AUDSERVPROCESS to control the names assigned to Audserv processes. The names are processed in the same order as MAT, AUX01, AUX02, and so on.

Syntax

AUDSERVPROCESS name

name: Assign a $5-character name

Example

Specifying:

AUDSERVPROCESS $GGMAT, $GGX01, $GGX02

results in the following assignments:

MAT - $GGMAT
AUX01 - $GGX01
AUX02 - $GGX02

If you use AUDSERVPROCESS, you can not use AUDSERVPREFIX, and vice versa.

2.15 AUDSERVPROGRAM

Valid for

Extract

Description

Use AUDSERVPROGRAM to run both Native mode and TNS mode Audserv programs. AUDSERVPROGRAM overrides the default program file name Audserv with the program name of your choice.

Syntax

AUDSERVPROGRAM program_name

Example

The following example starts Audserv using the program EXTRACTN and with the name AUDSERVN.

GGSCI> ADD EXT FINANCE, BEGIN NOW, PROCESS, PROGRAM EXTRACTN, DESCRIPTION "NATIVE TMF EXTRACT"
GGSCI> ADD EXTTRAIL $DATA.GGSDAT.ET, EXTRACT FINANCE
EXTRACT FINANCE
AUDSERVPROGRAM $DATA.GGS.AUDSERVN
EXTTRAIL $DATA.GGSDAT.ET
FILE $PROD.ACCOUNT.*;

2.16 AUTORESTART

Valid for

Manager

Description

Use the AUTORESTART parameter to start one or more Extract and Replicat processes automatically after they fail. AUTORESTART provides fault tolerance when something temporary interferes with a process, such as intermittent network outages or programs that interrupt access to transaction logs.

You can use multiple AUTORESTART statements in the same parameter file.

Default

Do not auto-restart

Syntax

Syntax AUTORESTART process_type group_name
[, RETRIES max_retries]
[, WAITMINUTES wait_minutes]
[, RESETMINUTES reset_minutes]

process_type

Specify one of the following:

EXTRACT or EXT
REPLICAT or REP
ER (Extract and Replicat)
LOGGER
SYNCFILE or SYNC
COORD (Coordinator)

group name

A group name or wildcard specification for multiple groups. When wildcards are used, Oracle GoldenGate starts all groups of the specified process_type on the local system that satisfy the wildcard.

RETRIES max_retries

The maximum number of times that Manager should try to restart a process before aborting retry efforts.

If RETRIES is not set, MAXABENDRESTARTS is used. If neither is set, the default number of tries is 2.

WAITMINUTES wait_minutes

The amount of time to pause between discovering that a process has terminated abnormally and restarting the process. Use this option to delay restarting until a necessary resource becomes available or some other event occurs. The default delay is 1 minute.

RESETMINUTES reset_minutes

The window of time a restarted process must run without abending for the retries count to be reset to the maximum. If the process abends within this time, the maximum retries value is decremented. When it reaches zero, no more restarts are attempted.

For example, RETRIES is set to 2 and RESETMINUTES is 15. If process A is restarted and runs without abending for 15 minutes RETRIES will be reset to 2. If instead, process A abends in less than 15 minutes, RETRIES becomes 1. If it is restarted and abends again within 15 minutes, no more retries will be attempted.

If RETSETMINUTES is not set for AUTORESTART, RESTARTINERVAL is used. If neither option is set, the default is 20 minutes.

Example

In the following example, Manager tries to start all Extract processes three times after failure within a one hour time period, and waits five minutes before each attempt.

AUTORESTART EXTRACT *, RETRIES 3, WAITMINUTES 5, RESETMINUTES 60

2.17 AUTOSTART

Valid for

Manager

Description

The AUTOSTART parameter specifies the processes to be automatically started by Manager. When Manager starts up it scans the list and attempts to start any listed process that is not already running. To activate changes to the list, stop and restart the Manager process.

Syntax

AUTOSTART [group_type] {group_name | process_name}
      [, ALLPROCESSES]

group_type

The type of group to be started. This is an optional entry, but if used must be one of the following.

EXTRACT or EXT
REPLICAT or REP
ER (Extract and Replicat)
LOGGER
SYNCFILE or SYNC
COORD (Coordinator)

group_name

The group name. Required entry for group types other than Logger. Wildcards can be used for part or all of the name.

Note: TASK groups that match the wildcard will not be started. To start a TASK group either specify a group without a wildcard or use the ALLPROCESSES option.

process_name

The Logger process name in the format $xxnnn. Required entry for the LOGGER group_type. Wildcards can be used for all or part of the name.

ALLPROCESSES

Specifies that TASK groups should be included in wildcarded groups to be started.

Examples

Example 1

The following will start all Replicat processes that begin with R20.

AUTOSTART REPLICAT R20*

Example 2

The following will start all Extracts.

AUTOSTART EXT *

Example 3

The following will start the logger named $ABC01.

AUTOSTART LOGGER $ABC01

Example 4

The following will start all groups that begin with R20 except TASK groups.

AUTOSTART R20*

Example 5

The following will start all groups, including TASK groups, that begin with R20.

AUTOSTART R20*, ALLPROCESSES

2.18 BACKUPCPU

Valid for

Manager

Description

Use BACKUPCPU to specify a CPU that is running the backup Manager process.

Syntax

BACKUPCPU cpu_number

cpu_number: The identifier for the CPU that is running the backup Manager process.

2.19 BEGIN

Valid for

Extract, Replicat

Description

Use BEGIN to specify a date and time at which to start capturing data. Any record with a timestamp greater than or equal to the time specified by BEGIN that satisfies other criteria is extracted.

SPECIALRUN uses BEGIN to determine its start date and time.

Syntax

BEGIN date time[:seconds][.centiseconds]

date: The date in yyyy-mm-dd format.
time: The time in hh:mm format.
seconds: You can optionally specify seconds with the time option, as in hh:mm:ss.
centiseconds: You can optionally specify centiseconds seconds with the time and seconds options, as in hh:mm:ss.cccccc.

Examples

Example 1: BEGIN 2010-08-12 08:00 specifies a timestamp for August 12, 2010 at 8:00 AM.
Example 2: BEGIN 2010-08-12 08:00:30.000030 specifies a timestamp for August 12, 2010 at 8:00:30.000030 AM.

2.20 BULKIOLOAD | NOBULKIOLOAD

Valid for

Replicat

Description

Use BULKIOLOAD to enable bulk I/O, in 28K blocks, whenever writing unstructured data to structured or unstructured files. Typically, this occurs when replicating FUP LOAD or FUP DUP operations, and allows Replicat to process those types of operations many times faster than with conventional I/O.

BULKIOLOAD applies to all subsequent MAP entries. Use NOBULKIOLOAD to turn off BULKIOLOAD for subsequent MAP statements.

Default

NOBULKIOLOAD

Syntax

BULKIOLOAD | NOBULKIOLOAD

2.21 CHECKINTERVAL

Valid for

Syncfile

Description

Use CHECKINTERVAL to change the interval between the time a scheduled event occurs and the time that Syncfile duplicates an associated file. Once every minute, by default, Syncfile determines which of the scheduled events have occurred. When the event takes place, Syncfile duplicates the associated files.

Default

1 minute

Syntax

CHECKINTERVAL num_units unit;

num_units: The number of units of time.
unit: The time unit type. Specify one of: SECONDS, MINUTES or HOURS.

Example

CHECKINTERVAL 10 SECONDS;

2.22 CHECKMINUTES

Valid for

Manager

Description

Use CHECKMINUTES to determine how often Manager performs maintenance activities. If audit trails roll over frequently and the trails are actively managed, decreasing the frequency of maintenance activities can significantly affect performance.

Default

Syntax

CHECKMINUTES minutes

minutes: The frequency, in minutes, for performing maintenance.

Example

The following example specifies maintenance activities are performed every 20 minutes.

CHECKMINUTES 20

2.23 CHECKPARAMS

Valid for

Extract, Replicat

Description

Use CHECKPARAMS to verify parameter file contents before processing data. The program performs parameter checking, then quits before processing data.

Default

No parameter check

Syntax

CHECKPARAMS

2.24 COORDINATOR

Valid for

Coordinator, Replicat

COORDINATOR for Coordinator

Use COORDINATOR in the Coordinator parameter file to identify the name of the group.

Syntax

COORDINATOR group_name

group_name: The name of the group.

Example

COORDINATOR ACCTCO

COORDINATOR for Replicat

Use COORDINATOR in the Replicat parameter file to identify the name of the process that coordinates transactions distributed across multiple nodes in the network.

Syntax

COORDINATOR process_name
[MAXRETRIES number]
[DELAYSECS seconds | DELAYCSECS centiseconds]

process_name: The process name of the Coordinator group with which the Replicat will communicate to track distributed network transactions. The format for the default name is \node.$GGCnn with the node designator required.
MAXRETRIES number: The number of times Replicat will try to start the process before allowing the process to end abnormally. The default is 5.
DELAYSECS seconds | DELAYCSECS centiseconds: Sets the number of seconds or centiseconds that Replicat waits between tries. The default is 20 seconds.

Example

The following Replicat parameter specifies Coordinator group $GGC00 on the NY system.

REPLICAT REPNET
COORDINATOR \NY.$GGC00

2.25 DOWNINFO

Valid for

Manager

Description

Use DOWNINFO to classify a process that has terminated abnormally as informational in the report generated by DOWNREPORT. When events are sent to the event log, they are reported as informational if either a process terminates normally or the DOWNINFO parameter is specified.

Manager sends both normal and abnormal stops to the event log. To exclude processes that have stopped normally from being sent, use the IGNORESTOPPED option.

See the DOWNREPORT parameter "DOWNREPORT" for information on setting the frequency for sending information to the event log.

Default

Manager reports a process that terminates abnormally as informational, but does not report a normally terminated process as informational.

Syntax

DOWNINFO [IGNORESTOPPED]

IGNORESTOPPED: Specifies that Manager should only report processes that abended, and should not report processes terminated using the normal STOP command.

2.26 NOFILEAGING

Valid for

Extract, Replicat

Description

Deactivates the default of aging files from memory at two day intervals of no usage. See FILEAGEDAYS

Default

FILEAGEDAYS 2

Syntax

NOFILEAGING

2.27 REVERSEWINDOWSECS | REVERSEWINDOWCSECS

Valid for

Replicat

Description

In both TMF and non-TMF applications, an anomaly can occur in which an insert and subsequent update to the same record appear in reverse order in the log trail or extract trail. When processing such reversed data, Replicat processes the update first and this results in a "record not found" error. TMFEXCEPTIONS can be used to hold the update in anticipation of the insert. With TMF audit trails, Replicat will hold such transactions until the end of the TMF transaction. With non-TMF audit trails, however, there is no TMF transaction, so the number of seconds or centiseconds needs to be set using one of the REVERSEWINDOW parameters.

REVERSEWINDOW enables Replicat to hold the transactions for a specified number of seconds or centiseconds (the reverse window) without attempting to process them. If a subsequent insert is found within the reverse window, the insert is applied to the target file followed by the update and no error is recorded. If the reverse window expires without finding a matching insert, the process abends or discards the transaction depending on the selected option.

REVERSEWINDOWSECS or REVERSEWINDOWCSECS alone will not trigger Replicat to hold exception transactions. For this to work you must also:

Set TMFEXCEPTIONS on for that file.
Use NOAUDITREPS to ensure a non-audited target.

If both REVERSEWINDOW and TMFEXCEPTIONS are specified, but NOAUDITREPS is not, a message is generated that REVERSEWINDOWSECS is ignored. TMFEXCEPTIONS will still be applied.

Note:

REVERSEWINDOWSECS should only be used when the source is a non-TMF audited database. It should not be used when the source is a TMF audit trail.

Default

ABENDEXPIREDWINDOW

Syntax

{REVERSEWINDOWSECS seconds | REVERSEWINDOWCSECS cseconds}
[ABENDEXPIREDWINDOW | DISCARDEXPIREDWINDOW]

REVERSEWINDOWSECS seconds | REVERSEWINDOWCSECS cseconds

REVERSEWINDOWSECS seconds specifies the wait time in seconds. The range is 1 to 30 seconds and the recommended setting is 1.

REVERSEWINDOWCSECS cseconds specifies it in centiseconds. The range is 10 to 100 centiseconds and the recommended setting is 10.

ABENDEXPIREDWINDOW

Causes Replicat to abend at the expiration of the wait time.

Note:

Using this option will cause Replicat to checkpoint to the current position in the trail.

DISCARDEXPIREDWINDOW

Causes Replicat to discard the expired record and continue. This may be the preferred option if it is important to minimize Replicat downtime and file inconsistencies can be corrected at a later time.

2.28 SUPPRESSMISSINGMAPS|NOSUPPRESSMISSINGMAPS

Valid for

Extract

Description

Use SUPPRESSMISSINGMAPS to suppress the output of messages generated while colmaps are compiled and specific columns are not mapped.

Caution:

This should be only used after the Extract group has been fully validated. This is a method of reducing messages to the report file. Use this parameter with caution.

The parameter affects all map statements in the Extract group.

Syntax

SUPPRESSMISSINGMAPS

Default

NOSUPPRESSMISSINGMAPS

2.29 TABLESINCATALOG

Valid for

Extract

Description

The TablesInCatalog parameter retrieves the names of user tables that are registered in the specified catalog and builds file statements for them.

Syntax

TablesInCatalog <catalog name> [, VERBOSE ]


<catalog name>: <catalog name> is an SQL/MP catalog location as <$vol>.<subvol>
VERBOSE: VERBOSE lists the file statements names as they are created.

2.30 TCPIPSWITCHERRS

Valid for

Extract

Description

Use TCPIPSWITCHERRS to switch to alternate controllers and destination IP addresses when an error occurs. You can specify the number of retries to attempt before switching. The default is 5.

If you specify an alternate TCPIPPROCESSNAME and RMTHOSTALT, both the process and destination IP address are switched when the retry limit is reached.

Default

Syntax

TCPIPSWITCHERRS number_retries

number_retries: The number of retries.

Refer to "RMTHOSTALT" for an example using TCPIPSWTICHERRS.

2.31 TRACEALLOPENS

Valid for

Logger

Description

Use TRACEALLOPENS to record all open and close attempts on any file. This parameter instructs GGSLIB to send all open and close activity to Logger, including activity on files that are not on the extraction list.

Use the Logdump utility to examine these records and correlate them to Logger activity.

Default

Do not trace.

Syntax

TRACEALLOPENS

2.32 TRANSMEMVOLS

Valid for

Extract (Native mode only)

Description

Use this parameter to keep extracts memory allocation for uncommitted transaction data out of Kernel Managed Swap (KMSF) space. This directs extract allocate transmem space in temporary files on the volumes listed. The volumes listed are used in Round Robin order. Each extended segment will be 1G in size. There is a minor performance hit when a segment is allocated this way, the file has to be created and extents allocated.

Syntax

TransmemVols (  $vol  [ ,$vol ] )

2.33 VERSIONERR

Valid for

Extract

Description

Use VERSIONERR to specify error handling when database definitions are out-of-sync with audit trail records. Extract interprets data from the audit trails according to database definitions current at run-time. When a database definition changes during the course of an Extract run, data can be missed or misinterpreted.

For example, suppose a database column NEWCOL is added to table TAB1 while Extract is running. Any rows added to TAB1 after NEWCOL is added will contain a value for NEWCOL. However, since Extract is working with the old definition (before NEWCOL), NEWCOL values will be missed.

There are three situations to consider with respect to changing database definitions:

The record being processed is an old version of the record. For example, the record is missing one or more columns that have since been added to the table. By default Extract considers this a normal condition and processes the record (VERSIONERR OLD CONTINUE).
The record being processed is a new version of the record. More columns are present in the record than Extract expects. The danger here is that data can be missed. By default, Extract terminates abnormally in this situation (VERSIONERR NEW ABEND) and can be restarted to pick up the new table definition and any new columns as well. However, if the target application has no need to use the new column, this may be undesirable.
The record being processed is simply out of synchronization with the table definition according to Extract. The default response is to terminate abend (VERSIONERR OUTOFSYNC ABEND).

VERSIONERR lets you override these defaults by specifying custom responses to old, new and out-of-sync records.

Syntax

VERSIONERR type, {CONTINUE | WARN | DISCARD | ABEND}

type

The description of the record being processed. Valid values:

OLD
NEW
OUTOFSYNC

CONTINUE

Process the record as normal.

WARN

Process the record, but issue a warning to the error file.

DISCARD

Output the record to a discard file, but process more records.

ABEND

Terminate Extract abnormally. This option is appropriate when a new definition should be retrieved.

Example

VERSIONERR NEW, WARN

2.34 WARNRATE

Valid for

Replicat

Description

Use WARNRATE to set the rate at which SQL errors encountered are reported. For example, WARNRATE 1000 issues a warning for every 1000 errors for SQL errors encountered for a particular target table. If many SQL errors are expected, WARNRATE helps minimize the size of the report file and error log.

Default

100

Syntax

WARNRATE num_errors

num_errors: The error report rate.