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.
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 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. |
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 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 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 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 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 6 Manager Parameters: Error and Event Management
| Parameter | Description |
|---|---|
| CHECKTHRESHOLDMIN | Sets the frequency to check DISKTHRESHOLD percent. |
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. |
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 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 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 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. |
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. |
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 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 11 Extract parameters: Process Management
| Parameter | Description |
|---|---|
ALLOCFILES |
Controls the incremental number of memory structures allocated once the initial memory allocation of 500 has been exhausted. This parameter controls how process memory is allocated for storing information about the source and target tables being processed. |
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. |
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. |
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 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 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 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. |
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 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 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 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 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 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 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 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. |
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 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 23 Replicat Parameters: Process Management
| Parameter | Description |
|---|---|
ALLOCFILES |
Controls the incremental number of memory structures allocated once the initial memory allocation of 500 has been exhausted. This parameter controls how process memory is allocated for storing information about the source and target tables being processed. |
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. |
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. |
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 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 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 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 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 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 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. |
Coordinator Parameters Summary
Coordinator tracks distributed network transactions to coordinate updates on multiple nodes.
Table 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 |
Syncfile Parameters Summary
Syncfile lets you schedule and manage file duplication when you wish to copy files in their entirety.
Table 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. |